GET
/
invoices
/
{invoiceId}
curl --request GET \
  --url https://rest.taxes.provider.com/api/v1/invoices/{invoiceId} \
  --header 'Authorization: Bearer <token>'
{
  "seller": {
    "address": {
      "country": "country",
      "city": "city",
      "postalCode": "postalCode",
      "state": "state",
      "line3": "line3",
      "line2": "line2",
      "line1": "line1"
    },
    "taxRegistrationNumber": "taxRegistrationNumber",
    "hasNexus": true
  },
  "taxableAmount": 5.962133916683182,
  "discountAmount": 1.4658129805029452,
  "exemptAmount": 6.027456183070403,
  "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": 0.8008281904610115,
  "taxDateTime": "2000-01-23T04:56:07.000Z",
  "invoiceId": "invoiceId",
  "currency": "currency",
  "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",
    "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"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
invoiceId
string
required

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

Response

200
application/json
Invoice retrieved successfully.

The details of an invoice as returned by the Tax Service Adapter.

​
invoiceId
string
required

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

​
invoiceCode
string
required

The unique identifier of the invoice in Chargebee.

Maximum length: 50
​
documentDateTime
string
required

The date and time at which the invoice was generated 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
enum<string>
required

Status of the invoice document.

Available options:
PENDING,
COMMITTED,
VOIDED
​
currency
string
required

The currency in the ISO-4217 format.

Required string length: 3
​
seller
object
required

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

Example:
{
  "address": {
    "country": "country",
    "city": "city",
    "postalCode": "postalCode",
    "state": "state",
    "line3": "line3",
    "line2": "line2",
    "line1": "line1"
  },
  "taxRegistrationNumber": "taxRegistrationNumber",
  "hasNexus": true
}
​
customer
object
required

The details of the Customer.

Example:
{
  "address": {
    "country": "country",
    "city": "city",
    "postalCode": "postalCode",
    "state": "state",
    "line3": "line3",
    "line2": "line2",
    "line1": "line1"
  },
  "name": "name",
  "customerCode": "customerCode",
  "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" }
  ]
}
​
subtotal
number
required

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

​
exemptAmount
number
required

The part of the subtotal that is exempted from tax.

​
discountAmount
number
required

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

​
taxableAmount
number
required

The part of the subtotal that is taxable.

​
taxAmount
number
required

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

​
total
number
required

The total 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
object[]
required

The details of a line item.

​
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.