POST /invoices/{invoice-id}/remove_credit_note
Removes the specified adjustment credit or refundable credit allocation applied to the invoice.
Prerequisites & Constraints
- The invoice status must not be
voidedorpending. - The credit note status must not be
voided. - The credit note type must be
adjustmentorrefundable. - Refundable credit allocation cannot be removed if the amount allocated exceeds the refundable amount on the invoice. See Implementation Notes for more details.
Impacts
Invoice
- The
amount_dueincreases by theallocations[i].allocated_amountof the credit note. - The
amount_adjusteddecreases by theallocations[i].allocated_amountof the credit note if thecredit_note.typeisadjustment. - The
write_off_amountdecreases by theallocations[i].allocated_amountof the credit note if thecredit_note.create_reason_codeisWrite Off. - If the invoice status was
payment_due,not_paid, orposted, the status does not change after the credit note is removed. - If the invoice status was
paid:- The status changes to
postedif thedue_dateis in the future. - The status changes to
not_paidif the due date is in the past.
- The status changes to
Credit note
- The
amount_allocateddecreases and theamount_availableincreases by theallocations[i].allocated_amount, whereiis such thatallocations[i].invoice_id=invoice.id.
Implementation Notes
Before you call this API, make sure that:
- The invoice status is not
voidedorpending. - The credit note status is not
voided. - The credit note type is
adjustmentorrefundable. - For refundable credit notes, the amount allocated to the invoice via the credit note must not exceed the refundable amount on the invoice. The refundable amount on the invoice is calculated as: (total amount paid) + (total refundable credits allocated to the invoice) + (total tax withheld recorded on the invoice) - (total refundable credits issued against the invoice). Each of these amounts can be obtained as follows:
- amount allocated to the invoice via the credit note:
credit_note.allocations[i].allocated_amountwherecredit_note.allocations[i].invoice_id==invoice.id. - total amount paid:
invoice.amount_paid. - total refundable credits allocated to the invoice: sum of
invoice.applied_credits[i].applied_amount - total tax withheld recorded on the invoice: sum of
invoice.linked_taxes_withheld[i].amount - total refundable credits issued against the invoice: sum of
invoice.issued_credit_notes[i].cn_total
- amount allocated to the invoice via the credit note:
Servers
- {protocol}://{site}.{environment}:{port}/api/v2
- {protocol}://{site}-test.{environment}:{port}/api/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
invoice-id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
chargebee-request-origin-device |
String | No |
The device from which the customer has made the request |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
chargebee-event-webhook |
String | No |
skip only webhooks Valid values:
|
chargebee-business-entity-id |
String | No |
If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation. |
chargebee-event-actions |
String | No |
skip all actions to be done on the events Valid values:
|
chargebee-request-origin-user |
String | No |
The email address of your customer/user. Use this when the email address has only ASCII characters. |
chargebee-request-origin-ip |
String | No |
The IP address of the customer where the request originated |
chargebee-request-origin-user-encoded |
String | No |
The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored. |
chargebee-event-email |
String | No |
skip only emails Valid values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
credit_note |
Object | No |
Parameters for credit_note |
credit_note.id |
String | Yes |
Credit-note id. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.