API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

To get started, see Data Connect Guide.

Authentication

This API supports many different methods of authentication, see Authentication Options.

Rate Limiting

Example

HTTP 429 Too Many Requests
{
    "Error": true,
    "Message": "Rate Limiting Applied. 8 active requests are already in progress."
}

Data Connect limits the number of concurrent requests you can perform per RQ Database.

If the rate limit is exceeded, the response will be HTTP 429 and you will not be able to make additional requests until a previously made request finishes.

ENDPOINTS

RESOURCES

Category

[
    {
        "CategoryNumber": "10101012",
        "Category": "Financing",
        "CategoryPath": ">> Activations >> Financing"
    }
]
Name Description
CategoryNumber (NVARCHAR (100)) Identifier for the Category
Category (NVARCHAR (MAX)) Category Name
CategoryPath (NVARCHAR (MAX)) Category

Store

[
    {
        "StoreID": 1,
        "City": "Phoenix",
        "Address": "27617 Commerce Center Dr",
        "StoreName": "Altera Kiosk"
    }
]
Name Description
StoreID (Integer) Identifier for a Store in RQ
City (String) City
Address (String) Address
StoreName (String) Store name

CashIn

[
    {
        "amount": 0,
        "cash_in_id": 6882,
        "comment": "",
        "employee_id": 4,
        "employee_id_2": 4,
        "employee_name": "John Tester",
        "employee_name_2": "John Tester",
        "in_date": "2009-10-27T09:35:30.767",
        "store_id": 1,
        "terminal_id": 0
    }
]
Name Description
amount (MONEY) Cash in amount
cash_in_id (INTEGER) Internal identifier in RQ
comment (VARCHAR(2000)) Comment
employee_id (INTEGER) Identifier for an employee in RQ
employee_id_2 (INTEGER) Identifier for an employee in RQ
employee_name (VARCHAR(MAX)) Name of employee who performed cash in
employee_name_2 (VARCHAR(MAX)) Name of employee who verified cash in
in_date (DateTime) Cash in date
store_id (INTEGER) Identifier for a store in RQ
terminal_id (INTEGER) Identifier for a terminal in RQ

CashOut

[
    {
        "amount": 332478,
        "cash_out_id": 104253,
        "comment": "b",
        "employee_id": 2863,
        "employee_id_2": 2863,
        "employee_name": "iQmetrix Employee",
        "employee_name_2": "iQmetrix Employee",
        "out_date": "2011-04-13T11:35:23.32",
        "store_id": 1,
        "terminal_id": 0
    }
]
Name Description
amount (MONEY) Cash out amount
cash_out_id (INTEGER) Internal identifier in RQ
comment (VARCHAR(5000)) Comment
employee_id (INTEGER) Identifier for an employee in RQ
employee_id_2 (INTEGER) Identifier for an employee in RQ
employee_name (VARCHAR(MAX)) Name of employee who performed cash out
employee_name_2 (VARCHAR(MAX)) Name of employee who verified cash out
out_date (DateTime) Cash out date
store_id (INTEGER) Identifier for a store in RQ
terminal_id (INTEGER) Identifier for a terminal in RQ

OriginalSalesInvoice

[
    {
        "invoice_id": 1265314,
        "orig_date": "2013-04-09T08:23:51.93",
        "orig_employee_id": 45,
        "orig_employee_name": "iQmetrix Employee",
        "orig_invoice_id": 1265312,
        "orig_receipt": "00001IN1805",
        "orig_store_id": 1,
        "orig_terminal_id": 0,
        "orig_workstation": "null",
        "store_id": 1
    }
]
Name Description
invoice_id (INTEGER) Internal identifier in RQ
orig_date (DateTime) Invoice date
orig_employee_id (INTEGER) Identifier for an employee in RQ
orig_employee_name (VARCHAR(MAX)) Name of employee on invoice
orig_invoice_id (INTEGER) Identifier of invoice in RQ
orig_receipt (VARCHAR(14)) Receipt number
orig_store_id (INTEGER) Identifier for a store in RQ
orig_terminal_id (INTEGER) Identifier for a terminal in RQ
orig_workstation (VARCHAR(50)) Workstation
store_id (INTEGER) Identifier for a store in RQ

PunchClockEntry

