v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Accounts Receivable

Partial Update Credit Memo

    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

patch/coa/api/v1/credit-memo/{id}

Path parameters

idinteger required

Request body

idinteger

amount_remainingnumber double

Calculate amount remaining from database fields

entity_namestring

entity_currencystring

client_namestring

client_emailstring

contract_namestring

credit_account_numberstring

credit_account_namestring nullable

Combines account number and name in the format "number - name"

credit_memo_numberstring

migrated_journal_idinteger nullable

voided_datestring date

voided_journal_entry_orderstring

last_modified_atstring date-time

is_deletedboolean

deleted_atstring date-time nullable

chat_uuidstring uuid

search_vectorstring nullable

search_textstring nullable

credit_memo_type'credit_memo' | 'overpayment'

credit_memo - Credit Memo
overpayment - Overpayment

ref_numberstring nullable

credit_memo_datestring date

applied_datestring date nullable

message_on_credit_memostring nullable

currencystring

exchange_ratenumber double nullable

exchange_rate_booknumber double nullable

created_atstring date-time

last_sent_atstring date-time nullable

anrok_transaction_idstring nullable

ID of the negation transaction in Anrok for this credit memo

integration_idstring nullable

{"stackTrail":"components:schemas:PatchedAccountingCreditMemo:properties:integration_context","oasType":"schema","type":"unknown","nullable":true}

vat_numberstring nullable

total_amountnumber double

Sum of all line item amounts

amount_usednumber double

Sum of all non-voided payment amounts

chat_idinteger nullable

customerinteger

entityinteger

clientinteger nullable

credit_accountinteger nullable

journal_entryinteger nullable

contractinteger nullable

voided_journal_entryinteger nullable

anrok_connectioninteger nullable

avalara_connectioninteger nullable

sphere_connectioninteger nullable

Response

idinteger required

amount_remainingnumber double required

Calculate amount remaining from database fields

entity_namestring required

entity_currencystring required

client_namestring required

client_emailstring required

contract_namestring required

credit_account_numberstring required

credit_account_namestring nullable required

Combines account number and name in the format "number - name"

credit_memo_numberstring

migrated_journal_idinteger nullable

voided_datestring date required

voided_journal_entry_orderstring required

last_modified_atstring date-time required

is_deletedboolean required

deleted_atstring date-time nullable required

chat_uuidstring uuid

search_vectorstring nullable required

search_textstring nullable required

credit_memo_type'credit_memo' | 'overpayment'

credit_memo - Credit Memo
overpayment - Overpayment

ref_numberstring nullable

credit_memo_datestring date required

applied_datestring date nullable

message_on_credit_memostring nullable

currencystring

exchange_ratenumber double nullable

exchange_rate_booknumber double nullable

created_atstring date-time required

last_sent_atstring date-time nullable

anrok_transaction_idstring nullable

ID of the negation transaction in Anrok for this credit memo

integration_idstring nullable

{"stackTrail":"components:schemas:AccountingCreditMemo:properties:integration_context","oasType":"schema","type":"unknown","nullable":true}

vat_numberstring nullable

total_amountnumber double

Sum of all line item amounts

amount_usednumber double

Sum of all non-voided payment amounts

chat_idinteger nullable

customerinteger required

entityinteger required

clientinteger nullable

credit_accountinteger nullable

journal_entryinteger nullable

contractinteger nullable

voided_journal_entryinteger nullable

anrok_connectioninteger nullable

avalara_connectioninteger nullable

sphere_connectioninteger nullable