# Vendor Credits

`GET /accounting/vendor-credits`

Group: Accounting › Vendor Credits · Operation ID: `vendorCredits`

Returns a list of vendor credits. Each entry is the credit header. Read one credit with its line items from GET accounting/vendor-credits/:id or POST accounting/vendor-credits/search.

[Open in the interactive reference](https://docs.api.lensing.ai/?op=vendorCredits)

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | `"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

- `id` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `vendorCreditNumber` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `referenceNumber` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `creditDate` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `currency` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `status` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `externalId` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- `lastModifiedDate` — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
- Orderable: id, vendorCreditNumber, referenceNumber, creditDate, currency, status, totalAmount, lastModifiedDate
- Selectable: id, vendorCreditNumber, referenceNumber, creditDate, currency, status, totalAmount, externalId, vendorName, entityName, lastModifiedDate

## Response

`200` Success

Under `data`, an array of vendorCreditsRow:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | no | The unique identifier for the vendor credit. |
| `vendorCreditNumber` | string or null | no | The vendor credit number. Absent until a number has been assigned. |
| `referenceNumber` | string or null | no | The vendor's credit memo reference number, as printed on the vendor's document. |
| `creditDate` | string (date) or null | no | The date on the vendor's credit memo. Format YYYY-MM-DD. |
| `currency` | string or null | no | The currency the credit is denominated in. Format ISO 4217, for example 'USD'. |
| `status` | string or null | no | The application status, how much of the credit has been set against vendor bills. Values include 'unapplied', 'partiallyApplied' and 'applied'. |
| `totalAmount` | string (decimal) or null | no | The total credit amount, in currency. |
| `externalId` | string or null | no | The identifier this credit has in the upstream system that produced it. It is not unique. |
| `vendorName` | string or null | no | The name of the vendor this credit is from. |
| `entityName` | string or null | no | The name of the legal entity this credit is booked under. |
| `lastModifiedDate` | string (date-time) or null | no | The date and time the vendor credit last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |

## Statuses

- `400` — Invalid request or business failure
- `401` — Missing or invalid access token
- `403` — Not authorized
- `404` — Not found
- `429` — Too many requests
- `500` — Internal server error