[
    {
        "employee_id": 2,
        "employee_name": "iQmetrix Employee",
        "employee_verified": true,
        "in_comment": "",
        "manager_verified": false,
        "out_comment": "Auto-Punch Out",
        "punch_id": 7341,
        "statue": 1,
        "store_id": 1,
        "time_in": "2010-01-04T08:00:00",
        "time_out": "2010-01-04T12:33:00"
    }
]
Name Description
employee_id (INTEGER) Identifier for an employee in RQ
employee_name (NVARCHAR (MAX)) Name of employee on punch
employee_verified (BIT) A flag to indicate employee verification of punch
in_comment (VARCHAR(100)) Comment for punch in
manager_verified (BIT) A flag to indicate manager verification of punch
out_comment (VARCHAR(100)) Comment for punch out
punch_id (INTEGER) Internal identifier for punch in RQ
statue (TINYINT) Standard = 1, Edited = 1, Added = 2, Deleted = 3
store_id (INTEGER) Identifier for a store in RQ
time_in (DateTime) Punch in time
time_out (DateTime) Punch out time

PunchClockEntryRevision

[
    {
        "comment": "wrong location - entered correctly at corporate office",
        "employee": "Cathy Day",
        "employee_id": 107,
        "orig_time_in": "2010-01-04T06:12:52.79",
        "orig_time_out": "2010-01-04T15:06:36.677",
        "punch_id": 6276,
        "revised_by_employee": "Dayle Paulson",
        "revised_by_employee_id": 7,
        "revised_date": "2010-01-14T16:06:18.25",
        "revised_time_in": "null",
        "revised_time_out": "null",
        "revision_id": 1567,
        "revision_type": 3,
        "store_id": 1
    }
]
Name Description
comment (VARCHAR(255)) Revision comment
employee (VARCHAR(MAX)) Employee on revision
employee_id (INTEGER) Identifier for an employee in RQ
orig_time_in (DateTime) Original punch in time
orig_time_out (DateTime) Original punch out time
punch_id (INTEGER) Internal identifier for punch in RQ
revised_by_employee (VARCHAR(MAX)) Employee making revision
revised_by_employee_id (INTEGER) Identifier for an employee in RQ
revised_date (DateTime) Date and time punch was revised
revised_time_in (DateTime) Revised punch in
revised_time_out (DateTime) Revised punch out
revision_id (INTEGER) Internal identifier in RQ
revision_type (TINYINT) Not Specified = 0, Edit = 1, Addition = 2, Deletion = 3
store_id (INTEGER) Identifier for a store in RQ

SaleInvoiceCoupon

[
    {
        "Amount": 3.5,
        "DateCreated": "2012-06-11T13:13:51.74",
        "Description": "Normal Coupon",
        "InvoiceIDByStore": "00001IN1001",
        "SaleInvoiceID": 1263859,
        "StoreID1": 1
    }
]
Name Description
Amount (MONEY) Amount on coupon
DateCreated (DateTime) Date created
Description (NVARCHAR(MAX)) Description
InvoiceIDByStore (VARCHAR(14)) Invoice
SaleInvoiceID (INTEGER) Internal identifier in RQ
StoreID1 (INTEGER) Identifier for a store in RQ

SaleInvoicePayment

[
    {
        "amount": 152.25,
        "change_amount": 0,
        "comments": "",
        "customer_id": "null",
        "customer_member_num": "null",
        "employee_id": 4,
        "employee_name": "John Tester",
        "employee_name_3": "John Tester",
        "invoice_id": 524371,
        "is_bill_payment": 0,
        "payment_type": "Cash",
        "receipt_number": "00001IN117",
        "store_id": 1,
        "terminal_id": 0,
        "trans_create_time": "2010-03-10T15:20:19.323",
        "trans_logged_time": "null",
        "workstation_name": "null"
    }
]
Name Description
amount (MONEY) Amount
change_amount (MONEY) Change given
comments (TEXT) Comments
customer_id (INTEGER) Identifier for a customer in RQ
customer_member_num (VARCHAR(30)) Customer member number in RQ
employee_id (INTEGER) Identifier for an employee in RQ
employee_name (VARCHAR(MAX)) Name of employee in RQ
employee_name_3 (VARCHAR(MAX)) Name of employee in RQ
invoice_id (INTEGER) Internal identifier in RQ
is_bill_payment (BIT) A flag to indicate if this is a bill payment
payment_type (NVARCHAR(MAX)) Payment type
receipt_number (VARCHAR(14)) Receipt number
store_id (INTEGER) Identifier for a store in RQ
terminal_id (INTEGER) Identifier for a terminal in RQ
trans_create_time (DateTime) Transaction created time
trans_logged_time (DateTime) Transaction logged time
workstation_name (VARCHAR(50)) Workstation name

SaleInvoiceProduct

