Retrieve Invoice

Retrieve Invoice

curl --request GET \
  --url https://rest.taxes.provider.com/api/v1/invoices/{invoiceId} \
  --header 'Authorization: <api-key>'

{
  "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",
    "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"
      }
    ]
  }
}

GET

invoices

{invoiceId}

Retrieve Invoice

curl --request GET \
  --url https://rest.taxes.provider.com/api/v1/invoices/{invoiceId} \
  --header 'Authorization: <api-key>'

{
  "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",
    "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"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

The json of all the parameters specified in authentication configuration of tax app will be sent by Chargebee.

Headers

merchant_id

string

Merchant's domain name will be sent by Chargebee

trace_id

string

Unique id of the request will be sent by Chargebee

Path Parameters

invoiceId

string

required

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

Response

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 string length: 50

documentDateTime

string<date-time>

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.

Show child attributes

seller.address

object

required

Represents the address used for validation.

Show child attributes

seller.address.line1

string

First line of the street address

Maximum string length: 180

seller.address.line2

string

Second line of the street address

Maximum string length: 150

seller.address.line3

string

Third line of the street address

Maximum string length: 150

seller.address.city

string

The city of the address

Maximum string length: 50

seller.address.state

string

The state of the address following the ISO 3166-2 state/province code without the country prefix.

Maximum string length: 50

seller.address.postalCode

string

Postal Code / Zip Code of the address.

Maximum string length: 20

seller.address.country

string

The country of the address following the ISO 3166-1 alpha-2 standard.

Maximum string length: 2

Example:

{
  "country": "country",
  "city": "city",
  "postalCode": "postalCode",
  "state": "state",
  "line3": "line3",
  "line2": "line2",
  "line1": "line1"
}

seller.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 string length: 30

seller.hasNexus

boolean

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

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.

Show child attributes

customer.customerCode

string

required

The unique identifier for the Customer in Chargebee.

Maximum string length: 50

customer.address

object

required

Represents the address used for validation.

Show child attributes

customer.address.line1

string

First line of the street address

Maximum string length: 180

customer.address.line2

string

Second line of the street address

Maximum string length: 150

customer.address.line3

string

Third line of the street address

Maximum string length: 150

customer.address.city

string

The city of the address

Maximum string length: 50

customer.address.state

string

The state of the address following the ISO 3166-2 state/province code without the country prefix.

Maximum string length: 50

customer.address.postalCode

string

Postal Code / Zip Code of the address.

Maximum string length: 20

customer.address.country

string

The country of the address following the ISO 3166-1 alpha-2 standard.

Maximum string length: 2

Example:

{
  "country": "country",
  "city": "city",
  "postalCode": "postalCode",
  "state": "state",
  "line3": "line3",
  "line2": "line2",
  "line1": "line1"
}

customer.name

string

The name of the Customer in Chargebee.

Maximum string length: 50

customer.company

string

The company name of the customer

Maximum string length: 50

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 string length: 30

customer.taxIdentifiers

object[]

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

Maximum array length: 10

Show child attributes

customer.taxIdentifiers.id

string

required

The id of the field.

Maximum string length: 50

customer.taxIdentifiers.value

string

required

The value of the field.

Maximum string 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.

Show child attributes

customer.locationEvidence.ip

string

The customer's IP to determine which country the customer belongs to.

Maximum string length: 50

customer.locationEvidence.bin

string

The country associated with a card by using the first or last 6 digits of the Bank Identification Number.

Maximum string length: 15

customer.locationEvidence.paymentCountryCode

string

Identifies the country code associated with the payment method.

Maximum string length: 5

Example:

{
  "paymentCountryCode": "paymentCountryCode",
  "bin": "bin",
  "ip": "ip"
}

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" }
  ]
}

subtotal

number<double>

required

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

exemptAmount

number<double>

required

The part of the subtotal that is exempted from tax.

discountAmount

number<double>

required

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

taxableAmount

number<double>

required

The part of the subtotal that is taxable.

taxAmount

number<double>

required

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

total

number<double>

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

Required array length: 1 - 1250 elements

Show child attributes

lineItems.number

integer

required

Index or serial number of the line item.

Required range: x >= 1

lineItems.amount

number<double>

required

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

lineItems.subtotal

number<double>

required

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

lineItems.isTaxInclusive

boolean

required

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

lineItems.isTaxable

boolean

required

Indicates whether this line item is taxable.

lineItems.exemptAmount

number<double>

required

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

lineItems.discountAmount

number<double>

required

The discount applied to this line item.

lineItems.taxableAmount

number<double>

required

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

lineItems.taxAmount

number<double>

required

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

lineItems.total

number<double>

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

object[]

required

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

Maximum array length: 10

Show child attributes

lineItems.taxes.number

integer

required

Index or serial number of this tax line item.

Required range: x >= 1

lineItems.taxes.jurisdiction

object

required

The tax jurisdiction details.

Show child attributes

lineItems.taxes.jurisdiction.code

string

required

The jurisdiction code.

Maximum string length: 50

lineItems.taxes.jurisdiction.type

enum<string>

required

The type of tax jurisdiction.

Available options:

COUNTRY,

FEDERAL,

STATE,

COUNTY,

CITY,

SPECIAL,

OTHER

lineItems.taxes.jurisdiction.name

string

required

The jurisdiction name.

Maximum string length: 50

Example:

{
  "code": "code",
  "name": "name",
  "type": null
}

lineItems.taxes.name

string

required

The name of the tax applied.

Example:

"GST"

lineItems.taxes.rate

number<double>

required

The tax rate expressed in percentage.

Required range: x <= 100

lineItems.taxes.taxableAmount

number<double>

required

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

lineItems.taxes.taxAmount

number<double>

required

The tax payable for the line item under this jurisdiction.

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. If entity_type is adhoc, the itemCode parameter will be set to adhoc_charge.

Maximum string length: 50

lineItems.description

string

The description of the line item.

Maximum string length: 250

lineItems.quantity

number<double>

The quantity associated with this line item.

Required range: x >= 0

lineItems.unitPrice

number<double>

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

lineItems.taxIdentifiers

object[]

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

Maximum array length: 10

Show child attributes

lineItems.taxIdentifiers.id

string

required

The id of the field.

Maximum string length: 50

lineItems.taxIdentifiers.value

string

required

The value of the field.

Maximum string length: 50

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.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 string length: 250

Example:

"The customer is exempt from taxes."

lineItems.isPartialTax

boolean

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

taxDateTime

string<date-time>

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.

Create Invoice Commit Invoice

⌘I

Partner SPI

Tax SPI

Tax Registration Number Validation SPI

Troubleshooting

Authorizations

Headers

Path Parameters

Response