v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Accounts Receivable

Create Credit Memo

    Creates a new accounting credit memo with line items and automatic journal entry generation.

    This endpoint allows for comprehensive credit memo creation with:
    - Multiple line items with different products, accounts, amounts, and departmental allocations
    - Automatic journal entry creation following double-entry bookkeeping principles
    - Multi-currency support with exchange rate handling
    - Client and entity relationship management
    - Contract associations for revenue recognition tracking
    - Product-based line item categorization with tax handling
    - Tag-based transaction categorization and reporting

post/coa/api/v1/credit-memo

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