Exports

Create an Analytical General Ledger export

Changed on

This endpoint allows you to create an Analytical General Ledger export. The generated export file is an xlsx file, using the in-line analytical mode by default.

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

post/api/external/v2/exports/analytical_general_ledgers

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/exports/analytical_general_ledgers
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: exports:agl

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Request body

period_startstring date required

Start date of the period to export

period_endstring date required

End date of the period to export

mode'in_line' | 'in_column'

The mode of the export. The export can be in lines or in columns. If this parameter is not provided, it will use the default in_line mode.

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"
}

Changes