Retrieve credit note - Chargebee Partner docs

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

creditNoteId

string

required

The unique identifier of the credit note at the Tax Service Adapter or Tax Service Provider.

Query Parameters

invoiceId

string

The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider.

Response

200 - application/json

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.

creditNoteCode

string

required

The unique identifier of the credit note in Chargebee.

Maximum length: 50

creditNoteId

string

required

The unique identifier of the credit note at the Tax Service Provider or Tax Service Adapter.

creditNoteType

enum<string>

required

Whether the credit note was created for the full amount on the invoice or only for a part of the invoice amount.

Available options:

FULL,

PARTIAL

currency

string

required

The currency in the ISO-4217 format.

Required string length: 3

customer

object

required

The details of the Customer.

customer.address

object

required

Represents the address used for validation.

customer.customerCode

string

required

The unique identifier for the Customer in Chargebee.

Maximum length: 50

customer.hasNexus

boolean

Determines whether a tax nexus exists between the Seller and the tax authority at the address provided.

customer.locationEvidence

object

Represent the properties for customer location evidence.

customer.name

string

The name of the Customer in Chargebee.

Maximum length: 50

customer.taxIdentifiers

object[]

It represents the information related to the customer's tax identifiers. This includes details such as exemption status etc.

customer.taxRegistrationNumber

string

The tax registration number of a business in a country. For example, this is the GSTIN for India or the VAT number for EU or Australia.

Maximum length: 30

discountAmount

number

required

The total discount applied. This is the sum of all lineItems.discount.

documentDateTime

string

required

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.

exemptAmount

number

required

The amount exempted from tax.

lineItems

object[]

required

lineItems.amount

number

required

The amount for this line item. This is unitPrice × quantity.

lineItems.discountAmount

number

required

The discount applied to this line item.

lineItems.exemptAmount

number

required

The part of this line item's subtotal that is exempted from tax.

lineItems.isTaxable

boolean

required

Indicates whether this line item is taxable.

lineItems.isTaxInclusive

boolean

required

Indicates whether the subtotal for this line item is inclusive of taxes.

lineItems.number

integer

required

Index or serial number of the line item.

Required range: x > 1

lineItems.subtotal

number

required

The amount after discounts for this line item. This is amount - discountAmount.

lineItems.taxableAmount

number

required

The part of this line item's subtotal that is taxable.

lineItems.taxAmount

number

required

The tax payable for this line item. This is the sum of all taxes.taxAmount for this line item.

lineItems.taxes

object[]

required

List of taxes applied for this line item under each jurisdiction.

lineItems.total

number

required

The total for this line item after discounts and taxes. This is the same as subtotal if it is tax inclusive; otherwise it is subtotal + taxAmount. total can also be expressed as exemptAmount + taxableAmount + taxAmount.

lineItems.description

string

The description of the line item.

Maximum length: 250

lineItems.isPartialTax

boolean

Indicates if taxes were applied only partially for this line item.

lineItems.itemCode

string

The unique identifier (in Chargebee) of the product corresponding to the line item. If the line item corresponds to a one-off charge, then this identifier is not present.

Maximum length: 50

lineItems.quantity

number

The quantity associated with this line item.

Required range: x > 0

lineItems.taxExemptReason

string

The reason due to which a line item is exempted from tax. This is a mandatory parameter while applying tax exemption on any line-item.

Maximum length: 250

lineItems.taxExemptType

enum<string>

The tax exemption type for a line item. This is a mandatory parameter while applying tax exemption on any line-item.

Available options:

PRODUCT_EXEMPT,

CUSTOMER_EXEMPT,

REGION_EXEMPT,

REVERSE_CHARGE,

ZERO_RATE_TAX,

HIGH_VALUE_PHYSICAL_GOODS,

EXPORT,

ZERO_VALUE_ITEM,

TAX_NOT_CONFIGURED

lineItems.taxIdentifiers

object[]

The tax code fields of the product used for tax calculation.

lineItems.unitPrice

number

The unit price for this line item. In case of tiered pricing where the unit price varies for each quantity tier, this is the average unit price.

Required range: x > 0

seller

object

required

The details of the seller involved in the transaction including company code and address.

status

enum<string>

required

Status of the invoice document.

Available options:

PENDING,

COMMITTED,

VOIDED

taxableAmount

number

required

The amount upon which the tax is calculated.

taxAmount

number

required

The total tax payable. This is the sum of all lineItems.taxAmount.

total

number

required

The total amount of the credit note. total can be expressed as exemptAmount + taxableAmount + taxAmount.

invoiceCode

string

The unique identifier of the invoice in Chargebee to which this credit note belongs.

Maximum length: 50

invoiceId

string

The unique identifier of the invoice in the Tax Service Adapter or the Tax Service Provider.

roundingAmount

number

The rounding amount added to the total amount to account for fractional correction.

subtotal

number

The amount after discounts. This is the sum of all lineItems.subtotal.

taxDateTime

string

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.

API Reference

Authorizations

Path Parameters

Query Parameters

Response