API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

This is a DRAFT specification provided for apprasial use only. Once the development team has approved the specification is accurate, resource descriptions will be added and this notation will be removed.

ENDPOINTS

Sandbox: https://taxesdemo.iqmetrix.net/v1
Production: https://taxes.iqmetrix.net/v1

RESOURCES

TaxDetails

{
    "TaxId": "866831b4-b852-ace8-ee65-3cf7fdb865d5",
    "CountryCode": "",
    "RegionCode": "",
    "TaxType": "Percentage",
    "TaxAuthority": "",
    "TaxAuthorityType": "GST",
    "Rate": 0.0896,
    "Tax": 16.49,
    "Taxable": 183.99,
    "UnitTax": 16.4855,
    "TaxName": "General and Service Tax",
    "EffectiveZoneLevel": ""
}
Name Description
TaxId (GUID)  
CountryCode (String)  
RegionCode (String)  
TaxType (String)  
TaxAuthority (String)  
TaxAuthorityType (String)  
Rate (Integer)  
Tax (Integer)  
Taxable (Integer)  
UnitTax (Integer)  
TaxName (String)  
EffectiveZoneLevel (String)  

LineResult

{
    "LineNumber": 96,
    "Taxable": 183.99,
    "Rate": "0",
    "Tax": 31.93,
    "Discount": "0",
    "TaxDetails": [
        {
            "TaxId": "866831b4-b852-ace8-ee65-3cf7fdb865d5",
            "CountryCode": "",
            "RegionCode": "",
            "TaxType": "Percentage",
            "TaxAuthority": "",
            "TaxAuthorityType": "GST",
            "Rate": 0.0896,
            "Tax": 16.49,
            "Taxable": 183.99,
            "UnitTax": 16.4855,
            "TaxName": "General and Service Tax",
            "EffectiveZoneLevel": ""
        }
    ]
}
Name Description
LineNumber (Integer)  
Taxable (Integer)  
Rate (String)  
Tax (Integer)  
Discount (String)  
TaxDetails (Array[TaxDetails])  

LineRequest

{
    "LineNumber": 96,
    "Taxable": 183.99,
    "Rate": "0",
    "Tax": 31.93,
    "Discount": "0",
    "TaxDetails": [
        {
            "TaxId": "866831b4-b852-ace8-ee65-3cf7fdb865d5",
            "CountryCode": "",
            "RegionCode": "",
            "TaxType": "Percentage",
            "TaxAuthority": "",
            "TaxAuthorityType": "GST",
            "Rate": 0.0896,
            "Tax": 16.49,
            "Taxable": 183.99,
            "UnitTax": 16.4855,
            "TaxName": "General and Service Tax",
            "EffectiveZoneLevel": ""
        }
    ]
}
Name Description
LineNumber (Integer)  
ProductId (String)  
ClassificationCode (String)  
UnitPrice (String)  
Quantity (String)  

TaxTotals

{
    "TaxId": "455397ae-d3d6-b3ae-030b-8229247485a7",
    "TaxType": "Percentage",
    "TaxAuthority": "Provincial Sales Tax",
    "TaxAuthorityType": "PST",
    "Rate": 0.0839,
    "Tax": 1398.74,
    "Taxable": 16671.26,
    "TaxName": "Provincial Sales Tax"
}
Name Description
TaxId (GUID)  
TaxType (String)  
TaxAuthority (String)  
TaxAuthorityType (String)  
Rate (Integer)  
Tax (Integer)  
Taxable (Integer)  
TaxName (String)  

TaxCalculationResult

