> ## Documentation Index > Fetch the complete documentation index at: https://docs.trykintsugi.com/llms.txt > Use this file to discover all available pages before exploring further. # Update Credit Note By Transaction Id > Update an existing credit note for a specific transaction. ## OpenAPI ````yaml put /v1/transactions/{original_transaction_id}/credit_notes/{credit_note_id} openapi: 3.0.0 info: title: Tax Platform version: 1.0.0 servers: - url: https://api.trykintsugi.com description: Production API server URL security: [] paths: /v1/transactions/{original_transaction_id}/credit_notes/{credit_note_id}: put: tags: - Transactions summary: Update Credit Note By Transaction Id description: Update an existing credit note for a specific transaction. operationId: PUT_update_credit_note_by_transaction_id parameters: - name: original_transaction_id in: path required: true schema: type: string title: Original Transaction Id - name: credit_note_id in: path required: true schema: type: string title: Credit Note Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreditNoteCreate' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] CustomHeader: [] components: schemas: CreditNoteCreate: properties: external_id: type: string title: External Id description: Unique identifier for the credit note in the external system. date: type: string format: date-time title: Date description: Date when the credit note was issued or created. status: type: string enum: - PENDING - CANCELLED - COMMITTED title: Status description: Current state of the credit note in its lifecycle. description: description: Brief explanation or reason for issuing the credit note. type: string total_amount: description: >- Total monetary value of the credit note, including all items and taxes. type: number marketplace: description: >- Indicates whether this credit note is associated with a marketplace transaction. default: false type: boolean tax_amount_imported: description: >- Pre-calculated total tax amount for the entire credit note, if provided by the external system. type: number tax_rate_imported: description: >- Pre-calculated overall tax rate for the credit note, if provided by the external system. type: number taxable_amount: description: Total portion of the credit note amount subject to taxation. type: number currency: $ref: '#/components/schemas/CurrencyEnum' description: The currency used for all amounts in this credit note. addresses: description: >- A list of TransactionAddressBuilder objects or None if no addresses are provided. This field represents the addresses associated with the transaction. type: array items: $ref: '#/components/schemas/TransactionAddressBuilder' transaction_items: items: $ref: '#/components/schemas/CreditNoteItemCreateUpdate' type: array title: Transaction Items description: Detailed list of individual items included in this credit note. type: object required: - external_id - date - status - total_amount - currency - transaction_items title: CreditNoteCreate HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CurrencyEnum: type: string enum: - 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 title: CurrencyEnum TransactionAddressBuilder: properties: phone: description: Phone number associated with the address. type: string street_1: description: Primary street address. type: string street_2: description: >- Additional street address details, such as an apartment or suite number. type: string city: description: City where the customer resides. type: string county: description: County or district of the customer. type: string state: description: State or province of the customer. type: string postal_code: description: ZIP or Postal code of the customer. type: string country: $ref: '#/components/schemas/CountryCodeEnum' description: Country code in ISO 3166-1 alpha-2 format full_address: description: >- Complete address string of the customer, which can be used as an alternative to individual fields. type: string type: $ref: '#/components/schemas/AddressType' description: 'Type of address. Allowed values: BILL_TO, SHIP_TO.' enriched_fields: description: Optional additional enriched data for the address. type: string status: $ref: '#/components/schemas/AddressStatus' description: >- Address verification status.** This field is ignored when updating addresses. The status of the address is updated automatically. ** default: UNVERIFIED organization_id: type: string type: object required: - type title: TransactionAddressBuilder CreditNoteItemCreateUpdate: properties: external_id: type: string title: External Id description: Unique identifier for the credit note item in the external system. date: type: string format: date-time title: Date description: Date when the credit note item was issued or created. description: description: Brief explanation or details about the credit note item. type: string external_product_id: type: string title: External Product Id description: Unique identifier for the associated product in the external system. quantity: description: Number of units or amount of the product being credited. type: number amount: description: Total monetary value of the credit note item before taxes. type: number tax_amount_imported: description: >- Pre-calculated tax amount for the item, if provided by the external system. type: number tax_rate_imported: description: >- Pre-calculated tax rate for the item, if provided by the external system. type: number taxable_amount: description: Portion of the item amount subject to taxation. type: number tax_exemption: $ref: '#/components/schemas/TaxExemptionEnum' description: Specific tax exemption status applied to this item, if any. tax_items: items: $ref: '#/components/schemas/TaxItemBuilder' type: array title: Tax Items description: >- Detailed breakdown of individual tax components applied to this item. default: [] type: object required: - external_id - date - external_product_id - quantity - amount title: CreditNoteItemCreateUpdate ValidationError: properties: loc: items: type: string type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError CountryCodeEnum: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CV - KH - CM - CA - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - CI - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MK - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - XK - ZZ_EU title: CountryCodeEnum AddressType: type: string enum: - BILL_TO - SHIP_TO - SHIP_FROM - BILL_FROM title: AddressType AddressStatus: type: string enum: - UNVERIFIED - INVALID - PARTIALLY_VERIFIED - VERIFIED - UNVERIFIABLE - BLANK title: AddressStatus TaxExemptionEnum: type: string enum: - PRODUCT - TRANSACTION - CUSTOMER - REGION - REVERSE_CHARGE - ZERO_RATE_TAX - HIGH_VALUE_PHYSICAL_GOODS - EXPORT - ZERO_VALUE_ITEM - NO_RULE_FOUND - IMPORTED - ZERO_RATE_NOT_EXEMPT title: TaxExemptionEnum description: This enum is used to determine if a transaction is exempt from tax. TaxItemBuilder: properties: rule_id: type: string title: Rule Id description: The rule ID of the tax item default: '0000' rate: type: number amount: type: number converted_amount: type: number currency: $ref: '#/components/schemas/CurrencyEnum' destination_currency: $ref: '#/components/schemas/CurrencyEnum' external_id: type: string name: type: string maxLength: 250 title: Name description: 'Deprecated: use `jurisdiction_type` instead' type: $ref: '#/components/schemas/TaxItemTypeEnum' maxLength: 50 default: IMPORTED jurisdiction_type: $ref: '#/components/schemas/JurisdictionType' jurisdiction_name: type: string organization_id: type: string type: object required: - rate - amount - name - organization_id title: TaxItemBuilder TaxItemTypeEnum: type: string enum: - IMPORTED_ORIGINAL - IMPORTED - CALCULATED title: TaxItemTypeEnum JurisdictionType: type: string enum: - COUNTRY - FEDERAL - STATE - COUNTY - CITY - SPECIAL - OTHER - HYBRID title: JurisdictionType securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-KEY CustomHeader: type: apiKey in: header name: x-organization-id ````