List accounting documents

Authorization

Send one of these on every request. See Authentication for how to get credentials.

• API key

  Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

• Bearer token

Query parameters

• sort string

  Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

  Available directions: asc, desc.

  Available fields: companyEntityId, documentSequenceId, postingDate, valuationDate, documentDate, businessPartnerName, status, createdBy, createdAt, description, documentNumber, arDueDate, arOpenedAt, ctPerformedAt, ctStatus, ctAmount, ccAmount.

• filter string

  Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

  Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

  • For in and not_in operators, provide multiple values separated by the pipe character (|).

  Available fields: id, documentSequenceId, documentNumber, documentType, companyEntityId, ledgerName, businessPartnerName, businessPartnerId, status, currency, postingDate, documentDate, valuationDate, createdAt, updatedAt, createdBy, intercompanyDocumentId, apDueDate, apState, apVendorId, arContractId, arDueDate, arCustomerId, arInvoiceTemplateId, arPayeeBankAccountId, arOpenedAt, arState, ctCardId, ctCardBalanceAccountId, ctStatus, ctPerformedAt, cnToBeAdjustedAccDocType, intercompanyJournalEntryId, ycAccountingYearId, accountCode, accountLabel, taxCode.

• limit integer · int32

  Maximum number of items to return. Default is 50, maximum is 200.

• offset integer · int64deprecated

  Number of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead.

• cursor string

  The cursor position to start returning results from. To opt-in into cursor-based pagination, provide 0 for the initial request. For subsequent requests, use nextCursor and prevCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually.

Response

• records array of object

  List of records for the current page

  • id string · uuid

  • companyId string · uuid

  • companyEntityId string · uuid

  • documentSequenceId string

  • documentNumber string

  • documentType string

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of AP AR BP CC CN CT DE FX JE YC

  • status string

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of DRAFT APPROVAL_PENDING APPROVED POSTED PARTIALLY_CLEARED CLEARED ARCHIVED

  • description string

  • documentDate string · date

    The document's own date. This model carries no postingDate — for the date the document hit the ledger, read the ledger line via GET /v1/ledger-transaction-lines.

  • areLinesWithTax boolean

  • businessPartnerName string

  • businessPartnerId string · uuid

  • createdAt string · date-time

  • updatedAt string · date-time

  • totalTransactionAmount object

    • amount integer · int64

    • dcSign string

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of D C

  • totalTransactionAmountInMajors number

  • currency string

• hasMore boolean

  Boolean flag indicating if there are more records available

• total integer · int64deprecated

  Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination.

• nextCursor string

  Cursor for fetching the next page (only for cursor pagination)

• prevCursor string

  Cursor for fetching the previous page (only for cursor pagination)