{
    "Id": "312ab5cf-c678-4994-4c32-7dbaf6e203b2",
    "EntityId": 15726,
    "InvoiceId": "",
    "InvoiceDateUtc": "2017-01-18T18:39:30",
    "OriginalInvoiceId": "",
    "OriginalInvoiceDateUtc": "",
    "Lines": [
        {
            "LineNumber": 96,
            "Taxable": 183.99,
            "Rate": "0",
            "Tax": 31.93,
            "Discount": "0",
            "TaxDetails": [
                {
                    "TaxId": "866831b4-b852-ace8-ee65-3cf7fdb865d5",
                    "CountryCode": "",
                    "RegionCode": "",
                    "TaxType": "Percentage",
                    "TaxAuthority": "",
                    "TaxAuthorityType": "GST",
                    "Rate": 0.0896,
                    "Tax": 16.49,
                    "Taxable": 183.99,
                    "UnitTax": 16.4855,
                    "TaxName": "General and Service Tax",
                    "EffectiveZoneLevel": ""
                }
            ]
        }
    ],
    "TaxTotals": [
        {
            "TaxId": "455397ae-d3d6-b3ae-030b-8229247485a7",
            "TaxType": "Percentage",
            "TaxAuthority": "Provincial Sales Tax",
            "TaxAuthorityType": "PST",
            "Rate": 0.0839,
            "Tax": 1398.74,
            "Taxable": 16671.26,
            "TaxName": "Provincial Sales Tax"
        }
    ]
}
Name Description
Id (GUID)  
EntityId (Integer)  
InvoiceId (String)  
InvoiceDateUtc (DateTime)  
OriginalInvoiceId (String)  
OriginalInvoiceDateUtc (String)  
Lines (Array[LineResult])  
TaxTotals (Array[TaxTotals])  

TaxCalculationRequest

{
    "Id": "312ab5cf-c678-4994-4c32-7dbaf6e203b2",
    "EntityId": 15726,
    "InvoiceId": "",
    "InvoiceDateUtc": "2017-01-18T18:39:30",
    "OriginalInvoiceId": "",
    "OriginalInvoiceDateUtc": "",
    "ShippingAddress": {
        "StreetAddress": "123 Cornwall Ave",
        "LocalityCode": "",
        "RegionCode": "SK",
        "CountryCode": "CA",
        "PostalCode": "H0H0H0",
        "PostalCodeExtension": "null"
    },
    "OriginAddress": "null",
    "Lines": [
        {
            "LineNumber": 1,
            "ProductId": "0C424007-D07E-4BCD-884B-F766641F8AA1",
            "ClassificationCode": "40",
            "UnitPrice": "24.99",
            "Quantity": "1"
        }
    ],
    "TaxCalculationResultId": "8143ddc1-9b33-42d4-bdd0-20121304e1f1"
}
Name Description
Id (GUID)  
EntityId (Integer)  
InvoiceId (String)  
InvoiceDateUtc (DateTime)  
OriginalInvoiceId (String)  
OriginalInvoiceDateUtc (String)  
ShippingAddress (ShippingAddress)  
OriginAddress (String)  
Lines (Array[LineRequest])  
TaxCalculationResultId (GUID) Identifier for the TaxCalculationResult

ShippingAddress

{
    "StreetAddress": "123 Cornwall Ave",
    "LocalityCode": "",
    "RegionCode": "SK",
    "CountryCode": "CA",
    "PostalCode": "H0H0H0",
    "PostalCodeExtension": "null"
}
Name Description
StreetAddress (String)  
LocalityCode (String)  
RegionCode (String)  
CountryCode (String)  
PostalCode (String)  
PostalCodeExtension (String)  

AuthenticationType

[
    {
        "Id": 1,
        "Name": "BasicAuth",
        "Enabled": true
    }
]
Name Description
Id (Integer)  
Name (String)  
Enabled (Integer)  

TaxCalculationSetting

[
    {
        "Id": "ac030079-7951-46ef-f612-bb3ff2c41bbb",
        "EntityId": 14192,
        "CalculationSettingTypeId": 1,
        "Value": "PerItemRequest"
    }
]
Name Description
Id (GUID)  
EntityId (Integer)  
CalculationSettingTypeId (Integer)  
Value (String)  

ExtensionType

[
    {
        "Id": 1,
        "Name": "CustomerCode",
        "Enabled": true
    }
]
Name Description
Id (Integer)  
Name (String)  
Enabled (Integer)  

TaxPartner

[
    {
        "Id": 1,
        "Name": "iQmetrix",
        "GetTaxesEndPoint": "https://taxratestest.iqmetrix.net/"
    }
]
Name Description
Id (Integer)  
Name (String)  
GetTaxesEndPoint (String)  

ConfigurationExtensions

{
    "ExtensionTypeId": 3,
    "ExtensionType": "CurrencyCode",
    "Value": "en-ca"
}
Name Description
ExtensionTypeId (Integer)  
ExtensionType (String)  
Value (String)  

TaxPartnerConfiguration

