KintsugiKintsugi
API reference / Update credit note by transaction id

Update credit note by transaction id

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

Update an existing credit note for a specific transaction.

Authorization

x-api-keystringRequired

Your secret API key. Include it with every request.

Path parameters

original_transaction_idstringRequired
credit_note_idstringRequired

Body

external_idstringRequired

Unique identifier for the credit note in the external system.

external_friendly_idstring

Human-readable identifier for the credit note, often used for display purposes.

secondary_external_idstring

Secondary external identifier, reserved for marketplace/channel source ids (paired with secondary_source).

datestringRequired

Date when the credit note was issued or created.

statusstringRequired

Current state of the credit note in its lifecycle.

Available options:PENDINGCANCELLEDCOMMITTED
descriptionstring

Brief explanation or reason for issuing the credit note.

total_amountnumber | stringRequired

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 | string

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

tax_rate_importednumber | string

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

taxable_amountnumber | string

Total portion of the credit note amount subject to taxation.

currencyCurrencyEnumRequired

The currency used for all amounts in this credit note.

Available options:AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBZDCADCDFCHFCLPCNYCOPCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGGPGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSIMPINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSPLSRDSTNSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTVDTWDTZSUAHUGXUSDUYUUZSVEFVNDVUVWSTXAFXCDXDRXOFXPFYERZARZMWZWD
addressesTransactionAddressBuilder[]

A list of TransactionAddressBuilder objects or None if no addresses are provided. This field represents the addresses associated with the transaction.

transaction_itemsCreditNoteItemCreateUpdate[]Required

Detailed list of individual items included in this credit note.

Response

200

Successful Response

422

Validation Error

cURL
PUT /v1/transactions/{original_transaction_id}/credit_notes/{credit_note_id}
-H "x-api-key: ***"
{ "external_id": "...",
"date": "...",
"status": "..." }
Example request
https://api.trykintsugi.com/v1/transactions/{original_transaction_id}/credit_notes/{credit_note_id}
Response
null