Sign in

v1

latestOpenAPI 3.0.02026-07-12414931.1 MB
Transactions

Update Credit Note By Transaction Id

Update an existing credit note for a specific transaction.

put/v1/transactions/{original_transaction_id}/credit_notes/{credit_note_id}

Path parameters

original_transaction_idstring required
credit_note_idstring required

Request body

external_idstring required

Unique identifier for the credit note in the external system.

datestring date-time required

Date when the credit note was issued or created.

status'PENDING' | 'CANCELLED' | 'COMMITTED' required

Current state of the credit note in its lifecycle.

descriptionstring

Brief explanation or reason for issuing the credit note.

total_amountnumber required

Total monetary value of the credit note, including all items and taxes.

marketplaceboolean

Indicates whether this credit note is associated with a marketplace transaction.

tax_amount_importednumber

Pre-calculated total tax amount for the entire credit note, if provided by the external system.

tax_rate_importednumber

Pre-calculated overall tax rate for the credit note, if provided by the external system.

taxable_amountnumber

Total portion of the credit note amount subject to taxation.

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD' required

Response

Successful Response

{"stackTrail":"paths:/v1/transactions/{original_transaction_id}/credit_notes/{credit_note_id}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}