API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

ENDPOINTS

RESOURCES

SaleInvoice

[
    {
        "CustomerId": 13699,
        "InvoiceId": 1,
        "PaymentTypeId": 3,
        "AccountsReceivableId": 68,
        "AccountsReceivableName": "TTL10AR1",
        "InvoiceName": "TARGEIN1",
        "CustomerName": "KENTEL corp",
        "DatabaseName": "KENTE",
        "TotalAmount": 38.14,
        "TotalPaid": 50,
        "CreatedDate": "2010-07-03T11:07:19.59",
        "OriginalId": 1
    }
]
Name Description
CustomerId (INT) Identifier for a customer
InvoiceId (INT) Identifier for this invoice
PaymentTypeId (INT) Identifier for a Payment Type
AccountsReceivableId (INT)  
AccountsReceivableName (VARCHAR(14))  
InvoiceName (VARCHAR(14)) Invoice name
CustomerName (VARCHAR(50)) Customer name
DatabaseName (VARCHAR(25)) Database name
TotalAmount (MONEY) Total amount
TotalPaid (MONEY) Total paid
CreatedDate (DateTime) Created date
OriginalId (INT) Identifier of the original invoice

EnabledRecurringInvoiceData

[
    {
        "CustomerId": 124059,
        "AccountsReceivableId": 68,
        "AccountsReceivableName": "TTL10AR1",
        "StartDate": "2014-12-16T00:00:00",
        "StopDate": "",
        "RecurringInvoiceId": 8,
        "RecurringInvoiceName": "ML101RI1",
        "ProductId": 5002,
        "Quantity": 1,
        "Price": 100,
        "Sku": "ASBANS000070",
        "Description": "NSP"
    }
]
Name Description
CustomerId (INT) Identifier for a customer
AccountsReceivableId (INT)  
AccountsReceivableName (VARCHAR(14))  
StartDate (DateTime) Start date
StopDate (DateTime) End date
RecurringInvoiceId (INT) Identifier for the recurring invoice
RecurringInvoiceName (VARCHAR(14)) Recurring invoice name
ProductId (INT) Product Id
Quantity (INT) Quantity
Price (MONEY) Price
Sku (VARCHAR(12)) SKU
Description (NVARCHAR(MAX)) Description

SaleInvoicesByProductFilterData

[
    {
        "CustomerId": 2922,
        "SaleInvoiceId": 2,
        "Quantity": 1,
        "Price": 49.99,
        "AccountsReceivableId": 5,
        "AccountsReceivableName": "",
        "Year": 2011,
        "Month": 1,
        "OriginalId": 0,
        "RefundCodeId": "159c193f-1904-deaa-2fed-a318b17f2b70",
        "SaleInvoiceName": "84WEAIN1",
        "CustomerName": "KENTEL corp",
        "DatabaseName": "KENTE"
    }
]
Name Description
CustomerId (INT) Identifier for a customer
SaleInvoiceId (INT) Identifier for the sale invoice
Quantity (INT) Quantity
Price (MONEY) Price
AccountsReceivableId (INT)  
AccountsReceivableName (VARCHAR(14))  
Year (INT) Year (full)
Month (INT) Month as an integer
OriginalId (INT) Original invoice id
RefundCodeId (UNIQUEIDENTIFIER) Identifier for a refund code
SaleInvoiceName (VARCHAR(14)) Sale invoice name
CustomerName (VARCHAR(50)) Customer name
DatabaseName (VARCHAR(25)) Database name

SummaryOfSaaSProductData

[
    {
        "CustomerID": 85161,
        "LocationCount": 0,
        "WorkstationCount": 0,
        "RqMobileCount": 0
    }
]
Name Description
CustomerID (INT) Identifier for a customer
LocationCount (INT) Number of locations
WorkstationCount (INT) Number of workstations
RqMobileCount (INT) Number of RQ Mobile devices

InvoicesWithMatchingEpinIDData

