API Reference
- Partner SPI
- Tax SPI
- Overview
- Authorization
- Address
- TaxEstimate
- Invoice
- CreditNote
- Authentication
- Health
- Testing with Postman
- Tax Registration Number Validation SPI
- Troubleshooting
Invoice
Retrieve Invoice
This endpoint is used to retrieve an invoice for a given invoice id.
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
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.
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"
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.