API ReferenceContribution Reports

Finalize a contribution report

This endpoint finalizes the contribution report object, making it immutable and preventing any further updates. Once finalized, its status changes to finalized, and it serves as a historical record for payroll reporting. Any changes or adjustments that occur after the finalization will roll into the next reporting period.

Path parameters

contribution_report_idstringRequiredformat: "ctr_.+"

Headers

AuthorizationstringRequired

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

Response

OK
idstringformat: "ctr_.+"
Unique identifier for the contribution report
employer_idstringformat: "er_.+"
Unique identifier of the employer for which the report is created
periodobject
Period covered by the contribution report
statusenum
Current status of the contribution report
Allowed values:
created_atstringformat: "date-time"
Date and time the report was created
last_updated_atstringformat: "date-time"
Date and time of the last update to the report
objectstring or null
The object type
external_customer_idstring or null

Unique identifier of the customer for which the report 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 report was finalized, if applicable

Errors