API ReferenceContribution Reports

Retrieve a contribution report

Returns a contribution report object.

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

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_atstringOptionalformat: "date-time"

Date and time the report was finalized, if applicable

Errors