Sign in

v1

latestOpenAPI 3.0.12026-07-141671231.8 MB
Exports

Create a General Ledger export

This endpoint allows you to create a General Ledger export. The generated export file is an xlsx file.

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

post/api/external/v2/exports/general_ledgers

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

status'pending' | 'ready' | 'error' required

The state of the export

created_atstring date-time required
updated_atstring date-time required

Example response

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