Skip to content

LIAPIGeoTaxServiceApi.md

Latest commit

 

History

History
586 lines (432 loc) · 21.2 KB

LIAPIGeoTaxServiceApi.md

File metadata and controls

586 lines (432 loc) · 21.2 KB

LIAPIGeoTaxServiceApi

All URIs are relative to https://api.pitneybowes.com/location-intelligence

Method HTTP request Description
getBatchTaxByAddress POST /geotax/v1/tax/{taxRateTypeId}/byaddress Post Tax By Address
getBatchTaxByLocation POST /geotax/v1/tax/{taxRateTypeId}/bylocation Post Tax By Location
getBatchTaxRateByAddress POST /geotax/v1/taxrate/{taxRateTypeId}/byaddress Post Taxrate By Address
getBatchTaxRateByLocation POST /geotax/v1/taxrate/{taxRateTypeId}/bylocation Post Taxrate By Location
getIPDTaxByAddress GET /geotax/v1/taxdistrict/ipd/byaddress Get IPD Tax by Address
getIPDTaxByAddressBatch POST /geotax/v1/taxdistrict/ipd/byaddress Get IPD Tax for batch requests
getSpecificTaxByAddress GET /geotax/v1/tax/{taxRateTypeId}/byaddress Get Tax By Address
getSpecificTaxByLocation GET /geotax/v1/tax/{taxRateTypeId}/bylocation Get Tax By Location
getSpecificTaxRateByAddress GET /geotax/v1/taxrate/{taxRateTypeId}/byaddress Get Taxrate By Address
getSpecificTaxRateByLocation GET /geotax/v1/taxrate/{taxRateTypeId}/bylocation Get Taxrate By Location

getBatchTaxByAddress

TaxResponses getBatchTaxByAddress(taxRateTypeId, body)

Post Tax By Address

