Reporting API v2 - Invoice Taxes

Appxite

Introduction

This article describes how to use the Reporting API v2 endpoint for retrieving tax records associated with invoices. The endpoint provides access to granular tax breakdown data including jurisdiction details, authority information, tax rates, and raw tax provider data from integrated tax engines such as Avalara.

To view detailed documentation on the available endpoint, please visit the Postman collection here: Postman Collection v2

NOTE! Partners need to have the saskey in order to be able to execute the GET call mentioned in this document. In case you do not have the saskey or an existing saskey is not working, reach out to our Support Team at support@appxite.com and we will be happy to assist you. Find more details here: Reporting API v1/v2 - requesting access

In this article:

Requester Invoice-Taxes API

API Path:

GET ~/api/v2/reporting/requesters/{requesterId}/invoice-taxes

Query Parameters:

Parameter Type Description
invoiceConsolidationId GUID Optional
invoiceId GUID Optional
invoiceYear Integer Required if invoiceMonth is specified
invoiceMonth Integer Required if invoiceYear is specified
consumerId GUID Optional
taxLastCreatedDateFrom DateTime Required if invoiceYear and invoiceMonth are not specified
saskey String Required if not specified in Request Headers; access key

Response:

[
  {
    "invoiceDataTaxId": "guid",
    "invoiceConsolidationId": "guid",
    "consumerId": "guid",
    "invoiceId": "guid",
    "invoiceDataId": "guid",
    "adminZoneLevel": "string",
    "conditionType": "string",
    "taxAccount": "string",
    "taxCode": "string",
    "itemCode": "string",
    "taxAmount": decimal,
    "taxRate": decimal,
    "taxableBasis": decimal,
    "createdOnUtc": "datetime",
    "lastUpdatedOnUtc": "datetime",
    "jurisdictionCode": "string",
    "exemptAmount": decimal,
    "authorityType": "string",
    "authorityName": "string",
    "taxType": "string",
    "vatReg": "string",
    "taxProvider": "string",
    "rawData": { }
  }
]

Fields description

  • invoiceDataTaxId — unique identifier of the tax record
  • invoiceConsolidationId — identifier of the related invoice consolidation
  • consumerId — identifier of the customer associated with the invoice
  • invoiceId — identifier of the related invoice
  • invoiceDataId — identifier of the related invoice line item
  • taxAmount — the calculated tax amount
  • taxRate — the applicable tax rate
  • taxableBasis — the amount subject to tax
  • exemptAmount — the amount exempt from tax
  • jurisdictionCode — the tax jurisdiction name or code
  • authorityType — the type of tax authority (e.g., Use, Sales)
  • authorityName — the name of the tax authority
  • taxProvider — the tax engine used to calculate the tax (e.g., Avalara)
  • rawData — raw response data from the tax provider

Summary

This article describes how to retrieve invoice tax records via the Reporting API v2. The endpoint provides detailed tax breakdown data per invoice, enabling partners to support compliance reporting, financial analysis, and tax validation activities.

Was this article helpful?

0 out of 0 found this helpful

Add comment

Please sign in to leave a comment.