[
    {
        "Activation": 0,
        "AssociationNumber": 1,
        "category_number": "10101126",
        "category_path": ">> Accessories >> Antennas",
        "cost": 6.96,
        "Discount": 0,
        "employee_id": 2892,
        "employee_name": "iQmetrix Employee",
        "invoice_id": 1267257,
        "item_logged_time": "2015-03-03T07:40:29.493",
        "list_price": 1,
        "override_amt": 0,
        "Priority": 1,
        "product_description": "ADAPTER CABLE USB727/760- Test",
        "product_id": "ASANUN000001",
        "product_type": "Regular Global Product",
        "quantity": 1,
        "receipt_number": "00416IN4417",
        "Return": 0,
        "sale_price": 1,
        "store_id": 221,
        "terminal_id": 0,
        "workstation_name": "TEMP-W530-W8"
    }
]
Name Description
Activation (INTEGER) A flag to indicate if this is an activated product
AssociationNumber (INTEGER) Association number in rq
category_number (VARCHAR(150)) Internal identifier for a Category in RQ
category_path (VARCHAR(150)) Category
cost (MONEY) Cost
Discount (MONEY) A flag to indicate if this is a discounted product
employee_id (INTEGER) Identifier for an employee in RQ
employee_name (VARCHAR(250)) Name of employee in RQ
invoice_id (INTEGER) Internal identifier in RQ
item_logged_time (DateTime) Time the product was added to the invoice
list_price (MONEY) List price
override_amt (MONEY) Override amount
Priority (INTEGER) A number representing the priority of the product on the invoice
product_description (NVARCHAR(MAX)) Description
product_id (VARCHAR(250)) Identifier for a product in RQ
product_type (VARCHAR(250)) Product type in RQ
quantity (INTEGER) Quantity
receipt_number (VARCHAR(50)) Receipt number in RQ
Return (INTEGER) A flag to indicate if this is a returned product
sale_price (MONEY) Sale price
store_id (INTEGER) Identifier for a store in RQ
terminal_id (INTEGER) Transaction logged time
workstation_name (VARCHAR(100)) Workstation name

SaleInvoiceTax

[
    {
        "DateCreated": "2010-05-28T15:55:38.78",
        "InvoiceIDByStore": "00001IN193",
        "SaleInvoiceID": 812306,
        "StoreID1": 1,
        "Tax": 0
    }
]
Name Description
DateCreated (DateTime) Created date
InvoiceIDByStore (VARCHAR(14)) Invoice number
SaleInvoiceID (INTEGER) Identifier for an invoice in RQ
StoreID1 (INTEGER) Identifier for a store in RQ
Tax (MONEY) Tax amount

Relationship

[
    {
        "CompanyID": 21090,
        "CompanyName": "KENTEL",
        "DoingBusinessAs": "Kentel Corp"
    }
]
Name Description
CompanyID (INTEGER) Identifier for a Company
CompanyName (VARCHAR(50)) Database name
DoingBusinessAs (NVARCHAR(MAX)) Company name

DealerRelationship

[
    {
        "CompanyID": 14146,
        "CompanyName": "KENTEL",
        "LocationEntityID": 14192,
        "LocationName": "Region A"
    }
]
Name Description
CompanyID (BIGINT) Identifier for a Company
CompanyName (NVARCHAR(128)) Company name
LocationEntityID (BIGINT) Identifier for the Location, Region, Channel or District in Entity Store
LocationName (NVARCHAR(MAX)) Name of the Location, Region, Channel or District

REQUESTS

GET Dealer Relationships

This request returns a list of LocationEntityIDs and Names for a Company that the partner can access.

When the response contains multiple resouces with the same CompanyID, the partner can access multiple nodes within the Company.

Example

The below response means the partner can access data on behalf of the company KENTEL using the context of Region 1 (LocationEntityID 14189) or Region 2 (LocationEntityID 14188).

{
  "CompanyID": 14146,
  "CompanyName": "MasterCompany",
  "LocationEntityID": 14189,
  "LocationName": "Child Dealer 1"
},
{
  "CompanyID": 14146,
  "CompanyName": "MasterCompany",
  "LocationEntityID": 14188,
  "LocationName": "Child Dealer 2"
}

Definition

GET /partner/relationships/dealers?Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/relationships/dealers
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingDealerRelationships()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers");
    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 GettingDealerRelationships() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers");
     
    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/partner/relationships/dealers', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[DealerRelationship]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CompanyID": 14146,
        "CompanyName": "KENTEL",
        "LocationEntityID": 14192,
        "LocationName": "Region A"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CompanyID": 14146,
            "CompanyName": "KENTEL",
            "LocationEntityID": 14192,
            "LocationName": "Region A"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CompanyID>14146</CompanyID>
    <CompanyName>KENTEL</CompanyName>
    <LocationEntityID>14192</LocationEntityID>
    <LocationName>Region A</LocationName>
  </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
