# Returns the vendor credit with the given identifier.

`GET /accounting/vendor-credits/{id}`

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

A vendor credit is a credit memo from a vendor, with one or more line items, that can be applied against that vendor's bills. It shares its read with POST accounting/vendor-credits/search, which returns the same record. The list at GET accounting/vendor-credits is header-only, so the line items come back here and on search.

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

## 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`. |
| `id` | path | string | yes | The unique identifier for the vendor credit to return. |

## Response

`200` Success

Under `data` (getVendorCreditOutput):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes | The unique identifier for the vendor credit. |
| `vendorCreditNumber` | string | no | The vendor credit number. Absent until a number has been assigned. |
| `referenceNumber` | string | yes | The vendor's credit memo reference number, as printed on the vendor's document. |
| `creditDate` | string (date) | yes | The date on the vendor's credit memo. Format YYYY-MM-DD. |
| `currency` | string | yes | The currency the credit is denominated in. Format ISO 4217, for example 'USD'. Governs totalAmount and every line amount. |
| `status` | string | no | The application status, how much of the credit has been set against vendor bills. Values include 'unapplied', 'partiallyApplied' and 'applied'. |
| `totalAmount` | string (decimal) | no | The total credit amount, in currency. |
| `externalId` | string | no | The identifier this credit has in the upstream system that produced it. It is not unique. |
| `vendorId` | string | no | The vendor this credit is from. See id on GET accounting/vendors/:id. |
| `vendorName` | string | no | The name of the vendor this credit is from. |
| `entityId` | string | no | The legal entity this credit is booked under. See id on GET base/entities. |
| `entityName` | string | no | The name of the legal entity this credit is booked under. |
| `lastModifiedDate` | string (date-time) | yes | The date and time the vendor credit last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
| `origin` | string | no | The source system this record came from, as free-form text. Absent when none was supplied. |
| `lines` | array of object | no | The credit line items, in their order on the credit. An empty array when the credit has none. |
| `lines[].id` | string | yes | The unique identifier for the line item. |
| `lines[].lineNumber` | string | no | The line item number. |
| `lines[].description` | string | no | A description of the credit line item. |
| `lines[].lineType` | string | no | The type of line item. Possible values: 'expense', 'prepaid'. |
| `lines[].amount` | string (decimal) | no | The line credit amount, in the credit currency. |
| `lines[].currency` | string | no | The currency for the line. It always matches the credit currency. Format ISO 4217, for example 'USD'. |
| `lines[].netAmount` | string (decimal) | no | The line amount excluding VAT, in the credit currency. |
| `lines[].vatAmount` | string (decimal) | no | The computed VAT amount on the line, in the credit currency. |
| `lines[].vatPercentage` | string (decimal) | no | The VAT rate applied, as a percentage. 19 means 19%, not 0.19. |
| `lines[].accountId` | string | no | The GL account this line credits. See id on GET accounting/accounts/:id. |
| `lines[].departmentId` | string | no | The department this line is allocated to. See id on GET departments/:id. |

## Errors

| Code | Status |
| --- | --- |
| `NOT_FOUND` | 400 |

## Statuses

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