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_id
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
OK
id
Unique identifier for the contribution report
employer_id
Unique identifier of the employer for which the report is created
period
Period covered by the contribution report
status
Current status of the contribution report
Allowed values:
created_at
Date and time the report was created
last_updated_at
Date and time of the last update to the report
object
The object type
external_customer_id
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_at
Date and time the report was finalized, if applicable