API ReferenceContribution Reports

Retrieve an employee breakdown

Returns the employee breakdown for a contribution report.

Path parameters

contribution_report_idstringRequiredformat: "ctr_.+"
employee_idstringRequiredformat: "ee_.+"

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK
employee_idstringformat: "ee_.+"
Unique identifier of the employee for which the breakdown is created
contribution_report_idstringformat: "ctr_.+"
Unique identifier of the related contribution report
employer_idstringformat: "er_.+"
Unique identifier of the employer for which the breakdown is created
periodobject
Period covered by the employee breakdown
currencyenum

The currency in which all the amounts in this breakdown are presented (e.g. eur)

statusenum
Current status of the breakdown
Allowed values:
created_atstringformat: "date-time"
Date and time the breakdown was created
last_updated_atstringformat: "date-time"
Date and time of the last update to the breakdown
health_insuranceobject
Health insurance contribution details
objectstring or null
The object type
external_customer_idstring or null

Unique identifier of the customer for which the breakdown is created. This identifier is assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This parameter is only available to EoR platforms.

finalized_atstring or nullformat: "date-time"
Date and time the breakdown was finalized, if applicable

Errors