Credit Note PATCH API Documentation

Purpose

This endpoint update an existing credit note. A credit note is generated when an invoice is overpaid, and the excess amount can be either refunded or applied to another invoice. This API allows modifying certain attributes of a credit note such as its date or custom attributes while keeping the credit note active for further processing.

Use Case

The endpoint is used when a business needs to update key details of an existing credit note. For example, if the credit note issue date needs to be corrected, or if administrators want to add metadata such as custom attributes for internal tracking. This ensures that credit notes remain accurate and aligned with financial records before being used for refunds or applied against other invoices.

Path Parameters

Parameter	Type	Description
credit_note_id	string	The unique credit note ID to update.

Query Parameters

This endpoint does not support query parameters.

Request Body

The request body contains the credit_note object, which includes fields that are allowed to be updated. At minimum, you can update the credit note’s date. Additional fields such as refundable and custom attributes may be included depending on business requirements.

                JSON
              

                      {
    "credit_note": {
        "date": "2025-11-23"
        // "refundable": "true",
        // "custom_attributes": [
        //     {
        //         "name": "cus_attr_string",
        //         "value": "emni string 1122"
        //     }
        // ]
    }
}
 
                    

Attribute	Type	Description
credit_note	object	Main object containing credit note update details.
date	string (YYYY-MM-DD)	Date of the credit note to be updated.
refundable	string	Indicates if this credit note can be refunded (true/false).
custom_attributes	array	List of custom metadata fields.
name	string	Name of the custom field.
value	string	Value of the custom field.

Response

The response returns the fully updated credit note, including its status, amount, related invoice, remaining balance, refund eligibility, timestamps, versioning, and metadata. It confirms that the update was applied successfully and provides the final state of the credit note.

Response Body

                JSON
              

                      {
  "credit_note": {
    "status": "CREDIT_NOTE_STATUS",
    "id": "CREDIT_NOTE_ID",
    "date": "CREDIT_NOTE_DATE",
    "amount": "CREDIT_NOTE_AMOUNT",
    "invoice_id": "INVOICE_ID",
    "remaining_balance": "REMAINING_BALANCE",
    "refundable": "BOOLEAN",
    "payment_id": "PAYMENT_ID",
    "custom_attributes": "CUSTOM_ATTRIBUTES",
    "custom_objects": "CUSTOM_OBJECTS",
    "version": "CREDIT_NOTE_VERSION",
    "created_by": "CREATED_BY",
    "created_on": "CREATED_TIMESTAMP",
    "updated_by": "UPDATED_BY",
    "updated_on": "UPDATED_TIMESTAMP",
    "uuid": "CREDIT_NOTE_UUID",
    "account_id": "ACCOUNT_ID"
  }
}

                    

Attribute	Type	Description
credit_note	object	Root object containing credit note details.
status	string	Current status of the credit note (example: ACTIVE).
id	string	Unique credit note ID.
date	datetime	Updated credit note date in UTC.
amount	string	Total amount of the credit note.
invoice_id	string	Invoice associated with this credit note.
remaining_balance	string	Remaining unused balance.
refundable	string	Indicates if the credit note is refundable.
payment_id	string	Payment ID from which this credit originated.
custom_attributes	array	Custom metadata applied to the credit note.
custom_objects	array	Custom objects associated with the credit note.
version	string	Current version of the credit note after update.
created_by	string	User who originally created the credit note.
created_on	datetime	Creation timestamp.
updated_by	string	User who last updated the credit note.
updated_on	datetime	Last updated timestamp (UTC).
uuid	string	Unique UUID of the credit note.
account_id	string	Account ID associated with the credit note.