---
title: "Get list of vendor credits"
method: GET
path: "/v3/vendor-credits"
tags: ["vendor-credits"]
---

# Get list of vendor credits

`GET /v3/vendor-credits`

Get a list of vendor credit objects. By default, you get 20 results on one page of results. Set `max` in your request to get up to 100 results on one page.

See [Search operations with lists](https://developer.bill.com/docs/search-op-with-lists) in the Guides section for filtering, sorting, and pagination examples.

## Query parameters

- `max` integer, nullable — Maximum number of results
- `sort` string, nullable — Field name and sort order. Both simple and compound sorting is available. The format is `sort={field_01}:{sort_order},{field_02}:{sort_order}`. **NOTE**: Sorting occurs in the specified order.
- `filters` string, nullable — Field name, operator, and value. Both simple and compound filtering is available. The format is `filters={field_01}:{op}:{value},{field_02}:{op}:{value}`.
- `page` string, nullable — Next page of results. When a list has multiple pages, the `nextPage` and `prevPage` values in the response enable you to navigate between the pages of results. Set `page` as the `nextPage` or `prevPage` value for navigation.

## Headers

- `sessionId` string, nullable — API session ID generated with `/v3/login`
- `devKey` string, nullable — Developer key generated with your BILL developer account

## Response `200`

Get list of vendor credits response

- ListVendorCreditResponseDto — Response from a list API request with paging references.
  - `nextPage` string
  - `prevPage` string
  - `results` VendorCreditWithUsageResponseDto[]
    - `id` string — BILL-generated ID of the vendor credit. The value begins with `vcr`.
    - `vendorId` string — BILL-generated ID of the vendor. The value begins with `009`.
    - `referenceNumber` string — User-generated vendor credit number. This value can be in your chosen number scheme.
    - `creditDate` string, date — Vendor credit issued date. This value is in the `yyyy-MM-dd` format.
    - `description` string — Vendor credit description
    - `archived` boolean — Set as `true` if the vendor credit is archived
    - `applyToChartOfAccountId` string — BILL-generated ID of the chart of accounts used when the vendor credit is applied to a bill payment. The value begins with `0ca`.
    - `applyToBankAccountId` string — BILL-generated ID of the bank account used when the vendor credit is applied to a bill payment. The value begins with `bac`. **Note**: You can set only one of `applyToChartOfAccountId` or `applyToBankAccountId`.
    - `amount` number — Vendor credit amount
    - `appliedAmount` number — Vendor credit amount applied to invoices
    - `status` 'FULLY_APPLIED' | 'NOT_APPLIED' | 'PARTIALLY_APPLIED' | 'IN_PROCESS' | 'UNDEFINED' — Vendor credit status.
    - `createdTime` string, date-time — Vendor credit created time
    - `updatedTime` string, date-time — Vendor credit updated time
    - `vendorCreditLineItems` UpdateVendorCreditLineItemDto[] — Vendor credit line item information
      - `id` string, required — BILL-generated ID of the vendor credit line item. The value begins with `vci`.
      - `description` string — Vendor credit line item description
      - `amount` number — Vendor credit line item amount. For a vendor credit in an international currency (not USD), this value is in the local currency.
      - `classifications` object — General ledger classifications information for the vendor credit line item
        - `chartOfAccountId` string — BILL-generated ID of the chart of accounts. The value begins with `0ca`.
        - `accountingClassId` string — BILL-generated ID of the accounting class. The value begins with `cls`.
        - `departmentId` string — BILL-generated ID of the department. The value begins with `0de`.
        - `jobId` string — BILL-generated ID of the job. The value begins with `job`.
        - `locationId` string — BILL-generated ID of the location. The value begins with `loc`.
        - `itemId` string — BILL-generated ID of the item. The value begins with `0ii`.
        - `employeeId` string — BILL-generated ID of the employee. The value begins with `emp`.
        - `customerId` string — BILL-generated ID of the customer. The value begins with `0cu`.
    - `usage` VendorCreditUsageDto[] — Vendor credit usage information
      - `billId` string — BILL-generated ID of the bill to which the vendor credit is applied
      - `paymentId` string — BILL-generated ID of the payment to which the vendor credit is applied
      - `amount` number — Vendor credit amount applied

## Other responses

- `4XX` — List of errors.
- `5XX` — List of errors.

---

[API](https://skmtc.net/bill/apis/bill-v3-api.md) · [All operations](https://skmtc.net/bill/apis/bill-v3-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bill/bill-v3-api/revisions/0483350c434e/schema)