Retrieve credit note
curl --request GET \
--url https://rest.taxes.provider.com/api/v1/credit-notes/{creditNoteId} \
--header 'Authorization: <api-key>'{
"seller": {
"address": {
"country": "country",
"city": "city",
"postalCode": "postalCode",
"state": "state",
"line3": "line3",
"line2": "line2",
"line1": "line1"
},
"taxRegistrationNumber": "taxRegistrationNumber",
"hasNexus": true
},
"creditNoteType": null,
"taxableAmount": 5.962133916683182,
"roundingAmount": 7.061401241503109,
"creditNoteCode": "creditNoteCode",
"discountAmount": 0.8008281904610115,
"exemptAmount": 1.4658129805029452,
"invoiceCode": "invoiceCode",
"lineItems": [
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
},
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
},
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
},
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
},
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
}
],
"total": 2.3021358869347655,
"subtotal": 6.027456183070403,
"taxDateTime": "2000-01-23T04:56:07.000Z",
"invoiceId": "invoiceId",
"currency": "currency",
"creditNoteId": "creditNoteId",
"taxAmount": 5.637376656633329,
"documentDateTime": "2000-01-23T04:56:07.000Z",
"status": null,
"customer": {
"address": {
"country": "country",
"city": "city",
"postalCode": "postalCode",
"state": "state",
"line3": "line3",
"line2": "line2",
"line1": "line1"
},
"name": "name",
"customerCode": "customerCode",
"company": "company",
"taxRegistrationNumber": "taxRegistrationNumber",
"hasNexus": true,
"locationEvidence": {
"paymentCountryCode": "paymentCountryCode",
"bin": "bin",
"ip": "ip"
},
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
}
}{
"message": "Unexpected error during processing the request."
}{
"status": "DOWN",
"version": "1.0.0",
"description": "The service is unhealthy. Several components are down.",
"components": [
{
"id": "app-db-memory",
"name": "Application Database Memory Usage",
"type": "DATABASE",
"status": "UP"
},
{
"id": "adapter-server",
"name": "Adapter API Server",
"type": "ADAPTER",
"status": "DOWN"
},
{
"id": "service-server",
"name": "API Server",
"type": "API",
"status": "DOWN"
}
],
"time": "2022-11-01T05:12:08.131Z"
}CreditNote
Retrieve credit note
This endpoint is used to retrieve a specific credit note using the unique credit note id.
GET
/
credit-notes
/
{creditNoteId}
Retrieve credit note
curl --request GET \
--url https://rest.taxes.provider.com/api/v1/credit-notes/{creditNoteId} \
--header 'Authorization: <api-key>'{
"seller": {
"address": {
"country": "country",
"city": "city",
"postalCode": "postalCode",
"state": "state",
"line3": "line3",
"line2": "line2",
"line1": "line1"
},
"taxRegistrationNumber": "taxRegistrationNumber",
"hasNexus": true
},
"creditNoteType": null,
"taxableAmount": 5.962133916683182,
"roundingAmount": 7.061401241503109,
"creditNoteCode": "creditNoteCode",
"discountAmount": 0.8008281904610115,
"exemptAmount": 1.4658129805029452,
"invoiceCode": "invoiceCode",
"lineItems": [
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
},
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
},
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
},
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
},
{
"unitPrice": 0.3616076749251911,
"taxableAmount": 1.0246457001441578,
"amount": 2.027123023002322,
"quantity": 0.9301444243932576,
"itemCode": "itemCode",
"description": "description",
"isTaxable": true,
"discountAmount": 1.2315135367772556,
"taxes": [
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
},
{
"number": 1,
"taxableAmount": 4.965218492984954,
"rate": 11.730742509559434,
"jurisdiction": {
"code": "code",
"name": "name",
"type": null
},
"name": "GST",
"taxAmount": 5.025004791520295
}
],
"exemptAmount": 7.386281948385884,
"taxExemptType": null,
"number": 1,
"total": 6.84685269835264,
"subtotal": 4.145608029883936,
"isTaxInclusive": true,
"taxAmount": 1.4894159098541704,
"taxExemptReason": "The customer is exempt from taxes.",
"isPartialTax": true,
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
}
],
"total": 2.3021358869347655,
"subtotal": 6.027456183070403,
"taxDateTime": "2000-01-23T04:56:07.000Z",
"invoiceId": "invoiceId",
"currency": "currency",
"creditNoteId": "creditNoteId",
"taxAmount": 5.637376656633329,
"documentDateTime": "2000-01-23T04:56:07.000Z",
"status": null,
"customer": {
"address": {
"country": "country",
"city": "city",
"postalCode": "postalCode",
"state": "state",
"line3": "line3",
"line2": "line2",
"line1": "line1"
},
"name": "name",
"customerCode": "customerCode",
"company": "company",
"taxRegistrationNumber": "taxRegistrationNumber",
"hasNexus": true,
"locationEvidence": {
"paymentCountryCode": "paymentCountryCode",
"bin": "bin",
"ip": "ip"
},
"taxIdentifiers": [
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
},
{
"id": "id",
"value": "value"
}
]
}
}{
"message": "Unexpected error during processing the request."
}{
"status": "DOWN",
"version": "1.0.0",
"description": "The service is unhealthy. Several components are down.",
"components": [
{
"id": "app-db-memory",
"name": "Application Database Memory Usage",
"type": "DATABASE",
"status": "UP"
},
{
"id": "adapter-server",
"name": "Adapter API Server",
"type": "ADAPTER",
"status": "DOWN"
},
{
"id": "service-server",
"name": "API Server",
"type": "API",
"status": "DOWN"
}
],
"time": "2022-11-01T05:12:08.131Z"
}Authorizations
The json of all the parameters specified in authentication configuration of tax app will be sent by Chargebee.
Headers
Merchant's domain name will be sent by Chargebee
Unique id of the request will be sent by Chargebee
Path Parameters
The unique identifier of the credit note at the Tax Service Adapter or Tax Service Provider.
Query Parameters
The unique identifier of the invoice at the Tax Service Adapter or Tax Service Provider.
Response
Credit note retrieved successfully.
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 at the Tax Service Provider or Tax Service Adapter.
The unique identifier of the credit note in Chargebee.
Maximum string length:
50Whether 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 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.
Status of the invoice document.
Available options:
PENDING, COMMITTED, VOIDED The currency in the ISO-4217 format.
Required string length:
3The details of the seller involved in the transaction including company code and address.
Show child attributes
Show child attributes
Example:
{
"address": {
"country": "country",
"city": "city",
"postalCode": "postalCode",
"state": "state",
"line3": "line3",
"line2": "line2",
"line1": "line1"
},
"taxRegistrationNumber": "taxRegistrationNumber",
"hasNexus": true
}
The details of the Customer.
Show child attributes
Show child attributes
Example:
{
"address": {
"country": "country",
"city": "city",
"postalCode": "postalCode",
"state": "state",
"line3": "line3",
"line2": "line2",
"line1": "line1"
},
"name": "name",
"customerCode": "customerCode",
"company": "company",
"taxRegistrationNumber": "taxRegistrationNumber",
"hasNexus": true,
"locationEvidence": {
"paymentCountryCode": "paymentCountryCode",
"bin": "bin",
"ip": "ip"
},
"taxIdentifiers": [
{ "id": "id", "value": "value" },
{ "id": "id", "value": "value" },
{ "id": "id", "value": "value" },
{ "id": "id", "value": "value" },
{ "id": "id", "value": "value" }
]
}
The total discount applied. This is the sum of all lineItems.discount.
The amount exempted from tax.
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.
Required array length:
1 - 1250 elementsShow child attributes
Show child attributes
The unique identifier of the invoice in Chargebee to which this credit note belongs.
Maximum string length:
50The unique identifier of the invoice in the Tax Service Adapter or the Tax Service Provider.
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.
The amount after discounts. This is the sum of all lineItems.subtotal.
The rounding amount added to the total amount to account for fractional correction.