List vendor credits

Operation ID: vendorCredits

Group: Accounting › Vendor Credits

Open in the interactive reference

GET /accounting/vendor-credits

Read-only: Reads and returns; changes nothing.

Lists vendor credits, without their line items. To filter by vendor or legal entity, or to read line items, use POST accounting/vendor-credits/search.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.

Query surface

Response

200 Success

Under data, an array of vendorCreditsRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for the vendor credit.
vendorCreditNumber string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The vendor credit number. Absent until a number has been assigned.
referenceNumber string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The vendor's credit memo reference number, as printed on the vendor's document.
creditDate date | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date on the vendor's credit memo. Format YYYY-MM-DD.
currency string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The currency the credit is denominated in. Format ISO 4217, for example 'USD'.
status string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The application status, how much of the credit has been set against vendor bills. Values include 'unapplied', 'partiallyApplied' and 'applied'.
totalAmount decimal | null no no yes The total credit amount, in currency.
externalId string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) no The identifier this credit has in the upstream system that produced it. It is not unique.
vendorName string | null no no no The name of the vendor this credit is from.
entityName string | null no no no The name of the legal entity this credit is booked under.
lastModifiedDate date-time | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date and time the vendor credit last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. 
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "vendorCreditNumber": "<vendorCreditNumber>",
      "referenceNumber": "<referenceNumber>",
      "creditDate": "2026-01-15",
      "currency": "<currency>",
      "status": "<status>",
      "totalAmount": "19.99",
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "vendorName": "<vendorName>",
      "entityName": "<entityName>",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses