---
title: "Partial Update Credit Memo"
method: PATCH
path: "/coa/api/v1/credit-memo/{id}"
tags: ["Accounts Receivable"]
---

# Partial Update Credit Memo

`PATCH /coa/api/v1/credit-memo/{id}`

Performs a partial update of an existing accounting credit memo using PATCH semantics.

        This endpoint allows selective modification of credit memo fields without requiring
        a complete credit memo replacement. You can update specific aspects of the credit memo while
        leaving other fields unchanged.

        **Updatable Fields:**
        - Credit memo metadata (dates, messages, descriptions, client, entity, currency)
        - Line items (amounts, accounts, descriptions, departments, products)
        - Reference numbers and contract associations
        - Exchange rates and currency information
        - Custom fields and additional metadata
        - Application status and tracking information

## Path parameters

- `id` integer, required

## Request body

- PatchedAccountingCreditMemo
  - `id` integer
  - `lines` AccountingCreditMemoLine[]
    - `id` integer, required
    - `credit_memo` integer
    - `account_number` string, required
    - `account_name` string, nullable, required — Combines account number and name in the format "number - name"
    - `product_name` string, required
    - `anrok_item_id` string, required
    - `department_name` string, required
    - `tags` object[], required
    - `tax_rate_name` string, required
    - `tax_rate_value` number, double, required
    - `description` string, nullable
    - `amount` number, double
    - `tax` number, double
    - `tax_description` string, nullable
    - `tag_ids` integer[]
    - `tag_group_ids` integer[]
    - `created_at` string, date-time, required
    - `last_modified_at` string, date-time, required
    - `customer` integer, required
    - `product` integer, nullable
    - `account` integer, required
    - `tax_rate` integer, nullable
    - `department` integer, nullable
  - `payments` AccountingCreditMemoPayment[]
    - `id` integer, required
    - `payment_journal_entry_order` string, required
    - `voided_journal_entry_order` string, nullable, required
    - `invoice` string, required
    - `currency` string
    - `amount` number, double
    - `payment_date` string, date, nullable
    - `created_at` string, date-time, required
    - `last_modified_at` string, date-time, required
    - `voided_date` string, date, nullable
    - `customer` integer, required
    - `credit_memo` integer, required
    - `payment_journal_entry` integer, required
    - `payment_transaction` integer, nullable
    - `voided_journal_entry` integer, nullable
  - `amount_remaining` number, double — Calculate amount remaining from database fields
  - `entity_name` string
  - `entity_currency` string
  - `client_name` string
  - `client_email` string
  - `contract_name` string
  - `credit_account_number` string
  - `credit_account_name` string, nullable — Combines account number and name in the format "number - name"
  - `attachments` File[]
    - `id` integer, required
    - `customer` integer, required
    - `created_at` string, date-time, required
    - `created_by` integer, nullable, required
    - `created_by_name` string, required
    - `created_by_email` string, required
    - `last_modified_at` string, date-time, required
    - `name` string, required
    - `url` string, required
    - `s3_content_type` string, nullable
    - `s3_content_length` integer, nullable
    - `s3_path` string, required
    - `object_id` integer, nullable
    - `app` string, required
    - `model` string, required
    - `is_deleted` boolean, required
    - `deleted_at` string, date-time, nullable, required
  - `credit_memo_number` string
  - `migrated_journal_id` integer, nullable
  - `voided_date` string, date
  - `voided_journal_entry_order` string
  - `last_modified_at` string, date-time
  - `is_deleted` boolean
  - `deleted_at` string, date-time, nullable
  - `chat_uuid` string, uuid
  - `search_vector` string, nullable
  - `search_text` string, nullable
  - `credit_memo_type` 'credit_memo' | 'overpayment' — * `credit_memo` - Credit Memo * `overpayment` - Overpayment
  - `ref_number` string, nullable
  - `credit_memo_date` string, date
  - `applied_date` string, date, nullable
  - `message_on_credit_memo` string, nullable
  - `application_status` union
    - 'open' | 'partially_used' | 'used' | 'voided' — * `open` - Open * `partially_used` - Partially Used * `used` - Used * `voided` - Voided
    - ''
    - unknown
  - `currency` string
  - `exchange_rate` number, double, nullable
  - `exchange_rate_book` number, double, nullable
  - `created_at` string, date-time
  - `last_sent_at` string, date-time, nullable
  - `anrok_transaction_id` string, nullable — ID of the negation transaction in Anrok for this credit memo
  - `integration_id` string, nullable
  - `integration_context` unknown
  - `vat_number` string, nullable
  - `total_amount` number, double — Sum of all line item amounts
  - `amount_used` number, double — Sum of all non-voided payment amounts
  - `chat_id` integer, nullable
  - `customer` integer
  - `entity` integer
  - `client` integer, nullable
  - `credit_account` integer, nullable
  - `journal_entry` integer, nullable
  - `contract` integer, nullable
  - `voided_journal_entry` integer, nullable
  - `anrok_connection` integer, nullable
  - `avalara_connection` integer, nullable
  - `sphere_connection` integer, nullable

