API ReferenceContribution Reports

Retrieve a contribution report

Returns a contribution report object.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

contribution_report_idstringRequiredformat: "ctr_.+"

Headers

X-Platform-IdstringOptional

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
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
created_atdatetime
Date and time the report was created
last_updated_atdatetime
Date and time of the last update to the report
aggregatesobject
Summary figures for the report, meant for dashboards and overviews. They keep changing while the report is open. For payroll processing or reconciliation use the employee breakdowns, which carry the itemised contributions.
objectstringOptionalRead-only
The object type
external_customer_idstring or nullOptional

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_atdatetime or nullOptional
Date and time the report was finalized, if applicable
file_idstring or nullOptionalformat: "file_.+"

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.

Errors

404
Not Found Error