Light APIv1.0.0

API / Reference / Accounting Documents

List accounting documents

GET https://api.light.inc/v1/accounting-documents/accounting-documents

Returns a paginated list of accounting documents

Every posting-capable record in one list. documentType: AP vendor bill, AR customer invoice, BP bank payment, CC customer credit, CN vendor credit note, CT card transaction, DE accounting-release (amortisation or depreciation) entry, FX revaluation entry, JE journal entry, YC year-closing entry. status: DRAFT, APPROVAL_PENDING, APPROVED, POSTED, PARTIALLY_CLEARED and CLEARED (matched against payments or credits), ARCHIVED (a draft archived, or a posted document reversed). Drafts and archived documents are included unless filtered; default order is newest first.

Read totalTransactionAmount as the document's absolute total and ignore its dcSign: the sign is derived from a type-specific sum, so a journal entry's total shows C and a customer invoice's shows D. postingDate, valuationDate and ledgerName can be filtered and sorted on but are not in the response; for those and for lines, use GET /v1/ledger-transaction-lines filtered by accDocId. The document types and statuses are explained in How Light records money and Document lifecycle.

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, hasWithholding, taxCode.

    These fields accept only a subset of the operators: hasWithholding (eq, ne).

  • 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

      The document id, the same id its type-specific endpoints use.

    • companyId string · uuid

      Your company id.

    • companyEntityId string · uuid

      The entity the document belongs to; null on a draft bill that has no entity yet.

    • documentSequenceId string

      Light's document number, <TYPE>/<entity code>/<9 digits>; null until the document is first posted.

    • documentNumber string

      The external number: the vendor's invoice number on a bill, the invoice number on a sales invoice, the free-text reference on a journal entry.

    • 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

      The document header description.

    • 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

      Whether line amounts were entered gross of tax (true) or net (false).

    • businessPartnerName string

      The vendor or customer on the document, when it has one.

    • businessPartnerId string · uuid

      Id of that vendor or customer.

    • createdAt string · date-time

      When the document was created, as a draft.

    • updatedAt string · date-time

      The last change to the document, including metadata edits after posting.

    • totalTransactionAmount object

      Treat amount as the absolute document total. dcSign is derived from a type-specific sum, not the document's nature: a journal entry shows C, a customer invoice D.

      • amount integer · int64

        Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

      • dcSign string

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

        One of D C

    • totalTransactionAmountInMajors number

      totalTransactionAmount as a decimal, unsigned.

    • currency string

      The document's currency; null on a draft that has none yet.

  • 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)