## Response `200`

- AccountingCreditMemo
  - `id` integer, required
  - `lines` AccountingCreditMemoLine[], required
    - `id` integer, required
    - `credit_memo` integer
    - `account_number` string, required
    - `account_name` string, nullable, required — Combines account number and name in the format "number - name"
    - `product_name` string, required
    - `anrok_item_id` string, required
    - `department_name` string, required
    - `tags` object[], required
    - `tax_rate_name` string, required
    - `tax_rate_value` number, double, required
    - `description` string, nullable
    - `amount` number, double
    - `tax` number, double
    - `tax_description` string, nullable
    - `tag_ids` integer[]
    - `tag_group_ids` integer[]
    - `created_at` string, date-time, required
    - `last_modified_at` string, date-time, required
    - `customer` integer, required
    - `product` integer, nullable
    - `account` integer, required
    - `tax_rate` integer, nullable
    - `department` integer, nullable
  - `payments` AccountingCreditMemoPayment[], required
    - `id` integer, required
    - `payment_journal_entry_order` string, required
    - `voided_journal_entry_order` string, nullable, required
    - `invoice` string, required
    - `currency` string
    - `amount` number, double
    - `payment_date` string, date, nullable
    - `created_at` string, date-time, required
    - `last_modified_at` string, date-time, required
    - `voided_date` string, date, nullable
    - `customer` integer, required
    - `credit_memo` integer, required
    - `payment_journal_entry` integer, required
    - `payment_transaction` integer, nullable
    - `voided_journal_entry` integer, nullable
  - `amount_remaining` number, double, required — Calculate amount remaining from database fields
  - `entity_name` string, required
  - `entity_currency` string, required
  - `client_name` string, required
  - `client_email` string, required
  - `contract_name` string, required
  - `credit_account_number` string, required
  - `credit_account_name` string, nullable, required — Combines account number and name in the format "number - name"
  - `attachments` File[], required
    - `id` integer, required
    - `customer` integer, required
    - `created_at` string, date-time, required
    - `created_by` integer, nullable, required
    - `created_by_name` string, required
    - `created_by_email` string, required
    - `last_modified_at` string, date-time, required
    - `name` string, required
    - `url` string, required
    - `s3_content_type` string, nullable
    - `s3_content_length` integer, nullable
    - `s3_path` string, required
    - `object_id` integer, nullable
    - `app` string, required
    - `model` string, required
    - `is_deleted` boolean, required
    - `deleted_at` string, date-time, nullable, required
  - `credit_memo_number` string
  - `migrated_journal_id` integer, nullable
  - `voided_date` string, date, required
  - `voided_journal_entry_order` string, required
  - `last_modified_at` string, date-time, required
  - `is_deleted` boolean, required
  - `deleted_at` string, date-time, nullable, required
  - `chat_uuid` string, uuid
  - `search_vector` string, nullable, required
  - `search_text` string, nullable, required
  - `credit_memo_type` 'credit_memo' | 'overpayment' — * `credit_memo` - Credit Memo * `overpayment` - Overpayment
  - `ref_number` string, nullable
  - `credit_memo_date` string, date, required
  - `applied_date` string, date, nullable
  - `message_on_credit_memo` string, nullable
  - `application_status` union
    - 'open' | 'partially_used' | 'used' | 'voided' — * `open` - Open * `partially_used` - Partially Used * `used` - Used * `voided` - Voided
    - ''
    - unknown
  - `currency` string
  - `exchange_rate` number, double, nullable
  - `exchange_rate_book` number, double, nullable
  - `created_at` string, date-time, required
  - `last_sent_at` string, date-time, nullable
  - `anrok_transaction_id` string, nullable — ID of the negation transaction in Anrok for this credit memo
  - `integration_id` string, nullable
  - `integration_context` unknown
  - `vat_number` string, nullable
  - `total_amount` number, double — Sum of all line item amounts
  - `amount_used` number, double — Sum of all non-voided payment amounts
  - `chat_id` integer, nullable
  - `customer` integer, required
  - `entity` integer, required
  - `client` integer, nullable
  - `credit_account` integer, nullable
  - `journal_entry` integer, nullable
  - `contract` integer, nullable
  - `voided_journal_entry` integer, nullable
  - `anrok_connection` integer, nullable
  - `avalara_connection` integer, nullable
  - `sphere_connection` integer, nullable

---

[API](https://skmtc.net/campfire/apis/campfire-developer-apis.md) · [All operations](https://skmtc.net/campfire/apis/campfire-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/campfire/campfire-developer-apis/revisions/6945ebc3180e/schema)
