Sign in

v1

latestOpenAPI 3.0.12026-07-144840447.2 KB
Exports

Export a FEC

Initiate the export of a FEC

ℹ️ This endpoint requires the following scope: exports:fec

post/api/external/firm/v1/companies/{company_id}/exports/fecs

Path parameters

company_idinteger required
Example:1

Existing company identifier (id)

Request body

period_startstring date required

Start date of the period to export

period_endstring date required

End date of the period to export

Example request

{
  "period_start": "2023-08-30",
  "period_end": "2023-08-30"
}

Response

Returns the generated export status

idinteger required

ID of the export

statusstring required

State of the export

  • pending : The export is being generated
  • ready : The export is ready to be downloaded
  • error : An error occurred during the export generation
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": 124,
  "status": "pending",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}