hris
payslip

Retrieve a payslip

get/hris/{connection_id}/payslip/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Payslip

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)

user_idstring

the employee (reference to HrisEmployee)

company_idstring

(reference to HrisCompany)

payment_referencestring
payment_type'DIRECT' | 'CHEQUE' | 'CASH'
paid_atstring date-time

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

start_atstring date-time

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

end_atstring date-time

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

currencystring
gross_amountnumber
net_amountnumber
payroll_idstring

the hris_payroll (pay run) this payslip belongs to

group_idstring

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

type'REGULAR' | 'OFF_CYCLE' | 'BONUS' | 'CORRECTION' | 'TERMINATION' | 'CONTRACTOR'
hoursnumber

total hours paid on this payslip

employee_tax_amountnumber

total taxes withheld from the employee

employer_tax_amountnumber

total employer-paid taxes

deduction_amountnumber

total employee deductions (pre and post-tax)

employer_contribution_amountnumber

total employer benefit contributions

gross_ytd_amountnumber

year-to-date gross pay as of this payslip

net_ytd_amountnumber

year-to-date net pay as of this payslip

rawunknown

Changes

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