CompanyID,CompanyName,LocationEntityID,LocationName
14146,KENTEL,14192,Region A

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 Partner Relationships

This request will return a list of Companies the Partner can access data from.

If the response is empty, use the request Getting Dealer Relationships instead.

Definition

GET /partner/relationships?Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/relationships
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/relationships" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingPartnerRelationships()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/relationships");
    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 GettingPartnerRelationships() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/relationships");
     
    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/partner/relationships', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[Relationship]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CompanyID": 21090,
        "CompanyName": "KENTEL",
        "DoingBusinessAs": "Kentel Corp"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CompanyID": 21090,
            "CompanyName": "KENTEL",
            "DoingBusinessAs": "Kentel Corp"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CompanyID>21090</CompanyID>
    <CompanyName>KENTEL</CompanyName>
    <DoingBusinessAs>Kentel Corp</DoingBusinessAs>
  </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
CompanyID,CompanyName,DoingBusinessAs
21090,KENTEL,Kentel Corp

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 Categories for a Company

Definition

GET /partner/Envysion/Categories?CompanyId={CompanyId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/Categories?CompanyId=22575
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/Categories?CompanyId=22575" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingCategoriesForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/Categories?CompanyId=22575");
    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 GettingCategoriesForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/Categories?CompanyId=22575");
     
    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/partner/Envysion/Categories?CompanyId=22575', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[Category]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CategoryNumber": "10101012",
        "Category": "Financing",
        "CategoryPath": ">> Activations >> Financing"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CategoryNumber": "10101012",
            "Category": "Financing",
            "CategoryPath": ">> Activations >> Financing"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CategoryNumber>10101012</CategoryNumber>
    <Category>Financing</Category>
    <CategoryPath>>> Activations >> Financing</CategoryPath>
  </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
CategoryNumber,Category,CategoryPath
10101012,Financing,>> Activations >> Financing

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 Stores for a Company

Definition

GET /partner/Envysion/Stores?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/Stores?CompanyId=22575&LocationEntityID=14188
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/Stores?CompanyId=22575&LocationEntityID=14188" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingStoresForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/Stores?CompanyId=22575&LocationEntityID=14188");
    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 GettingStoresForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/Stores?CompanyId=22575&LocationEntityID=14188");
     
    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/partner/Envysion/Stores?CompanyId=22575&LocationEntityID=14188', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[Store]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "StoreID": 1,
        "City": "Phoenix",
        "Address": "27617 Commerce Center Dr",
        "StoreName": "Altera Kiosk"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "StoreID": 1,
            "City": "Phoenix",
            "Address": "27617 Commerce Center Dr",
            "StoreName": "Altera Kiosk"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <StoreID>1</StoreID>
    <City>Phoenix</City>
    <Address>27617 Commerce Center Dr</Address>
    <StoreName>Altera Kiosk</StoreName>
  </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,City,Address,StoreName
1,Phoenix,27617 Commerce Center Dr,Altera Kiosk

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 Cash Ins for a Company

Definition