[
    {
        "InvoiceID": "84WEAIN16524",
        "ProductSKU": "INEPNS000001",
        "SaleInvoiceID": 130511,
        "Priority": 1,
        "PinTypeID": 21,
        "PinCode": "9875564858978",
        "SerialNumber": "987465328",
        "Amount": 50,
        "CostToCustomer": 50
    }
]
Name Description
InvoiceID (VARCHAR(14)) Identifier for an invoice
ProductSKU (VARCHAR(12)) Product SKU
SaleInvoiceID (INT) Identifier for an invoice
Priority (INT) Priority
PinTypeID (INT) Identifier for a pin type
PinCode (VARCHAR(30)) EPIN pin code
SerialNumber (VARCHAR(100)) Serial number
Amount (MONEY) Amount
CostToCustomer (MONEY) Customer cost

InvoicesPaidToAccountData

[
    {
        "CustomerId": 54514,
        "SaleInvoiceId": 1891,
        "ProductId": 1355,
        "Quantity": 1,
        "Price": 79.99,
        "Sku": "ASMIRI000016",
        "Description": "Blackberry Curve 3 Grey"
    }
]
Name Description
CustomerId (INT) Identifier for a customer
SaleInvoiceId (INT)  
ProductId (INT) Identifier for a product
Quantity (INT) Quantity
Price (MONEY) Price
Sku (VARCHAR(12)) SKU
Description (NVARCHAR(MAX)) Description

GlobalProduct

[
    {
        "GlobalProductID": 1,
        "ProductIdentifier": "ASCLMO000001",
        "ProductName": "CLA Mot V262/265 Platinum_TestCLA"
    }
]
Name Description
GlobalProductID (INT) Identifier for a GlobalProduct
ProductIdentifier (VARCHAR(12)) Product identifier
ProductName (NVARCHAR(MAX)) Product name

REQUESTS

Get Sale Invoices By IDs

Definition

GET /billing/GetSaleInvoicesByIDS?CompanyID={CompanyID}&SaleInvoiceIds={SaleInvoiceIds}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetSaleInvoicesByIDS?CompanyID=22573&SaleInvoiceIds=1,2,3
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetSaleInvoicesByIDS?CompanyID=22573&SaleInvoiceIds=1,2,3" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GetSaleInvoicesByIds()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetSaleInvoicesByIDS?CompanyID=22573&SaleInvoiceIds=1,2,3");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GetSaleInvoicesByIds() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetSaleInvoicesByIDS?CompanyID=22573&SaleInvoiceIds=1,2,3");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetSaleInvoicesByIDS?CompanyID=22573&SaleInvoiceIds=1,2,3', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SaleInvoice]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CustomerId": 13699,
        "InvoiceId": 1,
        "PaymentTypeId": 3,
        "AccountsReceivableId": 68,
        "AccountsReceivableName": "TTL10AR1",
        "InvoiceName": "TARGEIN1",
        "CustomerName": "KENTEL corp",
        "DatabaseName": "KENTE",
        "TotalAmount": 38.14,
        "TotalPaid": 50,
        "CreatedDate": "2010-07-03T11:07:19.59",
        "OriginalId": 1
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CustomerId": 13699,
            "InvoiceId": 1,
            "PaymentTypeId": 3,
            "AccountsReceivableId": 68,
            "AccountsReceivableName": "TTL10AR1",
            "InvoiceName": "TARGEIN1",
            "CustomerName": "KENTEL corp",
            "DatabaseName": "KENTE",
            "TotalAmount": 38.14,
            "TotalPaid": 50,
            "CreatedDate": "2010-07-03T11:07:19.59",
            "OriginalId": 1
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CustomerId>13699</CustomerId>
    <InvoiceId>1</InvoiceId>
    <PaymentTypeId>3</PaymentTypeId>
    <AccountsReceivableId>68</AccountsReceivableId>
    <AccountsReceivableName>TTL10AR1</AccountsReceivableName>
    <InvoiceName>TARGEIN1</InvoiceName>
    <CustomerName>KENTEL corp</CustomerName>
    <DatabaseName>KENTE</DatabaseName>
    <TotalAmount>38.14</TotalAmount>
    <TotalPaid>50</TotalPaid>
    <CreatedDate>2010-07-03T11:07:19.59</CreatedDate>
    <OriginalId>1</OriginalId>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CustomerId,InvoiceId,PaymentTypeId,AccountsReceivableId,AccountsReceivableName,InvoiceName,CustomerName,DatabaseName,TotalAmount,TotalPaid,CreatedDate,OriginalId
