Create credit note
This endpoint is used to send a credit note to the Tax Service Adapter. A credit note is used to reduce the amount due on an invoice. If the credit note is issued after payments have been made for the invoice, refunds can be issued to the Customer.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The details of a credit note sent to the Tax Service Adapter by Chargebee. A credit note is used to reduce the amount due on an invoice. If the credit note is issued after payments have been made for the invoice, refunds can be issued to the Customer.
The unique identifier of the credit note in Chargebee.
50
Whether the credit note was created for the full amount on the invoice or only for a part of the invoice amount.
FULL
, PARTIAL
The currency in the ISO-4217 format.
3
The details of the Customer.
The total discount applied. This is the sum of all lineItems.discount
.
The date and time at which the credit note was created in Chargebee. For example, if the value is 2022-10-28T15:36:28.129+05:30, then the timestamp represents October 28, 2022, at 15:36:28.129, with an offset of +05:30. This means that the time represented is 5 hours and 30 minutes ahead of UTC/GMT. In the case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC.
The amount exempted from tax.
The details of the seller involved in the transaction including company code and address.
The amount upon which the tax is calculated.
The total tax payable. This is the sum of all lineItems.taxAmount
.
The total amount of the credit note. total
can be expressed as exemptAmount
+ taxableAmount
+ taxAmount
.
The unique identifier of the invoice in Chargebee to which this credit note belongs.
50
The unique identifier of the invoice in the Tax Service Adapter or the Tax Service Provider.
The rounding amount added to the total amount to account for fractional correction.
The date and time at which the tax was applicable in Chargebee. For example, if the value is 2022-10-28T15:36:28.129+05:30, then the timestamp represents October 28, 2022, at 15:36:28.129, with an offset of +05:30. This means that the time represented is 5 hours and 30 minutes ahead of UTC/GMT.In the case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC.
Response
The details of a credit note returned by the Tax Service Adapter. A credit note is used to reduce the amount due on an invoice. If the credit note is issued after payments have been made for the invoice, refunds can be issued to the Customer.
The unique identifier of the credit note in Chargebee.
50
The unique identifier of the credit note at the Tax Service Provider or Tax Service Adapter.
Whether the credit note was created for the full amount on the invoice or only for a part of the invoice amount.
FULL
, PARTIAL
The currency in the ISO-4217 format.
3
The details of the Customer.
The total discount applied. This is the sum of all lineItems.discount
.
The date and time at which the credit note was created in Chargebee. For example, if the value is 2022-10-28T15:36:28.129+05:30, then the timestamp represents October 28, 2022, at 15:36:28.129, with an offset of +05:30. This means that the time represented is 5 hours and 30 minutes ahead of UTC/GMT. In the case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC.
The amount exempted from tax.
The details of the seller involved in the transaction including company code and address.
Status of the invoice document.
PENDING
, COMMITTED
, VOIDED
The amount upon which the tax is calculated.
The total tax payable. This is the sum of all lineItems.taxAmount
.
The total amount of the credit note. total
can be expressed as exemptAmount
+ taxableAmount
+ taxAmount
.
The unique identifier of the invoice in Chargebee to which this credit note belongs.
50
The unique identifier of the invoice in the Tax Service Adapter or the Tax Service Provider.
The rounding amount added to the total amount to account for fractional correction.
The amount after discounts. This is the sum of all lineItems.subtotal
.
The date and time at which the tax was applicable in Chargebee. For example, if the value is 2022-10-28T15:36:28.129+05:30, then the timestamp represents October 28, 2022, at 15:36:28.129, with an offset of +05:30. This means that the time represented is 5 hours and 30 minutes ahead of UTC/GMT.In the case of a merchant site located in UTC, these data types would send a timestamp in the format 2022-11-11T15:40:44.65Z. This timestamp represents November 11, 2022, at 15:40:44.65, with the 'Z' indicating that the time is in UTC.