[
    {
        "Id": "fd13f68c-7dc7-b956-498e-a201f6aaa59d",
        "EntityId": 14192,
        "TaxPartnerId": 1,
        "TaxPartner": "iQmetrix",
        "AuthenticationTypeId": 1,
        "AuthenticationType": "BasicAuth",
        "UserName": "sample string 7",
        "Password": "sample string 8",
        "ConfigurationExtensions": [
            {
                "ExtensionTypeId": 3,
                "ExtensionType": "CurrencyCode",
                "Value": "en-ca"
            }
        ]
    }
]
Name Description
Id (GUID)  
EntityId (Integer)  
TaxPartnerId (Integer)  
TaxPartner (String)  
AuthenticationTypeId (Integer)  
AuthenticationType (String)  
UserName (String)  
Password (String)  
ConfigurationExtensions (Array[ConfigurationExtensions])  

REQUESTS

POST a Tax Calculation Request

Request

POST /Companies({CompanyId})/TaxCalculationRequest

Example Request

POST /Companies(14146)/TaxCalculationRequest
Authorization: Bearer (Access Token)
Accept: application/json
Content-Type: application/json

{
    "EntityId": 15726,
    "InvoiceId": "",
    "InvoiceDateUtc": "2017-01-18T18:39:30",
    "OriginalInvoiceId": "",
    "OriginalInvoiceDateUtc": "",
    "ShippingAddress": {
        "StreetAddress": "123 Cornwall Ave",
        "LocalityCode": "",
        "RegionCode": "SK",
        "CountryCode": "CA",
        "PostalCode": "H0H0H0",
        "PostalCodeExtension": "null"
    },
    "OriginAddress": "null",
    "Lines": [
        {
            "LineNumber": 1,
            "ProductId": "0C424007-D07E-4BCD-884B-F766641F8AA1",
            "ClassificationCode": "40",
            "UnitPrice": "24.99",
            "Quantity": "1"
        }
    ]
}
curl -X POST "https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationRequest" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json" -H "Content-Type: application/json" -d '{
    "EntityId": 15726,
    "InvoiceId": "",
    "InvoiceDateUtc": "2017-01-18T18:39:30",
    "OriginalInvoiceId": "",
    "OriginalInvoiceDateUtc": "",
    "ShippingAddress": {
        "StreetAddress": "123 Cornwall Ave",
        "LocalityCode": "",
        "RegionCode": "SK",
        "CountryCode": "CA",
        "PostalCode": "H0H0H0",
        "PostalCodeExtension": "null"
    },
    "OriginAddress": "null",
    "Lines": [
        {
            "LineNumber": 1,
            "ProductId": "0C424007-D07E-4BCD-884B-F766641F8AA1",
            "ClassificationCode": "40",
            "UnitPrice": "24.99",
            "Quantity": "1"
        }
    ]
}'
static IRestResponse CreatingATaxCalculationRequest()
{
    var client = new RestClient("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationRequest");
    var request = new RestRequest(Method.POST);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 
    request.AddHeader("Content-Type", "application/json"); 

     request.AddParameter("application/json", "{\"EntityId\":15726,\"InvoiceId\":\"\",\"InvoiceDateUtc\":\"2017-01-18T18:39:30\",\"OriginalInvoiceId\":\"\",\"OriginalInvoiceDateUtc\":\"\",\"ShippingAddress\":{\"StreetAddress\":\"123 Cornwall Ave\",\"LocalityCode\":\"\",\"RegionCode\":\"SK\",\"CountryCode\":\"CA\",\"PostalCode\":\"H0H0H0\",\"PostalCodeExtension\":\"null\"},\"OriginAddress\":\"null\",\"Lines\":[{\"LineNumber\":1,\"ProductId\":\"0C424007-D07E-4BCD-884B-F766641F8AA1\",\"ClassificationCode\":\"40\",\"UnitPrice\":\"24.99\",\"Quantity\":\"1\"}]}", ParameterType.RequestBody);

    return client.Execute(request);
}
import org.apache.http.entity.StringEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse CreatingATaxCalculationRequest() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost request = new HttpPost("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationRequest");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    request.addHeader("Content-Type", "application/json"); 
    StringEntity body = new StringEntity("{\"EntityId\":15726,\"InvoiceId\":\"\",\"InvoiceDateUtc\":\"2017-01-18T18:39:30\",\"OriginalInvoiceId\":\"\",\"OriginalInvoiceDateUtc\":\"\",\"ShippingAddress\":{\"StreetAddress\":\"123 Cornwall Ave\",\"LocalityCode\":\"\",\"RegionCode\":\"SK\",\"CountryCode\":\"CA\",\"PostalCode\":\"H0H0H0\",\"PostalCodeExtension\":\"null\"},\"OriginAddress\":\"null\",\"Lines\":[{\"LineNumber\":1,\"ProductId\":\"0C424007-D07E-4BCD-884B-F766641F8AA1\",\"ClassificationCode\":\"40\",\"UnitPrice\":\"24.99\",\"Quantity\":\"1\"}]}");
    request.setEntity(body);
    
    return httpClient.execute(request);
}
require 'rest-client'