13699,1,3,68,TTL10AR1,TARGEIN1,KENTEL corp,KENTE,38.14,50,2010-07-03T11:07:19.59,1

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET Traffic Counts

Definition

GET /billing/GetTrafficCounts?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetTrafficCounts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetTrafficCounts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTrafficCounts()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetTrafficCounts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GettingTrafficCounts() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetTrafficCounts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetTrafficCounts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "storeid": 1
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "storeid": 1
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <storeid>1</storeid>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
storeid
1

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET Invoices With Matching Epins IDs

Definition

GET /billing/GetInvoicesWithMatchingEpinIDS?CompanyID={CompanyID}&IDs={IDs}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetInvoicesWithMatchingEpinIDS?CompanyID=22573&IDs=84WEAIN16524
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesWithMatchingEpinIDS?CompanyID=22573&IDs=84WEAIN16524" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingInvoicesWithMatchingEpinsIds()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesWithMatchingEpinIDS?CompanyID=22573&IDs=84WEAIN16524");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GettingInvoicesWithMatchingEpinsIds() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesWithMatchingEpinIDS?CompanyID=22573&IDs=84WEAIN16524");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesWithMatchingEpinIDS?CompanyID=22573&IDs=84WEAIN16524', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[InvoicesWithMatchingEpinIDData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "InvoiceID": "84WEAIN16524",
        "ProductSKU": "INEPNS000001",
        "SaleInvoiceID": 130511,
        "Priority": 1,
        "PinTypeID": 21,
        "PinCode": "9875564858978",
        "SerialNumber": "987465328",
        "Amount": 50,
        "CostToCustomer": 50
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "InvoiceID": "84WEAIN16524",
            "ProductSKU": "INEPNS000001",
            "SaleInvoiceID": 130511,
            "Priority": 1,
            "PinTypeID": 21,
            "PinCode": "9875564858978",
            "SerialNumber": "987465328",
            "Amount": 50,
            "CostToCustomer": 50
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <InvoiceID>84WEAIN16524</InvoiceID>
    <ProductSKU>INEPNS000001</ProductSKU>
    <SaleInvoiceID>130511</SaleInvoiceID>
    <Priority>1</Priority>
    <PinTypeID>21</PinTypeID>
    <PinCode>9875564858978</PinCode>
    <SerialNumber>987465328</SerialNumber>
    <Amount>50</Amount>
    <CostToCustomer>50</CostToCustomer>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
InvoiceID,ProductSKU,SaleInvoiceID,Priority,PinTypeID,PinCode,SerialNumber,Amount,CostToCustomer
84WEAIN16524,INEPNS000001,130511,1,21,9875564858978,987465328,50,50

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET Summary of SaaS Products

Definition

GET /billing/GetSummaryOfSaaSProducts?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&CustomerIDS={CustomerIDS}&LocationGlobalProductIDs={LocationGlobalProductIDs}&WorkstationsGlobalProductIDs={WorkstationsGlobalProductIDs}&RQMobileGlobalProductIDs={RQMobileGlobalProductIDs}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetSummaryOfSaaSProducts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CustomerIDS=85161,119121,113548&LocationGlobalProductIDs=760,764&WorkstationsGlobalProductIDs=938,1456&RQMobileGlobalProductIDs=1721
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetSummaryOfSaaSProducts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CustomerIDS=85161,119121,113548&LocationGlobalProductIDs=760,764&WorkstationsGlobalProductIDs=938,1456&RQMobileGlobalProductIDs=1721" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingSummaryOfSaasProducts()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetSummaryOfSaaSProducts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CustomerIDS=85161,119121,113548&LocationGlobalProductIDs=760,764&WorkstationsGlobalProductIDs=938,1456&RQMobileGlobalProductIDs=1721");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GettingSummaryOfSaasProducts() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetSummaryOfSaaSProducts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CustomerIDS=85161,119121,113548&LocationGlobalProductIDs=760,764&WorkstationsGlobalProductIDs=938,1456&RQMobileGlobalProductIDs=1721");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetSummaryOfSaaSProducts?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&CustomerIDS=85161,119121,113548&LocationGlobalProductIDs=760,764&WorkstationsGlobalProductIDs=938,1456&RQMobileGlobalProductIDs=1721', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SummaryOfSaaSProductData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CustomerID": 85161,
        "LocationCount": 0,
        "WorkstationCount": 0,
        "RqMobileCount": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CustomerID": 85161,
            "LocationCount": 0,
            "WorkstationCount": 0,
            "RqMobileCount": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CustomerID>85161</CustomerID>
    <LocationCount>0</LocationCount>
    <WorkstationCount>0</WorkstationCount>
    <RqMobileCount>0</RqMobileCount>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CustomerID,LocationCount,WorkstationCount,RqMobileCount
85161,0,0,0

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET Enabled Recurring Invoices

Definition

