Skip to main content
PUT
/
v1
/
transactions
/
{original_transaction_id}
/
credit_notes
/
{credit_note_id}
Update Credit Note By Transaction Id
curl --request PUT \
  --url https://api.trykintsugi.com/v1/transactions/{original_transaction_id}/credit_notes/{credit_note_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <api-key>' \
  --data '
{
  "external_id": "<string>",
  "date": "2023-11-07T05:31:56Z",
  "status": "PENDING",
  "total_amount": 123,
  "currency": "AED",
  "transaction_items": [
    {
      "external_id": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "external_product_id": "<string>",
      "quantity": 123,
      "amount": 123,
      "description": "<string>",
      "tax_amount_imported": 123,
      "tax_rate_imported": 123,
      "taxable_amount": 123,
      "tax_exemption": "PRODUCT",
      "tax_items": []
    }
  ],
  "description": "<string>",
  "marketplace": false,
  "tax_amount_imported": 123,
  "tax_rate_imported": 123,
  "taxable_amount": 123,
  "addresses": [
    {
      "type": "BILL_TO",
      "phone": "<string>",
      "street_1": "<string>",
      "street_2": "<string>",
      "city": "<string>",
      "county": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "AF",
      "full_address": "<string>",
      "enriched_fields": "<string>",
      "status": "UNVERIFIED",
      "organization_id": "<string>"
    }
  ]
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required
​
x-organization-id
string
header
required

Path Parameters

​
original_transaction_id
string
required
​
credit_note_id
string
required

Body

application/json
​
external_id
string
required

Unique identifier for the credit note in the external system.

​
date
string<date-time>
required

Date when the credit note was issued or created.

​
status
enum<string>
required

Current state of the credit note in its lifecycle.

Available options:
PENDING,
CANCELLED,
COMMITTED
​
total_amount
number
required

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

​
currency
enum<string>
required

The currency used for all amounts in this credit note.

Available options:
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
​
transaction_items
CreditNoteItemCreateUpdate · object[]
required

Detailed list of individual items included in this credit note.

​
description
string

Brief explanation or reason for issuing the credit note.

​
marketplace
boolean
default:false

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

​
tax_amount_imported
number

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

​
tax_rate_imported
number

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

​
taxable_amount
number

Total portion of the credit note amount subject to taxation.

​
addresses
TransactionAddressBuilder · object[]

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

Response

Successful Response