body = "{\"EntityId\":15726,\"InvoiceId\":\"\",\"InvoiceDateUtc\":\"2017-01-18T18:39:30\",\"OriginalInvoiceId\":\"\",\"OriginalInvoiceDateUtc\":\"\",\"ShippingAddress\":{\"StreetAddress\":\"123 Cornwall Ave\",\"LocalityCode\":\"\",\"RegionCode\":\"SK\",\"CountryCode\":\"CA\",\"PostalCode\":\"H0H0H0\",\"PostalCodeExtension\":\"null\"},\"OriginAddress\":\"null\",\"Lines\":[{\"LineNumber\":1,\"ProductId\":\"0C424007-D07E-4BCD-884B-F766641F8AA1\",\"ClassificationCode\":\"40\",\"UnitPrice\":\"24.99\",\"Quantity\":\"1\"}]}";

response = RestClient.post 'https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationRequest', body, {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
     :'Content-Type' => 'application/json',
    } 

puts response

URI Parameters

Request Parameters

Response Parameters

Example Response

HTTP 202 Content-Type: application/json
{
    "Id": "312ab5cf-c678-4994-4c32-7dbaf6e203b2",
    "EntityId": 15726,
    "InvoiceId": "",
    "InvoiceDateUtc": "2017-01-18T18:39:30",
    "OriginalInvoiceId": "",
    "OriginalInvoiceDateUtc": "",
    "ShippingAddress": {
        "StreetAddress": "123 Cornwall Ave",
        "LocalityCode": "",
        "RegionCode": "SK",
        "CountryCode": "CA",
        "PostalCode": "H0H0H0",
        "PostalCodeExtension": "null"
    },
    "OriginAddress": "null",
    "Lines": [
        {
            "LineNumber": 1,
            "ProductId": "0C424007-D07E-4BCD-884B-F766641F8AA1",
            "ClassificationCode": "40",
            "UnitPrice": "24.99",
            "Quantity": "1"
        }
    ],
    "TaxCalculationResultId": "8143ddc1-9b33-42d4-bdd0-20121304e1f1"
}

TaxCalculationRequest

GET Authentication Types

Request

GET /Companies({CompanyId})/AuthenticationTypes

Example Request

GET /Companies(14146)/AuthenticationTypes
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://taxesdemo.iqmetrix.net/v1/Companies(14146)/AuthenticationTypes" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingAuthenticationTypes()
{
    var client = new RestClient("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/AuthenticationTypes");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingAuthenticationTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/AuthenticationTypes");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://taxesdemo.iqmetrix.net/v1/Companies(14146)/AuthenticationTypes', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": 1,
        "Name": "BasicAuth",
        "Enabled": true
    }
]

Array[AuthenticationType]

GET Extension Types

Request

GET /Companies({CompanyId})/ExtensionTypes

Example Request

GET /Companies(14146)/ExtensionTypes
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://taxesdemo.iqmetrix.net/v1/Companies(14146)/ExtensionTypes" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingExtensionTypes()
{
    var client = new RestClient("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/ExtensionTypes");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingExtensionTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/ExtensionTypes");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://taxesdemo.iqmetrix.net/v1/Companies(14146)/ExtensionTypes', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": 1,
        "Name": "CustomerCode",
        "Enabled": true
    }
]

Array[ExtensionType]

GET Tax Partners

Request

GET /Companies({CompanyId})/TaxPartners