This is a Batch offering for 'Tax By Address' service. It accepts a single address, purchase amount or a list of addresses, purchase amounts and retrieve applicable taxes.

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
String taxRateTypeId = "taxRateTypeId_example"; // String | The tax rate id.
TaxAddressRequest body = new TaxAddressRequest(); // TaxAddressRequest | TaxAddressRequest Class Object having tax request.
try {
    TaxResponses result = apiInstance.getBatchTaxByAddress(taxRateTypeId, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getBatchTaxByAddress");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taxRateTypeId String The tax rate id. [enum: General, Auto, Medical, Construction]
body TaxAddressRequest TaxAddressRequest Class Object having tax request.

Return type

TaxResponses

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/xml, application/json

getBatchTaxByLocation

TaxLocationResponses getBatchTaxByLocation(taxRateTypeId, body)

Post Tax By Location

This is a Batch offering for 'Tax By Location' service. It accepts a single location coordinate, purchase amount or a list of location coordinates, purchase amounts and retrieve applicable tax.

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
String taxRateTypeId = "taxRateTypeId_example"; // String | The tax rate id.
TaxLocationRequest body = new TaxLocationRequest(); // TaxLocationRequest | TaxAddressRequest Class Object having tax request.
try {
    TaxLocationResponses result = apiInstance.getBatchTaxByLocation(taxRateTypeId, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getBatchTaxByLocation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taxRateTypeId String The tax rate id. [enum: General, Auto, Medical, Construction]
body TaxLocationRequest TaxAddressRequest Class Object having tax request.

Return type

TaxLocationResponses

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/xml, application/json

getBatchTaxRateByAddress

TaxRateResponses getBatchTaxRateByAddress(taxRateTypeId, body)

Post Taxrate By Address

This is a Batch offering for 'Taxrate By Address' service. It accepts a single address or a list of addresses and retrieve applicable tax rates.

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
String taxRateTypeId = "taxRateTypeId_example"; // String | The tax rate id.
TaxRateAddressRequest body = new TaxRateAddressRequest(); // TaxRateAddressRequest | TaxRateAddressRequest Class Object having tax rate request.
try {
    TaxRateResponses result = apiInstance.getBatchTaxRateByAddress(taxRateTypeId, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getBatchTaxRateByAddress");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taxRateTypeId String The tax rate id. [enum: General, Auto, Medical, Construction]
body TaxRateAddressRequest TaxRateAddressRequest Class Object having tax rate request.

Return type

TaxRateResponses

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

getBatchTaxRateByLocation

TaxRateLocationResponses getBatchTaxRateByLocation(taxRateTypeId, body)

Post Taxrate By Location

This is a Batch offering for 'Taxrate By Location' service. It accepts a single location coordinate or a list of location coordinates and retrieve applicable tax rates.

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
String taxRateTypeId = "taxRateTypeId_example"; // String | The tax rate id.
TaxRateLocationRequest body = new TaxRateLocationRequest(); // TaxRateLocationRequest | TaxRateLocationRequest Class Object having tax rate request.
try {
    TaxRateLocationResponses result = apiInstance.getBatchTaxRateByLocation(taxRateTypeId, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getBatchTaxRateByLocation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taxRateTypeId String The tax rate id. [enum: General, Auto, Medical, Construction]
body TaxRateLocationRequest TaxRateLocationRequest Class Object having tax rate request.

Return type

TaxRateLocationResponses

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

getIPDTaxByAddress

TaxDistrictResponse getIPDTaxByAddress(address, returnLatLongFields, latLongFormat)

Get IPD Tax by Address

This will accept 'address' as a parameter and will return one or many IPDs details for that region in which address will fall.

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
String address = "address_example"; // String | The address to be searched.
String returnLatLongFields = "returnLatLongFields_example"; // String | Y or N (default is N) - Returns Latitude Longitude Fields
String latLongFormat = "latLongFormat_example"; // String | (default is Decimal) - Returns Desired Latitude Longitude Format
try {
    TaxDistrictResponse result = apiInstance.getIPDTaxByAddress(address, returnLatLongFields, latLongFormat);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getIPDTaxByAddress");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
address String The address to be searched.
returnLatLongFields String Y or N (default is N) - Returns Latitude Longitude Fields [optional] [enum: Y, N]
latLongFormat String (default is Decimal) - Returns Desired Latitude Longitude Format [optional] [enum: PreZero, PreZeroDecimal, Decimal, DecimalAssumed]

Return type

TaxDistrictResponse

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

getIPDTaxByAddressBatch

TaxDistrictResponseList getIPDTaxByAddressBatch(body)

Get IPD Tax for batch requests

Get IPD Tax for batch requests

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
IPDTaxByAddressBatchRequest body = new IPDTaxByAddressBatchRequest(); // IPDTaxByAddressBatchRequest | IPDTaxByAddressBatchRequest Class Object having IPD tax request
try {
    TaxDistrictResponseList result = apiInstance.getIPDTaxByAddressBatch(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getIPDTaxByAddressBatch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body IPDTaxByAddressBatchRequest IPDTaxByAddressBatchRequest Class Object having IPD tax request

Return type

TaxDistrictResponseList

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

getSpecificTaxByAddress

TaxResponse getSpecificTaxByAddress(taxRateTypeId, address, purchaseAmount)

Get Tax By Address

This service calculates and returns taxes applicable at a specific address. Address, purchase amount and supported tax rate type are inputs to the service.

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
String taxRateTypeId = "taxRateTypeId_example"; // String | The tax rate id.
String address = "address_example"; // String | The address to be searched.
String purchaseAmount = "purchaseAmount_example"; // String | The amount on which tax to be calculated.
try {
    TaxResponse result = apiInstance.getSpecificTaxByAddress(taxRateTypeId, address, purchaseAmount);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getSpecificTaxByAddress");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taxRateTypeId String The tax rate id. [enum: General, Auto, Medical, Construction]
address String The address to be searched.
purchaseAmount String The amount on which tax to be calculated.

Return type

TaxResponse

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

getSpecificTaxByLocation

TaxResponse getSpecificTaxByLocation(taxRateTypeId, latitude, longitude, purchaseAmount)

Get Tax By Location

This service calculates and returns tax applicable at a specific location. Longitude, latitude, purchase amount and supported tax rate type are inputs to the service.

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
String taxRateTypeId = "taxRateTypeId_example"; // String | The tax rate id.
String latitude = "latitude_example"; // String | Latitude of the location.
String longitude = "longitude_example"; // String | Longitude of the location.
String purchaseAmount = "purchaseAmount_example"; // String | The amount on which tax to be calculated.
try {
    TaxResponse result = apiInstance.getSpecificTaxByLocation(taxRateTypeId, latitude, longitude, purchaseAmount);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getSpecificTaxByLocation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taxRateTypeId String The tax rate id. [enum: General, Auto, Medical, Construction]
latitude String Latitude of the location.
longitude String Longitude of the location.
purchaseAmount String The amount on which tax to be calculated.

Return type

TaxResponse

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

getSpecificTaxRateByAddress

TaxRateResponse getSpecificTaxRateByAddress(taxRateTypeId, address)

Get Taxrate By Address

Retrieves tax rates applicable to a specific address. This service accepts address and supported tax rate type as inputs to retrieve applicable tax rates.

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
String taxRateTypeId = "taxRateTypeId_example"; // String | The tax rate id.
String address = "address_example"; // String | The address to be searched.
try {
    TaxRateResponse result = apiInstance.getSpecificTaxRateByAddress(taxRateTypeId, address);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getSpecificTaxRateByAddress");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taxRateTypeId String The tax rate id. [enum: General, Auto, Medical, Construction]
address String The address to be searched.

Return type

TaxRateResponse

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

getSpecificTaxRateByLocation

TaxRateResponse getSpecificTaxRateByLocation(taxRateTypeId, latitude, longitude)

Get Taxrate By Location

Retrieves tax rates applicable to a specific location. This service accepts longitude, latitude and supported tax rate type as inputs to retrieve applicable tax rates.

Example

// Import classes:
//import pb.ApiClient;
//import pb.ApiException;
//import pb.Configuration;
//import pb.auth.*;
//import pb.locationintelligence.LIAPIGeoTaxServiceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API_KEY and SECRET for authorization: oAuth2Password
 ApiClient defaultClient = Configuration.getDefaultApiClient();
 defaultClient.setoAuthApiKey("<YOUR API KEY>");
 defaultClient.setoAuthSecret("<YOUR SECRET>");

LIAPIGeoTaxServiceApi apiInstance = new LIAPIGeoTaxServiceApi();
String taxRateTypeId = "taxRateTypeId_example"; // String | The tax rate id.
String latitude = "latitude_example"; // String | Latitude of the location.
String longitude = "longitude_example"; // String | Longitude of the location.
try {
    TaxRateResponse result = apiInstance.getSpecificTaxRateByLocation(taxRateTypeId, latitude, longitude);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LIAPIGeoTaxServiceApi#getSpecificTaxRateByLocation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taxRateTypeId String The tax rate id. [enum: General, Auto, Medical, Construction]
latitude String Latitude of the location.
longitude String Longitude of the location.

Return type

TaxRateResponse

Authorization

oAuth2Password

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml