---
title: "Get list of credit memos"
method: GET
path: "/v3/credit-memos"
tags: ["credit-memos"]
---

# Get list of credit memos

`GET /v3/credit-memos`

Get a list of credit memo 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 credit memos response

- ListCreditMemoResponseDto — Response from a list API request with paging references.
  - `nextPage` string
  - `prevPage` string
  - `results` CreditMemoWithUsageResponseDto[]
    - `id` string — BILL-generated ID of the credit memo. The value begins with `ccr`.
    - `customerId` string — BILL-generated ID of the customer. The value begins with `0cu`.
    - `referenceNumber` string — User-generated credit memo number. This value can be in your chosen number scheme.
    - `creditDate` string, date — Credit memo issued date. This value is in the `yyyy-MM-dd` format.
    - `description` string — Credit memo description
    - `archived` boolean — Set as `true` if the credit memo is archived
    - `salesTaxItemId` string — BILL-generated ID of the `SALES_TAX` item. The value begins with `0ii`. The tax rate is applied to all the credit memo line items set as taxable.
    - `payToChartOfAccountId` string — BILL-generated ID of the chart of accounts used when the credit memo is applied to an invoice payment. The value begins with `0ca`.
    - `payToBankAccountId` string — BILL-generated ID of the bank account used when the credit memo is applied to an invoice payment. The value begins with `bac`.
    - `amount` number — Credit memo amount
    - `appliedAmount` number — Credit memo amount applied to invoices
    - `salesTaxTotal` number — Credit memo sales tax amount. The value is set based on `salesTaxItemId`.
    - `salesTaxPercentage` number — Credit memo sales tax percentage. The value is set based on `salesTaxItemId`.
    - `status` 'FULLY_APPLIED' | 'NOT_APPLIED' | 'PARTIALLY_APPLIED' | 'IN_PROCESS' | 'UNDEFINED' — Credit memo status.
    - `createdTime` string, date-time — Credit memo created time
    - `updatedTime` string, date-time — Credit memo updated time
    - `creditMemoLineItems` CreditMemoLineItemResponseDto[] — Credit memo line item information
      - `id` string — BILL-generated ID of the credit memo line item. The value begins with `cci`.
      - `description` string — Credit memo line item description
      - `price` number — Credit memo line item unit price. For a credit memo in an international currency (not USD), this value is in the local currency.
      - `quantity` number — Credit memo line item unit quantity
      - `amount` number — Credit memo line item amount
      - `ratePercent` number — Credit memo line item rate percent
      - `taxable` boolean — Set as `true` if the credit memo line item is taxable
      - `classifications` object — General ledger classifications information for the credit memo 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`.
    - `classifications` object — General ledger classifications information for the credit memo
      - `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`.
    - `usage` CreditMemoUsageDto[] — Credit memo usage information
      - `invoiceId` string — BILL-generated ID of the invoice to which the credit memo is applied
      - `amount` number — Credit memo amount applied to the invoice

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