Example Request

GET /Companies(14146)/TaxPartners
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxPartners" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingTaxPartners()
{
    var client = new RestClient("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxPartners");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTaxPartners() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxPartners");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxPartners', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": 1,
        "Name": "iQmetrix",
        "GetTaxesEndPoint": "https://taxratestest.iqmetrix.net/"
    }
]

Array[TaxPartner]

GET Tax Calculation Settings

Request

GET /Companies({CompanyId})/TaxCalculationSettings

Example Request

GET /Companies(14146)/TaxCalculationSettings
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationSettings" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingTaxCalculationSettings()
{
    var client = new RestClient("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationSettings");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTaxCalculationSettings() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationSettings");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationSettings', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "ac030079-7951-46ef-f612-bb3ff2c41bbb",
        "EntityId": 14192,
        "CalculationSettingTypeId": 1,
        "Value": "PerItemRequest"
    }
]

Array[TaxCalculationSetting]

GET Tax Partner Cofigurations

Request

GET /Companies({CompanyId})/TaxPartnerConfigurations

Example Request

GET /Companies(14146)/TaxPartnerConfigurations
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxPartnerConfigurations" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingTaxPartnerCofigurations()
{
    var client = new RestClient("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxPartnerConfigurations");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTaxPartnerCofigurations() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxPartnerConfigurations");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxPartnerConfigurations', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": "fd13f68c-7dc7-b956-498e-a201f6aaa59d",
        "EntityId": 14192,
        "TaxPartnerId": 1,
        "TaxPartner": "iQmetrix",
        "AuthenticationTypeId": 1,
        "AuthenticationType": "BasicAuth",
        "UserName": "sample string 7",
        "Password": "sample string 8",
        "ConfigurationExtensions": [
            {
                "ExtensionTypeId": 3,
                "ExtensionType": "CurrencyCode",
                "Value": "en-ca"
            }
        ]
    }
]

Array[TaxPartnerConfiguration]

GET a Tax Calculation Result

Request

GET /Companies({CompanyId})/TaxCalculationResults({TaxCalculationResultId})

Example Request

GET /Companies(14146)/TaxCalculationResults(ad3db9b1-29c6-40fa-b444-c0f104907bdd)
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationResults(ad3db9b1-29c6-40fa-b444-c0f104907bdd)" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingATaxCalculationResult()
{
    var client = new RestClient("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationResults(ad3db9b1-29c6-40fa-b444-c0f104907bdd)");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingATaxCalculationResult() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationResults(ad3db9b1-29c6-40fa-b444-c0f104907bdd)");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://taxesdemo.iqmetrix.net/v1/Companies(14146)/TaxCalculationResults(ad3db9b1-29c6-40fa-b444-c0f104907bdd)', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": "312ab5cf-c678-4994-4c32-7dbaf6e203b2",
    "EntityId": 15726,
    "InvoiceId": "",
    "InvoiceDateUtc": "2017-01-18T18:39:30",
    "OriginalInvoiceId": "",
    "OriginalInvoiceDateUtc": "",
    "Lines": [
        {
            "LineNumber": 96,
            "Taxable": 183.99,
            "Rate": "0",
            "Tax": 31.93,
            "Discount": "0",
            "TaxDetails": [
                {
                    "TaxId": "866831b4-b852-ace8-ee65-3cf7fdb865d5",
                    "CountryCode": "",
                    "RegionCode": "",
                    "TaxType": "Percentage",
                    "TaxAuthority": "",
                    "TaxAuthorityType": "GST",
                    "Rate": 0.0896,
                    "Tax": 16.49,
                    "Taxable": 183.99,
                    "UnitTax": 16.4855,
                    "TaxName": "General and Service Tax",
                    "EffectiveZoneLevel": ""
                }
            ]
        }
    ],
    "TaxTotals": [
        {
            "TaxId": "455397ae-d3d6-b3ae-030b-8229247485a7",
            "TaxType": "Percentage",
            "TaxAuthority": "Provincial Sales Tax",
            "TaxAuthorityType": "PST",
            "Rate": 0.0839,
            "Tax": 1398.74,
            "Taxable": 16671.26,
            "TaxName": "Provincial Sales Tax"
        }
    ]
}

TaxCalculationResult

Was this page helpful?