Skip to content

List accounting exports

The exports.list operation: GET /api/v1/exports in the REST API and the exports_list tool in the MCP server.

GET/api/v1/exports

Lists the legal entity's accounting exports in the mode of the request, newest first. Filter by status (one or several, comma-separated); paginate with limit (1–100, default 10) and starting_after.

At a glance

  • REST: GET /api/v1/exports
  • MCP tool: exports_list
  • Operation ID: exports.list
  • Scope: Legal entity
  • Permission: ledger:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Pagination: limit (at most 100) and starting_after
  • Authentication: API key with the ledger:read scope
  • Since: M8

Request

Query parameters

FieldTypeRequiredDescription
statusarray of one of queued, running, ready, expired, failedNo
limitinteger (1 to 100)No
starting_afterexp_… IDNoThe next_cursor of the previous page.

Response

200 OK with a JSON object, a page of the list (newest first):

FieldTypeDescription
object"list"
dataarray of object
data[].idexp_… ID
data[].object"data_export"
data[].livemodeboolean
data[].entityIdent_… ID
data[].kindone of accounting, organization
data[].statusone of queued, running, ready, expired, failedqueued, then running, then ready (files downloadable for 30 days, then expired) or failed.
data[].fromstringThe first day covered, in the entity's time zone.
data[].tostringThe last day covered (included).
data[].timeZonestring
data[].requestedByobject
data[].requestedBy.typestring
data[].requestedBy.idstring
data[].glMappingVersioninteger or nullThe general-ledger mapping used (0: none was set).
data[].filesarray of object
data[].files[].partone of journal, invoices, credit_notes
data[].files[].fileIdfile_… ID
data[].files[].filenamestring
data[].files[].contentTypestring
data[].files[].sizeinteger
data[].files[].sha256string
data[].files[].rowsintegerData rows (without the header).
data[].summaryobject or null
data[].failureobject or null
data[].readyAtdate-time or null
data[].expiresAtdate-time or null
data[].createdAtdate-time
data[].updatedAtdate-time
data[].versioninteger
has_moreboolean
next_cursorexp_… ID or null

Examples

The latest export

HTTP
GET /api/v1/exports?limit=1
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "object": "list",
  "data": [
    {
      "id": "exp_01m4tx5nj8emwbyf7y9vcf4aaa",
      "object": "data_export",
      "livemode": false,
      "entityId": "ent_01m4tx5nj8emwbyf7y9vcf47zm",
      "kind": "accounting",
      "status": "ready",
      "from": "2026-07-01",
      "to": "2026-09-30",
      "timeZone": "Europe/Zagreb",
      "requestedBy": {
        "type": "user",
        "id": "usr_01m4tx5nj8emwbyf7y9vcf47zk"
      },
      "glMappingVersion": 3,
      "files": [
        {
          "part": "journal",
          "fileId": "file_01m4tx5nj8emwbyf7y9vcf4aab",
          "filename": "acme-hr-journal-2026-07-01-to-2026-09-30.csv",
          "contentType": "text/csv; charset=utf-8",
          "size": 421888,
          "sha256": "9f2c1d5e7a3b4c6d8e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d",
          "rows": 412
        },
        {
          "part": "invoices",
          "fileId": "file_01m4tx5nj8emwbyf7y9vcf4aac",
          "filename": "acme-hr-invoice-register-2026-07-01-to-2026-09-30.csv",
          "contentType": "text/csv; charset=utf-8",
          "size": 98304,
          "sha256": "9f2c1d5e7a3b4c6d8e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d",
          "rows": 96
        },
        {
          "part": "credit_notes",
          "fileId": "file_01m4tx5nj8emwbyf7y9vcf4aad",
          "filename": "acme-hr-credit-note-register-2026-07-01-to-2026-09-30.csv",
          "contentType": "text/csv; charset=utf-8",
          "size": 3072,
          "sha256": "9f2c1d5e7a3b4c6d8e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d",
          "rows": 3
        }
      ],
      "summary": {
        "journal": {
          "transactions": 180,
          "rows": 412,
          "totals": [
            {
              "currency": "EUR",
              "debit": "48210000000",
              "credit": "48210000000"
            }
          ],
          "unmappedAccounts": [],
          "unmappedCount": 0
        },
        "invoices": {
          "count": 96,
          "totals": [
            {
              "currency": "EUR",
              "net": "18400000000",
              "tax": "4600000000",
              "gross": "23000000000",
              "count": 96
            }
          ]
        },
        "creditNotes": {
          "count": 3,
          "totals": [
            {
              "currency": "EUR",
              "net": "160000000",
              "tax": "40000000",
              "gross": "200000000",
              "count": 3
            }
          ]
        }
      },
      "failure": null,
      "readyAt": "2026-10-02T08:00:21.000Z",
      "expiresAt": "2026-11-01T08:00:21.000Z",
      "createdAt": "2026-10-02T08:00:00.000Z",
      "updatedAt": "2026-10-02T08:00:21.000Z",
      "version": 3
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

CodeHTTP statusWhenWhat to do
validation_failed400A filter or pagination value is invalid.Fix the fields listed in details.issues and send the request again.
scope_required400The request names no legal entity (an org key without Ownrecord-Entity, or a brand key: exports belong to the entity).Call the operation with credentials or a target at its level: an organization, a legal entity, a brand or the platform (details.required_scope).
permission_denied403You can't read this entity's ledger (ledger:read; brand-scoped members never see it).Ask an organization owner or admin for a role or scope that allows this action.
livemode_not_allowed403You have no live-mode access, so you can't use live exports.Use test mode, or credentials for the target's mode. Developers need live access granted by an organization owner or admin.

It can also return these common errors: api_version_unsupported, authentication_required, api_key_invalid, resource_not_found, dry_run_not_supported, rate_limited, internal_error.