---
title: "Archive a credit memo"
method: POST
path: "/v3/credit-memos/{creditMemoId}/archive"
tags: ["credit-memos"]
---

# Archive a credit memo

`POST /v3/credit-memos/{creditMemoId}/archive`

Archive an existing credit memo. In the response, the `archived` field is set as `true`.

You can restore an archived credit memo with
`POST /v3/credit-memos/{creditMemoId}/restore`. There is no change when you archive an archived credit memo.

## Path parameters

- `creditMemoId` string, required — BILL-generated ID of the credit memo. The value begins with `ccr`.

## Headers

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

## Response `200`

Archive a credit memo response

- CreditMemoResponseDto — CreditMemo response Dto.
  - `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`.

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