hris
payroll

Retrieve a payroll

get/hris/{connection_id}/payroll/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Payroll

Query parameters

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[]
rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.