GET /partner/Envysion/CashIns?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreId={StoreId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/CashIns?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/CashIns?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingCashInsForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/CashIns?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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 GettingCashInsForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/CashIns?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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/partner/Envysion/CashIns?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[CashIn]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "amount": 0,
        "cash_in_id": 6882,
        "comment": "",
        "employee_id": 4,
        "employee_id_2": 4,
        "employee_name": "John Tester",
        "employee_name_2": "John Tester",
        "in_date": "2009-10-27T09:35:30.767",
        "store_id": 1,
        "terminal_id": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "amount": 0,
            "cash_in_id": 6882,
            "comment": "",
            "employee_id": 4,
            "employee_id_2": 4,
            "employee_name": "John Tester",
            "employee_name_2": "John Tester",
            "in_date": "2009-10-27T09:35:30.767",
            "store_id": 1,
            "terminal_id": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <amount>0</amount>
    <cash_in_id>6882</cash_in_id>
    <comment></comment>
    <employee_id>4</employee_id>
    <employee_id_2>4</employee_id_2>
    <employee_name>John Tester</employee_name>
    <employee_name_2>John Tester</employee_name_2>
    <in_date>2009-10-27T09:35:30.767</in_date>
    <store_id>1</store_id>
    <terminal_id>0</terminal_id>
  </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
amount,cash_in_id,comment,employee_id,employee_id_2,employee_name,employee_name_2,in_date,store_id,terminal_id
0,6882,,4,4,John Tester,John Tester,2009-10-27T09:35:30.767,1,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 Cash Outs for a Company

Definition

GET /partner/Envysion/CashOuts?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreId={StoreId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/CashOuts?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/CashOuts?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingCashOutsForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/CashOuts?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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 GettingCashOutsForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/CashOuts?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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/partner/Envysion/CashOuts?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[CashOut]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "amount": 332478,
        "cash_out_id": 104253,
        "comment": "b",
        "employee_id": 2863,
        "employee_id_2": 2863,
        "employee_name": "iQmetrix Employee",
        "employee_name_2": "iQmetrix Employee",
        "out_date": "2011-04-13T11:35:23.32",
        "store_id": 1,
        "terminal_id": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "amount": 332478,
            "cash_out_id": 104253,
            "comment": "b",
            "employee_id": 2863,
            "employee_id_2": 2863,
            "employee_name": "iQmetrix Employee",
            "employee_name_2": "iQmetrix Employee",
            "out_date": "2011-04-13T11:35:23.32",
            "store_id": 1,
            "terminal_id": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <amount>332478</amount>
    <cash_out_id>104253</cash_out_id>
    <comment>b</comment>
    <employee_id>2863</employee_id>
    <employee_id_2>2863</employee_id_2>
    <employee_name>iQmetrix Employee</employee_name>
    <employee_name_2>iQmetrix Employee</employee_name_2>
    <out_date>2011-04-13T11:35:23.32</out_date>
    <store_id>1</store_id>
    <terminal_id>0</terminal_id>
  </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
amount,cash_out_id,comment,employee_id,employee_id_2,employee_name,employee_name_2,out_date,store_id,terminal_id
332478,104253,b,2863,2863,iQmetrix Employee,iQmetrix Employee,2011-04-13T11:35:23.32,1,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 Original Sales Invoices for a Company

Definition

GET /partner/Envysion/OriginalSaleInvoice?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreId={StoreId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/OriginalSaleInvoice?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/OriginalSaleInvoice?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingOriginalSalesInvoicesForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/OriginalSaleInvoice?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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 GettingOriginalSalesInvoicesForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/OriginalSaleInvoice?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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/partner/Envysion/OriginalSaleInvoice?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[OriginalSalesInvoice]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "invoice_id": 1265314,
        "orig_date": "2013-04-09T08:23:51.93",
        "orig_employee_id": 45,
        "orig_employee_name": "iQmetrix Employee",
        "orig_invoice_id": 1265312,
        "orig_receipt": "00001IN1805",
        "orig_store_id": 1,
        "orig_terminal_id": 0,
        "orig_workstation": "null",
        "store_id": 1
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "invoice_id": 1265314,
            "orig_date": "2013-04-09T08:23:51.93",
            "orig_employee_id": 45,
            "orig_employee_name": "iQmetrix Employee",
            "orig_invoice_id": 1265312,
            "orig_receipt": "00001IN1805",
            "orig_store_id": 1,
            "orig_terminal_id": 0,
            "orig_workstation": "null",
            "store_id": 1
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <invoice_id>1265314</invoice_id>
    <orig_date>2013-04-09T08:23:51.93</orig_date>
    <orig_employee_id>45</orig_employee_id>
    <orig_employee_name>iQmetrix Employee</orig_employee_name>
    <orig_invoice_id>1265312</orig_invoice_id>
    <orig_receipt>00001IN1805</orig_receipt>
    <orig_store_id>1</orig_store_id>
    <orig_terminal_id>0</orig_terminal_id>
    <orig_workstation>null</orig_workstation>
    <store_id>1</store_id>
  </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
invoice_id,orig_date,orig_employee_id,orig_employee_name,orig_invoice_id,orig_receipt,orig_store_id,orig_terminal_id,orig_workstation,store_id
1265314,2013-04-09T08:23:51.93,45,iQmetrix Employee,1265312,00001IN1805,1,0,null,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 Punch Clock Entries for a Company

Definition

GET /partner/Envysion/PunchClock?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreId={StoreId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/PunchClock?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/PunchClock?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingPunchClockEntriesForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/PunchClock?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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 GettingPunchClockEntriesForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/PunchClock?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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/partner/Envysion/PunchClock?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PunchClockEntry]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "employee_id": 2,
        "employee_name": "iQmetrix Employee",
        "employee_verified": true,
        "in_comment": "",
        "manager_verified": false,
        "out_comment": "Auto-Punch Out",
        "punch_id": 7341,
        "statue": 1,
        "store_id": 1,
        "time_in": "2010-01-04T08:00:00",
        "time_out": "2010-01-04T12:33:00"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "employee_id": 2,
            "employee_name": "iQmetrix Employee",
            "employee_verified": true,
            "in_comment": "",
            "manager_verified": false,
            "out_comment": "Auto-Punch Out",
            "punch_id": 7341,
            "statue": 1,
            "store_id": 1,
            "time_in": "2010-01-04T08:00:00",
            "time_out": "2010-01-04T12:33:00"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <employee_id>2</employee_id>
    <employee_name>iQmetrix Employee</employee_name>
    <employee_verified>true</employee_verified>
    <in_comment></in_comment>
    <manager_verified>false</manager_verified>
    <out_comment>Auto-Punch Out</out_comment>
    <punch_id>7341</punch_id>
    <statue>1</statue>
    <store_id>1</store_id>
    <time_in>2010-01-04T08:00:00</time_in>
    <time_out>2010-01-04T12:33:00</time_out>
  </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
employee_id,employee_name,employee_verified,in_comment,manager_verified,out_comment,punch_id,statue,store_id,time_in,time_out
2,iQmetrix Employee,true,,false,Auto-Punch Out,7341,1,1,2010-01-04T08:00:00,2010-01-04T12:33:00

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 Punch Clock Entries Revisions for a Company

Definition

GET /partner/Envysion/PunchClockRevisions?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreId={StoreId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/PunchClockRevisions?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/PunchClockRevisions?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingPunchClockEntriesRevisionsForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/PunchClockRevisions?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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 GettingPunchClockEntriesRevisionsForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/PunchClockRevisions?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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/partner/Envysion/PunchClockRevisions?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PunchClockEntryRevision]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "comment": "wrong location - entered correctly at corporate office",
        "employee": "Cathy Day",
        "employee_id": 107,
        "orig_time_in": "2010-01-04T06:12:52.79",
        "orig_time_out": "2010-01-04T15:06:36.677",
        "punch_id": 6276,
        "revised_by_employee": "Dayle Paulson",
        "revised_by_employee_id": 7,
        "revised_date": "2010-01-14T16:06:18.25",
        "revised_time_in": "null",
        "revised_time_out": "null",
        "revision_id": 1567,
        "revision_type": 3,
        "store_id": 1
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "comment": "wrong location - entered correctly at corporate office",
            "employee": "Cathy Day",
            "employee_id": 107,
            "orig_time_in": "2010-01-04T06:12:52.79",
            "orig_time_out": "2010-01-04T15:06:36.677",
            "punch_id": 6276,
            "revised_by_employee": "Dayle Paulson",
            "revised_by_employee_id": 7,
            "revised_date": "2010-01-14T16:06:18.25",
            "revised_time_in": "null",
            "revised_time_out": "null",
            "revision_id": 1567,
            "revision_type": 3,
            "store_id": 1
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <comment>wrong location - entered correctly at corporate office</comment>
    <employee>Cathy Day</employee>
    <employee_id>107</employee_id>
    <orig_time_in>2010-01-04T06:12:52.79</orig_time_in>
    <orig_time_out>2010-01-04T15:06:36.677</orig_time_out>
    <punch_id>6276</punch_id>
    <revised_by_employee>Dayle Paulson</revised_by_employee>
    <revised_by_employee_id>7</revised_by_employee_id>
    <revised_date>2010-01-14T16:06:18.25</revised_date>
    <revised_time_in>null</revised_time_in>
    <revised_time_out>null</revised_time_out>
    <revision_id>1567</revision_id>
    <revision_type>3</revision_type>
    <store_id>1</store_id>
  </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
comment,employee,employee_id,orig_time_in,orig_time_out,punch_id,revised_by_employee,revised_by_employee_id,revised_date,revised_time_in,revised_time_out,revision_id,revision_type,store_id
wrong location - entered correctly at corporate office,Cathy Day,107,2010-01-04T06:12:52.79,2010-01-04T15:06:36.677,6276,Dayle Paulson,7,2010-01-14T16:06:18.25,null,null,1567,3,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 Sale Invoice Coupons for a Company

Definition

GET /partner/Envysion/SaleInvoiceCoupons?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreId={StoreId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/SaleInvoiceCoupons?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoiceCoupons?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingSaleInvoiceCouponsForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoiceCoupons?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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 GettingSaleInvoiceCouponsForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoiceCoupons?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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/partner/Envysion/SaleInvoiceCoupons?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SaleInvoiceCoupon]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Amount": 3.5,
        "DateCreated": "2012-06-11T13:13:51.74",
        "Description": "Normal Coupon",
        "InvoiceIDByStore": "00001IN1001",
        "SaleInvoiceID": 1263859,
        "StoreID1": 1
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Amount": 3.5,
            "DateCreated": "2012-06-11T13:13:51.74",
            "Description": "Normal Coupon",
            "InvoiceIDByStore": "00001IN1001",
            "SaleInvoiceID": 1263859,
            "StoreID1": 1
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Amount>3.5</Amount>
    <DateCreated>2012-06-11T13:13:51.74</DateCreated>
    <Description>Normal Coupon</Description>
    <InvoiceIDByStore>00001IN1001</InvoiceIDByStore>
    <SaleInvoiceID>1263859</SaleInvoiceID>
    <StoreID1>1</StoreID1>
  </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
Amount,DateCreated,Description,InvoiceIDByStore,SaleInvoiceID,StoreID1
3.5,2012-06-11T13:13:51.74,Normal Coupon,00001IN1001,1263859,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 Sale Invoice Payments for a Company

Definition

GET /partner/Envysion/SaleInvoicePayments?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreId={StoreId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/SaleInvoicePayments?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoicePayments?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingSaleInvoicePaymentsForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoicePayments?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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 GettingSaleInvoicePaymentsForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoicePayments?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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/partner/Envysion/SaleInvoicePayments?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SaleInvoicePayment]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "amount": 152.25,
        "change_amount": 0,
        "comments": "",
        "customer_id": "null",
        "customer_member_num": "null",
        "employee_id": 4,
        "employee_name": "John Tester",
        "employee_name_3": "John Tester",
        "invoice_id": 524371,
        "is_bill_payment": 0,
        "payment_type": "Cash",
        "receipt_number": "00001IN117",
        "store_id": 1,
        "terminal_id": 0,
        "trans_create_time": "2010-03-10T15:20:19.323",
        "trans_logged_time": "null",
        "workstation_name": "null"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "amount": 152.25,
            "change_amount": 0,
            "comments": "",
            "customer_id": "null",
            "customer_member_num": "null",
            "employee_id": 4,
            "employee_name": "John Tester",
            "employee_name_3": "John Tester",
            "invoice_id": 524371,
            "is_bill_payment": 0,
            "payment_type": "Cash",
            "receipt_number": "00001IN117",
            "store_id": 1,
            "terminal_id": 0,
            "trans_create_time": "2010-03-10T15:20:19.323",
            "trans_logged_time": "null",
            "workstation_name": "null"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <amount>152.25</amount>
    <change_amount>0</change_amount>
    <comments></comments>
    <customer_id>null</customer_id>
    <customer_member_num>null</customer_member_num>
    <employee_id>4</employee_id>
    <employee_name>John Tester</employee_name>
    <employee_name_3>John Tester</employee_name_3>
    <invoice_id>524371</invoice_id>
    <is_bill_payment>0</is_bill_payment>
    <payment_type>Cash</payment_type>
    <receipt_number>00001IN117</receipt_number>
    <store_id>1</store_id>
    <terminal_id>0</terminal_id>
    <trans_create_time>2010-03-10T15:20:19.323</trans_create_time>
    <trans_logged_time>null</trans_logged_time>
    <workstation_name>null</workstation_name>
  </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
amount,change_amount,comments,customer_id,customer_member_num,employee_id,employee_name,employee_name_3,invoice_id,is_bill_payment,payment_type,receipt_number,store_id,terminal_id,trans_create_time,trans_logged_time,workstation_name
152.25,0,,null,null,4,John Tester,John Tester,524371,0,Cash,00001IN117,1,0,2010-03-10T15:20:19.323,null,null

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 Invoice Products for a Company

Definition

GET /partner/Envysion/SaleInvoiceProducts?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}StartDate={StartDate}&StopDate={StopDate}&StoreId={StoreId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/SaleInvoiceProducts?CompanyId=22575&LocationEntityID=14188&DateRange=TodayStartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoiceProducts?CompanyId=22575&LocationEntityID=14188&DateRange=TodayStartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingSaleInvoiceProductsForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoiceProducts?CompanyId=22575&LocationEntityID=14188&DateRange=TodayStartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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 GettingSaleInvoiceProductsForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoiceProducts?CompanyId=22575&LocationEntityID=14188&DateRange=TodayStartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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/partner/Envysion/SaleInvoiceProducts?CompanyId=22575&LocationEntityID=14188&DateRange=TodayStartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SaleInvoiceProduct]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Activation": 0,
        "AssociationNumber": 1,
        "category_number": "10101126",
        "category_path": ">> Accessories >> Antennas",
        "cost": 6.96,
        "Discount": 0,
        "employee_id": 2892,
        "employee_name": "iQmetrix Employee",
        "invoice_id": 1267257,
        "item_logged_time": "2015-03-03T07:40:29.493",
        "list_price": 1,
        "override_amt": 0,
        "Priority": 1,
        "product_description": "ADAPTER CABLE USB727/760- Test",
        "product_id": "ASANUN000001",
        "product_type": "Regular Global Product",
        "quantity": 1,
        "receipt_number": "00416IN4417",
        "Return": 0,
        "sale_price": 1,
        "store_id": 221,
        "terminal_id": 0,
        "workstation_name": "TEMP-W530-W8"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Activation": 0,
            "AssociationNumber": 1,
            "category_number": "10101126",
            "category_path": ">> Accessories >> Antennas",
            "cost": 6.96,
            "Discount": 0,
            "employee_id": 2892,
            "employee_name": "iQmetrix Employee",
            "invoice_id": 1267257,
            "item_logged_time": "2015-03-03T07:40:29.493",
            "list_price": 1,
            "override_amt": 0,
            "Priority": 1,
            "product_description": "ADAPTER CABLE USB727/760- Test",
            "product_id": "ASANUN000001",
            "product_type": "Regular Global Product",
            "quantity": 1,
            "receipt_number": "00416IN4417",
            "Return": 0,
            "sale_price": 1,
            "store_id": 221,
            "terminal_id": 0,
            "workstation_name": "TEMP-W530-W8"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Activation>0</Activation>
    <AssociationNumber>1</AssociationNumber>
    <category_number>10101126</category_number>
    <category_path>>> Accessories >> Antennas</category_path>
    <cost>6.96</cost>
    <Discount>0</Discount>
    <employee_id>2892</employee_id>
    <employee_name>iQmetrix Employee</employee_name>
    <invoice_id>1267257</invoice_id>
    <item_logged_time>2015-03-03T07:40:29.493</item_logged_time>
    <list_price>1</list_price>
    <override_amt>0</override_amt>
    <Priority>1</Priority>
    <product_description>ADAPTER CABLE USB727/760- Test</product_description>
    <product_id>ASANUN000001</product_id>
    <product_type>Regular Global Product</product_type>
    <quantity>1</quantity>
    <receipt_number>00416IN4417</receipt_number>
    <Return>0</Return>
    <sale_price>1</sale_price>
    <store_id>221</store_id>
    <terminal_id>0</terminal_id>
    <workstation_name>TEMP-W530-W8</workstation_name>
  </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
Activation,AssociationNumber,category_number,category_path,cost,Discount,employee_id,employee_name,invoice_id,item_logged_time,list_price,override_amt,Priority,product_description,product_id,product_type,quantity,receipt_number,Return,sale_price,store_id,terminal_id,workstation_name
0,1,10101126,>> Accessories >> Antennas,6.96,0,2892,iQmetrix Employee,1267257,2015-03-03T07:40:29.493,1,0,1,ADAPTER CABLE USB727/760- Test,ASANUN000001,Regular Global Product,1,00416IN4417,0,1,221,0,TEMP-W530-W8

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 Invoice Taxes for a Company

Definition

GET /partner/Envysion/SaleInvoiceTaxes?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreId={StoreId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/Envysion/SaleInvoiceTaxes?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoiceTaxes?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingSaleInvoiceTaxesForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoiceTaxes?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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 GettingSaleInvoiceTaxesForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/Envysion/SaleInvoiceTaxes?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=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/partner/Envysion/SaleInvoiceTaxes?CompanyId=22575&LocationEntityID=14188&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreId=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SaleInvoiceTax]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "DateCreated": "2010-05-28T15:55:38.78",
        "InvoiceIDByStore": "00001IN193",
        "SaleInvoiceID": 812306,
        "StoreID1": 1,
        "Tax": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "DateCreated": "2010-05-28T15:55:38.78",
            "InvoiceIDByStore": "00001IN193",
            "SaleInvoiceID": 812306,
            "StoreID1": 1,
            "Tax": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <DateCreated>2010-05-28T15:55:38.78</DateCreated>
    <InvoiceIDByStore>00001IN193</InvoiceIDByStore>
    <SaleInvoiceID>812306</SaleInvoiceID>
    <StoreID1>1</StoreID1>
    <Tax>0</Tax>
  </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
DateCreated,InvoiceIDByStore,SaleInvoiceID,StoreID1,Tax
2010-05-28T15:55:38.78,00001IN193,812306,1,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

ERRORS

HTTP Status Code Description How to Resolve
HTTP 400 Bad Request Ensure request body is formatted properly
HTTP 401 Token is invalid Ensure Access Token is valid and has not expired
HTTP 403 Unauthorized Ensure Access Token is valid and user has appropriate security
HTTP 404 Not Found Ensure URI is valid
HTTP 500 Unexpected Error See Message in response for more information
HTTP 503 Maintenance The requested data is currently undergoing scheduled maintenance, please try again after 12:00PM UTC
Was this page helpful?