PEpennylane
Exports

Retrieve a General Ledger export

Changed on

The endpoint returns a specific General Ledger export. The export file is an xlsx file.

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

get/api/external/v2/exports/general_ledgers/{id}

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/exports/general_ledgers/{id}
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: exports:gl

Path parameters

idinteger required
Example:1

Existing export identifier (id)

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.

Response

Returns the export

idinteger required

ID of the export

file_urlstring nullable required

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

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

The state of the export

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": 124,
  "file_url": "https://app.pennylane.com/my_export.xlsx",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}

Changes