GET /billing/GetEnabledRecurringInvoices?CompanyID={CompanyID}&LanguageCode={LanguageCode}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetEnabledRecurringInvoices?CompanyID=22573&LanguageCode=en-us&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetEnabledRecurringInvoices?CompanyID=22573&LanguageCode=en-us&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingEnabledRecurringInvoices()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetEnabledRecurringInvoices?CompanyID=22573&LanguageCode=en-us&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GettingEnabledRecurringInvoices() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetEnabledRecurringInvoices?CompanyID=22573&LanguageCode=en-us&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetEnabledRecurringInvoices?CompanyID=22573&LanguageCode=en-us&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[EnabledRecurringInvoiceData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CustomerId": 124059,
        "AccountsReceivableId": 68,
        "AccountsReceivableName": "TTL10AR1",
        "StartDate": "2014-12-16T00:00:00",
        "StopDate": "",
        "RecurringInvoiceId": 8,
        "RecurringInvoiceName": "ML101RI1",
        "ProductId": 5002,
        "Quantity": 1,
        "Price": 100,
        "Sku": "ASBANS000070",
        "Description": "NSP"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CustomerId": 124059,
            "AccountsReceivableId": 68,
            "AccountsReceivableName": "TTL10AR1",
            "StartDate": "2014-12-16T00:00:00",
            "StopDate": "",
            "RecurringInvoiceId": 8,
            "RecurringInvoiceName": "ML101RI1",
            "ProductId": 5002,
            "Quantity": 1,
            "Price": 100,
            "Sku": "ASBANS000070",
            "Description": "NSP"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CustomerId>124059</CustomerId>
    <AccountsReceivableId>68</AccountsReceivableId>
    <AccountsReceivableName>TTL10AR1</AccountsReceivableName>
    <StartDate>2014-12-16T00:00:00</StartDate>
    <StopDate></StopDate>
    <RecurringInvoiceId>8</RecurringInvoiceId>
    <RecurringInvoiceName>ML101RI1</RecurringInvoiceName>
    <ProductId>5002</ProductId>
    <Quantity>1</Quantity>
    <Price>100</Price>
    <Sku>ASBANS000070</Sku>
    <Description>NSP</Description>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CustomerId,AccountsReceivableId,AccountsReceivableName,StartDate,StopDate,RecurringInvoiceId,RecurringInvoiceName,ProductId,Quantity,Price,Sku,Description
124059,68,TTL10AR1,2014-12-16T00:00:00,,8,ML101RI1,5002,1,100,ASBANS000070,NSP

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET Invoices With Unpaid Balances

Definition

GET /billing/GetInvoicesWithUnpaidBalance?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&PaymentTypeID={PaymentTypeID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetInvoicesWithUnpaidBalance?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&PaymentTypeID=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesWithUnpaidBalance?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&PaymentTypeID=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingInvoicesWithUnpaidBalances()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesWithUnpaidBalance?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&PaymentTypeID=1");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GettingInvoicesWithUnpaidBalances() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesWithUnpaidBalance?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&PaymentTypeID=1");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesWithUnpaidBalance?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&PaymentTypeID=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "InvoiceId": 130313
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "InvoiceId": 130313
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <InvoiceId>130313</InvoiceId>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
InvoiceId
130313

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET Sale Invoices By Product Filter

Definition

GET /billing/GetSaleInvoicesByProductFilter?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&GlobalProductIds={GlobalProductIds}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetSaleInvoicesByProductFilter?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&GlobalProductIds=760,764,768,1808,1809,1810
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetSaleInvoicesByProductFilter?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&GlobalProductIds=760,764,768,1808,1809,1810" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingSaleInvoicesByProductFilter()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetSaleInvoicesByProductFilter?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&GlobalProductIds=760,764,768,1808,1809,1810");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GettingSaleInvoicesByProductFilter() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetSaleInvoicesByProductFilter?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&GlobalProductIds=760,764,768,1808,1809,1810");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetSaleInvoicesByProductFilter?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&GlobalProductIds=760,764,768,1808,1809,1810', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SaleInvoicesByProductFilterData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CustomerId": 2922,
        "SaleInvoiceId": 2,
        "Quantity": 1,
        "Price": 49.99,
        "AccountsReceivableId": 5,
        "AccountsReceivableName": "",
        "Year": 2011,
        "Month": 1,
        "OriginalId": 0,
        "RefundCodeId": "159c193f-1904-deaa-2fed-a318b17f2b70",
        "SaleInvoiceName": "84WEAIN1",
        "CustomerName": "KENTEL corp",
        "DatabaseName": "KENTE"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CustomerId": 2922,
            "SaleInvoiceId": 2,
            "Quantity": 1,
            "Price": 49.99,
            "AccountsReceivableId": 5,
            "AccountsReceivableName": "",
            "Year": 2011,
            "Month": 1,
            "OriginalId": 0,
            "RefundCodeId": "159c193f-1904-deaa-2fed-a318b17f2b70",
            "SaleInvoiceName": "84WEAIN1",
            "CustomerName": "KENTEL corp",
            "DatabaseName": "KENTE"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CustomerId>2922</CustomerId>
    <SaleInvoiceId>2</SaleInvoiceId>
    <Quantity>1</Quantity>
    <Price>49.99</Price>
    <AccountsReceivableId>5</AccountsReceivableId>
    <AccountsReceivableName></AccountsReceivableName>
    <Year>2011</Year>
    <Month>1</Month>
    <OriginalId>0</OriginalId>
    <RefundCodeId>159c193f-1904-deaa-2fed-a318b17f2b70</RefundCodeId>
    <SaleInvoiceName>84WEAIN1</SaleInvoiceName>
    <CustomerName>KENTEL corp</CustomerName>
    <DatabaseName>KENTE</DatabaseName>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CustomerId,SaleInvoiceId,Quantity,Price,AccountsReceivableId,AccountsReceivableName,Year,Month,OriginalId,RefundCodeId,SaleInvoiceName,CustomerName,DatabaseName
2922,2,1,49.99,5,,2011,1,0,159c193f-1904-deaa-2fed-a318b17f2b70,84WEAIN1,KENTEL corp,KENTE

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET Invoices Paid To Account

