List credit notes

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: amount, businessPartnerName, status, documentDate.

• 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: businessPartnerId, status, companyEntityId, documentDate, toBeAdjustedAccDocType, updatedAt.

• 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

    Unique identifier for the object

  • companyId string · uuid

    ID of the company

  • companyEntityId string · uuid

    ID of the entity

  • amount integer · int64

    Total credit note amount in cents

  • businessPartnerName string

    Name of the vendor

  • businessPartnerId string · uuid

    ID of the vendor

  • status string

    Status of the credit note

    ⚠️ 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

    Description of the credit note

  • currency string

  • postingDate string · date

    Date when the credit note should be posted to the ledger

  • documentDate string · date

    Date when the credit note was issued

  • valuationDate string · date

    Date used when applying foreign exchange rate

  • areLinesWithTax boolean

    Whether the credit note line amount is inclusive of tax or not. True means tax is already included in the line amount and will not be added on top, false means tax will be added on top of the line amount

  • lines array of object

    List of credit note line items

    • id string · uuid

      Unique identifier for the object

    • companyId string · uuid

      ID of the company

    • creditNoteId string · uuid

      ID of the credit note this line belongs to

    • grossTransactionAmount object

      • amount integer · int64

      • dcSign string

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

        One of D C

    • netTransactionAmount object

      • amount integer · int64

      • dcSign string

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

        One of D C

    • description string

      Description of the credit note line item

    • ledgerTaxId string · uuid

      ID of the tax code

    • taxTransactionAmount object

      • amount integer · int64

      • dcSign string

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

        One of D C

    • ledgerAccountId string · uuid

      ID of the ledger account

    • costCenterId string · uuid

      ID of the cost center

    • createdAt string · date-time

      Timestamp when the credit note line item was created

    • updatedAt string · date-time

      Timestamp when the credit note line item was last updated

    • accrualTemplateId string · uuid

      ID of the accrual template

    • accrualStartDate string · date

      Start date for accrual

    • accrualEndDate string · date

      End date for accrual

    • accrualDefaultDuration integer · int32

      Default duration for accrual in months

  • createdAt string · date-time

    Timestamp when the credit note was created

  • updatedAt string · date-time

    Timestamp when the credit note was last updated

  • updatedBy string · uuid

    ID of the user who last updated the credit note

  • localCurrencyFxRate number

    FX rate applied for the ledger's local currency

  • groupCurrencyFxRate number

    FX rate applied for the ledger's group currency

  • senderEmail string

    The email of the user who sent the document that this credit note was created from

  • documentName string

    The name of the document that this credit note was created from

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