---
title: "List credit memos"
method: GET
path: "/v3/credit-memos"
tags: ["Credit Memos"]
---

# List credit memos

`GET /v3/credit-memos`

## Query parameters

- `page` number, required
- `limit` number, required
- `filter` string

## Response `200`

Get all Credit Memos by filter

- object
  - `payload` object, required — Response payload, will be empty when success is false
    - `data` CreditMemoDto[]
      - `creditMemoId` string, required — Credit memo ID
      - `creditMemoNumber` string, required — Credit memo number
      - `creditMemoPrefix` string, required — Credit memo prefix
      - `customerId` string, required — Customer ID
      - `manufacturerId` string, required — Manufacturer ID
      - `issueDate` string, date-time, required — Issue date
      - `total` number, required — Total amount
      - `memo` string — Memo
      - `reason` string — Reason
      - `status` string, required — Status
      - `customer` CreditMemoCustomerDto, required
        - `id` string, required — Customer ID
        - `name` string, required — Customer name
        - `nameWithPrefix` string — Customer name with prefix
      - `items` CreditMemoLineItemDto[], required — Line items
        - `id` string, required — Line item ID
        - `name` string, required — Line item name
        - `note` string — Line item note
        - `quantity` number, required — Quantity
        - `amount` number, required — Amount
        - `salesTaxAmount` number, required — Sales tax amount
        - `item` CreditMemoItemDto
          - `id` string, required — Item ID
          - `name` string, required — Item name
          - `externalId` string — External ID
        - `erpClass` CreditMemoErpClassDto
          - `id` string, required — ERP Class ID
          - `name` string, required — ERP Class name
        - `contraRevenueScheduleId` string, required — Contra revenue schedule ID
      - `applications` CreditMemoApplicationDto[], required — Applications
        - `id` string, required — Application ID
        - `creditMemoId` string, required — Credit memo ID
        - `invoiceId` string, required — Invoice ID
        - `amountApplied` number, required — Amount applied
        - `invoiceNumber` string, required — Invoice number
        - `invoicePrefix` string, required — Invoice prefix
        - `appliedAt` string, date-time, required — Applied at
      - `externalIds` CreditMemoExternalIdDto[], required — External IDs
        - `externalId` string, required — External ID
        - `sourceType` string, required — Source type
      - `createdAt` string, date-time, required — Created at
      - `lastUpdatedAt` string, date-time, required — Last updated at
      - `syncStatus` string, required — Sync status
    - `limit` number
    - `totalItems` number
    - `currentPage` number
  - `success` boolean, required — Boolean with true=success, false=failure
  - `message` string, required — Plain-text description of the result
  - `error` IntegratorsApiError, required
    - `code` number, required — API response code
    - `message` string, required — API response message
    - `details` object — Additional details about the error

---

[API](https://skmtc.net/tabsplatform/apis/tabs-external-api.md) · [All operations](https://skmtc.net/tabsplatform/apis/tabs-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tabsplatform/tabs-external-api/revisions/7e8885517814/schema)