Definition

GET /billing/GetInvoicesPaidToAccount?CompanyID={CompanyID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetInvoicesPaidToAccount?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesPaidToAccount?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingInvoicesPaidToAccount()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesPaidToAccount?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GettingInvoicesPaidToAccount() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesPaidToAccount?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetInvoicesPaidToAccount?CompanyID=22573&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[InvoicesPaidToAccountData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CustomerId": 54514,
        "SaleInvoiceId": 1891,
        "ProductId": 1355,
        "Quantity": 1,
        "Price": 79.99,
        "Sku": "ASMIRI000016",
        "Description": "Blackberry Curve 3 Grey"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CustomerId": 54514,
            "SaleInvoiceId": 1891,
            "ProductId": 1355,
            "Quantity": 1,
            "Price": 79.99,
            "Sku": "ASMIRI000016",
            "Description": "Blackberry Curve 3 Grey"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CustomerId>54514</CustomerId>
    <SaleInvoiceId>1891</SaleInvoiceId>
    <ProductId>1355</ProductId>
    <Quantity>1</Quantity>
    <Price>79.99</Price>
    <Sku>ASMIRI000016</Sku>
    <Description>Blackberry Curve 3 Grey</Description>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CustomerId,SaleInvoiceId,ProductId,Quantity,Price,Sku,Description
54514,1891,1355,1,79.99,ASMIRI000016,Blackberry Curve 3 Grey

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET AR Payment Invoice

Definition

GET /billing/GetARPaymentInvoice?CompanyID={CompanyID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetARPaymentInvoice?CompanyID=22573
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetARPaymentInvoice?CompanyID=22573" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingArPaymentInvoice()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetARPaymentInvoice?CompanyID=22573");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GettingArPaymentInvoice() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetARPaymentInvoice?CompanyID=22573");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetARPaymentInvoice?CompanyID=22573', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GlobalProduct]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "GlobalProductID": 1,
        "ProductIdentifier": "ASCLMO000001",
        "ProductName": "CLA Mot V262/265 Platinum_TestCLA"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "GlobalProductID": 1,
            "ProductIdentifier": "ASCLMO000001",
            "ProductName": "CLA Mot V262/265 Platinum_TestCLA"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <GlobalProductID>1</GlobalProductID>
    <ProductIdentifier>ASCLMO000001</ProductIdentifier>
    <ProductName>CLA Mot V262/265 Platinum_TestCLA</ProductName>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
GlobalProductID,ProductIdentifier,ProductName
1,ASCLMO000001,CLA Mot V262/265 Platinum_TestCLA

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

Get All Global Products

Definition

GET /billing/GetAllGlobalProducts?CompanyID={CompanyID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /billing/GetAllGlobalProducts?CompanyID=22573
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/private//billing/GetAllGlobalProducts?CompanyID=22573" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GetAllGlobalProducts()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/private//billing/GetAllGlobalProducts?CompanyID=22573");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    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 GetAllGlobalProducts() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/private//billing/GetAllGlobalProducts?CompanyID=22573");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/private//billing/GetAllGlobalProducts?CompanyID=22573', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GlobalProduct]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "GlobalProductID": 1,
        "ProductIdentifier": "ASCLMO000001",
        "ProductName": "CLA Mot V262/265 Platinum_TestCLA"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "GlobalProductID": 1,
            "ProductIdentifier": "ASCLMO000001",
            "ProductName": "CLA Mot V262/265 Platinum_TestCLA"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <GlobalProductID>1</GlobalProductID>
    <ProductIdentifier>ASCLMO000001</ProductIdentifier>
    <ProductName>CLA Mot V262/265 Platinum_TestCLA</ProductName>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
GlobalProductID,ProductIdentifier,ProductName
1,ASCLMO000001,CLA Mot V262/265 Platinum_TestCLA

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file
Was this page helpful?