Sign in
Contribution 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.

post/contribution_reports/{contribution_report_id}/finalize

Path parameters

contribution_report_idstring required
Example:ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK

objectstring

The object type

idstring required

Unique identifier for the contribution report

employer_idstring required

Unique identifier of the employer for which the report is created

external_customer_idstring nullable

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.

status'open' | 'finalized' required
finalized_atstring date-time nullable

Date and time the report was finalized, if applicable

file_idstring nullable

Identifier of the report's downloadable CSV file. The file is prepared shortly after the report is finalized, so this is null while the report is open and for a short while after it is finalized — re-fetch the report until it appears. Exchange it for a download link via GET /files/{file_id}/download_link.

created_atstring date-time required

Date and time the report was created

last_updated_atstring date-time required

Date and time of the last update to the report

Example response

{
  "id": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "period": {
    "from_date": "2024-12-01",
    "to_date": "2024-12-01"
  },
  "finalized_at": "2024-12-01T00:00:00Z",
  "file_id": "file_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "created_at": "2024-12-01T00:00:00Z",
  "last_updated_at": "2024-12-01T00:00:00Z"
}

Changes

Changed in 2 of the 9 revisions of this API.2