Sign in

v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Accounts Receivable

Update Credit Memo

    Performs a complete update of an existing accounting credit memo using PUT semantics.

    This endpoint allows full replacement of credit memo data including:
    - Complete credit memo metadata update (dates, amounts, client, entity, currency)
    - Full line item replacement with new products, accounts, amounts, and departmental allocations
    - Journal entry recalculation and update with new accounting transactions
    - Exchange rate updates for multi-currency credit memos
    - Contract and reference number association updates
    - Custom field updates and modifications

    **Important Notes:**
    - This is a full replacement operation - all credit memo data will be updated
    - Missing fields in the request will be set to null or default values
    - Existing line items will be completely replaced with the new line items
    - Journal entries will be updated to reflect all changes
put/coa/api/v1/credit-memo/{id}

Path parameters

idinteger required

Request body

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

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