Sign in
hris
payslip

List all payslips

get/hris/{connection_id}/payslip

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)

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
updated_atstring date-time
user_idstring
company_idstring
payment_referencestring
payment_type'DIRECT' | 'CHEQUE' | 'CASH'
paid_atstring date-time
start_atstring date-time
end_atstring date-time
currencystring
gross_amountnumber
net_amountnumber
rawobject

Changes

Changed in 1 of the 34 revisions of this API.2

  • 8f24376685672See the full diff
    • ○

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

      request-parameter-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added