hris
payroll

List all payrolls

Changed on
get/hris/{connection_id}/payroll

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/hris/{connection_id}/payroll
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

company_idstring

The company ID to filter by (reference to HrisCompany)

group_idstring

The group ID to filter by (reference to HrisGroup)

typestring
start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

company_idstring

(reference to HrisCompany)

group_idstring

the pay group (hris_group of type PAY_GROUP) (reference to HrisGroup)

status'DRAFT' | 'PENDING' | 'APPROVED' | 'PROCESSING' | 'PAID' | 'FAILED' | 'CANCELLED'
type'REGULAR' | 'OFF_CYCLE' | 'BONUS' | 'CORRECTION' | 'TERMINATION' | 'CONTRACTOR'
start_atstring date-time

pay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

pay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

paid_atstring date-time

pay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

approved_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

currencystring
gross_amountnumber
net_amountnumber
employee_tax_amountnumber
employer_tax_amountnumber
deduction_amountnumber

total employee deductions

employer_contribution_amountnumber

total employer benefit contributions

total_cost_amountnumber

total company cost/debit for this payroll

user_idsstring[]

employees paid in this payroll

payslip_idsstring[]
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status