Skip to main content
POST
/
trn
/
validate
/
batch
curl --request POST \
  --url https://rest.taxes.provider.com/api/v1/trn/validate/batch \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "trns": [
    {
      "trn": 40303265045,
      "country": {
        "code": "FR"
      }
    },
    {
      "trn": 50303265045,
      "country": {
        "code": "UK"
      }
    }
  ]
}
'
{
  "batchId": "qwerty12345",
  "batchName": "x-trn-batch",
  "status": "COMPLETED",
  "limit": 100,
  "offset": 0,
  "completionPercentage": 100,
  "trns": [
    {
      "trn": 40303265045,
      "trnStatus": "VALID",
      "country": {
        "name": "France",
        "code": "FR"
      }
    },
    {
      "trn": 50303265045,
      "trnStatus": "VALID",
      "country": {
        "name": "The united kingdom",
        "code": "UK"
      }
    }
  ]
}
{
  "errors": [
    {
      "message": "Tax registration number is missing.",
      "field": "trn",
      "helpUrl": "https://apidocs.chargebee.com#Authentication"
    }
  ]
}
{
  "message": "Unexpected error during processing the request."
}
{
  "status": "DOWN",
  "version": "1.0.0",
  "description": "The service is unhealthy. Several components are down.",
  "components": [
    {
      "id": "app-db-memory",
      "name": "Application Database Memory Usage",
      "type": "DATABASE",
      "status": "UP"
    },
    {
      "id": "adapter-server",
      "name": "Adapter API Server",
      "type": "ADAPTER",
      "status": "DOWN"
    },
    {
      "id": "service-server",
      "name": "API Server",
      "type": "API",
      "status": "DOWN"
    }
  ],
  "time": "2022-11-01T05:12:08.131Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Contains required properties for batch of tax registration numbers validation request

​
trns
object[]
required

List of tax registration numbers

​
batchName
string

Name of the batch

​
externalId
string

Way to relate the request for future reference. Hold the reference value passed in request, expecting the same would be returned in response.

Response

Request to validate the batch of tax registration numbers being processed.

Contains the required properties for batch of tax registration numbers validation response

​
batchId
string
required

Id of the batch request.

​
status
enum<string>
required

This field indicates current status of the request at server side.

Available options:
COMPLETED,
FAILED,
RUNNING,
CANCELED
​
limit
integer
required

Use for the pagination for batch request, limit indicates the maximum number of records to be returned in the response.

​
offset
integer
required

Use for the pagination for batch request, offset indicates the starting point of records to be returned in the response.

​
trns
object[]
required

List of tax registration numbers

​
batchName
string

Name of the batch request.

​
completionPercentage
integer

Percentage of batch request processing.

​
externalId
string

The externalId passed in request.