Finalize a contribution report

POST
/contribution_reports/:contribution_report_id/finalize

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_idstringRequired

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
Allowed values: openfinalized

Current status of the contribution report

created_atdatetime

Date and time the report was created

last_updated_atdatetime

Date and time of the last update to the report

objectstringOptional

The object type

external_customer_idstringOptional

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_atdatetimeOptional

Date and time the report was finalized, if applicable

Built with