Open API: What data can be shared via Citation HR Software's Open API?

The Citation HR Software API Ecosystem allows secure, efficient data transfer between Citation HR and external platforms such as payroll, time & attendance, recruitment, and analytics software. Businesses can share critical HR data like employee personal details, contact information, payroll, and tax information, simplifying operations.

Key Benefits:

  • Seamless Integration: Connects Citation HR to external systems.
  • Automation: Minimises manual data entry.
  • Data Consistency: Ensures accurate, synchronised information.
  • Real-Time Access: Provides up-to-date HR data for decision-making.

For more information, check the API Documentation Portal and for the recent release updates API Change Log.

Note: The API documentation refers to enableHR. enableHR is a sister company to Citation HR and Citation HR Software is powered by enableHR technology.

 

Data That Can Be Shared:

Account Level Data

  • Accounts: List Branches and Retrieve details of a Branch
  • Accounts: List Reference Data: Genders
  • Accounts: List Reference Data: Honorifics
  • Accounts: List Reference Data: Employment Types
  • Accounts: List Reference Data: Employment Status

Employee Information

  • Employees: List all employees in the account
  • Employees: Retrieve details of an employee
  • Employees: Create & Update an employee
  • Employees: Terminate an employee
  • Employees: Transfer an employee (Move Everything)
  • Employees: List and Retrieve Note details

Payroll Information:

  • Payroll (AU): Retrieve & Maintain Tax Details to an employee record
  • Payroll (AU): Retrieve & Maintain Bank Accounts of an employee
  • Payroll (AU): Retrieve & Maintain leave balances of an employee
  • Payroll (AU): Retrieve & Maintain Superannuation details of an employee
  • Payroll (NZ): Retrieve & Maintain Tax Details of an employee
  • Payroll (NZ): Retrieve & Maintain Bank Accounts of an employee
  • Payroll (NZ): Retrieve & Maintain leave balances of an employee
  • Payroll (NZ): Retrieve & Maintain Kiwi Saver details of an employee

Training & Qualifications

  • Competencies: List all Account Competencies
  • Competencies: Retrieve details of a Competency
  • Competencies: Create and Maintain a Competency
  • Competencies: Assign a Competency to a Role
  • Competencies: List Competencies allocated to an Employee
  • Competencies: Allocate a Competency to an Employee
  • Competencies: Retrieve & Maintain Competency details of an Employee
  • Training Roles: List all Training Roles
  • Training Roles: Retrieve, Create and Maintain Training Role details
  • Training Roles: Assign/Unassign a Training Role to an Employee
  • Training Groups: List all Training Groups
  • Training Groups: Retrieve, Create and Maintain Training Group details

Candidate Information

  • Candidates: List candidate
  • Candidates: Add new candidate
  • Candidates: Retrieve & update Candidate Details
  • Candidates: Merge two candidate records
  • Candidates: Convert candidate to employee

For background on the meaning of an Open API and how it works, please see this article: Definitions: What is an API? What is an API Connector?

Related to