Sign in

v1

latestOpenAPI 3.0.12026-07-144840447.2 KB
Exports

Get FEC export

Retrieve the export of a FEC

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

get/api/external/firm/v1/companies/{company_id}/exports/fecs/{id}

Path parameters

company_idinteger required
Example:1

Existing company identifier (id)

idinteger required
Example:1

Existing export identifier (id)

Response

Returns the an export

idinteger required

ID of the export

file_urlstring nullable required

URL to download the export file. The URL will expire after 30 minutes.

statusstring required

State of the export

  • pending : The export is being generated
  • done : 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,
  "file_url": "https://app.pennylane.com/my_export.xlsx",
  "status": "pending",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}