SureTax Returns API

GET EnrichedTaxItems

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

Fetch enriched tax items including reporting authority and detailed tax information based on filters such as reporting entity, company code, fiscal year, and date range.

OperationId: GET EnrichedTaxItems

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/EnrichedTaxItems

Query Parameters

Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.

Display String	Field Name	Field Type
External Reporting Entity*	externalReportingEntity	string
Selection From Date*	selectionFromDate	string
Selection To Date*	selectionToDate	string
Company Code	companyCode	string
Fiscal Year	fiscalYear	string
Tax Document Number List	taxDocumentNumberList	string
Limit	limit	string
Offset	offset	string

*Mandatory parameter

EnrichedTaxItemsParentResponse

OVERVIEWEXAMPLE

Overview

Parent response containing enriched tax items.

EnrichedTaxItemsParentResponse

Display Name	Field Name	Field Type
Data	data	array[EnrichedTaxItemsResponse]

EnrichedTaxItemsResponse

Display Name	Field Name	Field Type
Company Code	companyCode	string
Fiscal Year	fiscalYear	string
Tax Document Number	taxDocumentNumber	string
Item Number	itemNumber	string
Material Classification Group	materialClassificationGroup	string
Material Classification	materialClassification	string
Gross Amount	grossAmount	number
Currency	currency	string
Reporting Data	reportingData	array[ReportingData]

ReportingData

Display Name	Field Name	Field Type
Reporting Authority	reportingAuthority	string
Tax Jurisdiction Code	taxJurisdictionCode	string
Country	country	string
State	state	string
County	county	string
City	city	string
Taxing Details	taxingDetails	array[TaxingDetail]

TaxingDetail

Display Name	Field Name	Field Type
Authority Level	authorityLevel	string
Tax Authority	taxAuthority	string
Tax Name	taxName	string
Base Amount	baseAmount	number
Tax Rate	taxRate	number
Tax Amount	taxAmount	number
Exempt Amount	exemptAmount	number
Exempt Reason Code	exemptReasonCode	string
Exempt Reason	exemptReason	string

Example Response

The following is an example response you can expect for this operation

{
  "data": [
    {
      "companyCode": "US01",
      "fiscalYear": "2025",
      "taxDocumentNumber": "500000000001",
      "itemNumber": "00010",
      "materialClassificationGroup": "ELECTRONICS",
      "materialClassification": "LAPTOPS",
      "grossAmount": 1200.50,
      "currency": "USD",
      "reportingData": [
        {
          "reportingAuthority": "StateTaxBoard",
          "taxJurisdictionCode": "CA-SF",
          "country": "US",
          "state": "CA",
          "county": "San Francisco",
          "city": "San Francisco",
          "taxingDetails": [
            {
              "authorityLevel": "State",
              "taxAuthority": "California Department of Tax and Fee Administration",
              "taxName": "CA Sales Tax",
              "baseAmount": 1200.50,
              "taxRate": 0.075,
              "taxAmount": 90.04,
              "exemptAmount": 0.00,
              "exemptReasonCode": null,
              "exemptReason": null
            },
            {
              "authorityLevel": "Local",
              "taxAuthority": "San Francisco County",
              "taxName": "Local Sales Tax",
              "baseAmount": 1200.50,
              "taxRate": 0.025,
              "taxAmount": 30.01,
              "exemptAmount": 0.00,
              "exemptReasonCode": null,
              "exemptReason": null
            }
          ]
        }
      ]
    }
  ]
}

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
200	Success Response - 200 OK. Returns enriched tax data for the given input.
400	Bad Request - The server could not process the request due to invalid input or missing required parameters.
401	401 Unauthorized: The user's authentication is not valid.
500	Internal Server Error - An unexpected error occurred on the server while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/EnrichedTaxItems

Add Request Headers: