API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

Data Connect allows you to retrieve data in the form of reports not available from within your RQ database (v4.23 and up).

To get started, see Data Connect Guide.

Note

For reports that provide optional URI parameters for filtering at different levels (ForWho/ForWhoIDs/LocationType/LocationTypeIDs), omitting these values will run the report at the default company level.

Authentication

Data Connect supports many different methods of authentication, see Authentication Options.

Note that for all reports the Access Token should be mapped to an employee in RQ.

Report List

For a complete list of reports in Data Connect, see Report List.

ENDPOINTS

RESOURCES

BillPaymentTransactionData

{
    "BillPaymentTransactionID": 24525,
    "VendorDepositID": 24759,
    "SaleInvoiceId": 2,
    "BillPaymentTransactionIDByStore": "TALLABP2386",
    "BillPaymentProviderID": 34,
    "TrackingNumber": "15123125126",
    "PaymentAmount": 25,
    "RoundingAmount": 0,
    "VendorDepositCalculatedFee": 0,
    "VRPCalculatedFee": 0,
    "NSPCalculatedFee": 0,
    "SummarizedTaxesAmount": 0,
    "ChangeAmount": 0,
    "WebsiteLaunched": false,
    "Comments": "Paid",
    "CreationDate": "2015-01-16T14:58:05.597",
    "CreationEmployeeID": 4063,
    "CreationStoreID": 6910,
    "TerminalID": 0,
    "CustomerId": 13699,
    "OriginalBPTransactionID": 13452,
    "CustomerSignature": "/////zy00lQpAAAABgAAACrZvlCja3x3yxkvc5w",
    "CustomerSignatureType": 0,
    "BillPaymentBillName": "",
    "SignatureCaptured": false,
    "ReferenceNumber": "213",
    "MerchantNumber": "102705",
    "LoyaltyProgramID": "e2ccd371-85f3-76a7-910a-5c814557836b",
    "BillPayValueTaxesAmount": 0,
    "SaleInvoiceAndLoyaltyProgramID": "bc81b551-d525-efa0-e1f3-0520f9f509a7",
    "CollectedForActivationDeposit": true,
    "BillPaymentGUID": "9180ebe8-56c8-1164-45eb-eefe55770651",
    "InvoiceComments": "Paid"
}
Name Description
BillPaymentTransactionID (INT) Internal identifier in RQ
VendorDepositID (INT)  
SaleInvoiceId (INT) Identifier for the sale invoice
BillPaymentTransactionIDByStore (VARCHAR(14)) Related Bill Pay - Bill Pay invoice for review, emailing or printing
BillPaymentProviderID (INT)  
TrackingNumber (VARCHAR(100)) Tracking # - tracking number associated with the Bill Pay
PaymentAmount (MONEY) Payment - amount applied to the bill
RoundingAmount (MONEY) Internal value in RQ
VendorDepositCalculatedFee (MONEY) Vendor deposit fee
VRPCalculatedFee (MONEY) VRP calculated fee
NSPCalculatedFee (MONEY) NSP calculated fee
SummarizedTaxesAmount (MONEY) Summarized taxes
ChangeAmount (MONEY) Change amount
WebsiteLaunched (BIT) A flag to indicate if website was launched (true) or not (false)
Comments (NVARCHAR(2500)) Comments
CreationDate (DateTime) Date - date and time the Bill Pay was tendered
CreationEmployeeID (INT) Identifier for an employee in RQ who created the Bill Payment
CreationStoreID (INT) Identifier for a store in RQ where the Bill Payment was created
TerminalID (INT) Identifier for a terminal in RQ
CustomerId (INT) Identifier for a customer
OriginalBPTransactionID (INT)  
CustomerSignature (IMAGE) Customer signature
CustomerSignatureType (TINYINT)  
BillPaymentBillName (VARCHAR(255)) Bill payment bill name
SignatureCaptured (BIT) A flag to indicate if signature was captured (true) or not (false)
ReferenceNumber (VARCHAR(255)) Reference number
MerchantNumber (VARCHAR(20)) The Merchant Number / ID used in payment credentials for this transaction
LoyaltyProgramID (UNIQUEIDENTIFIER)  
BillPayValueTaxesAmount (MONEY) Bill pay value taxes
SaleInvoiceAndLoyaltyProgramID (UNIQUEIDENTIFIER) Internal identifier in RQ
CollectedForActivationDeposit (BIT) A flag to indicate if activation deposit was collected (true) or not (false)
BillPaymentGUID (UNIQUEIDENTIFIER) Identifier for a Bill Payment
InvoiceComments (VARCHAR(255)) Comments

WorkstationPaymentAuditData

{
    "DoingBusinessAs": "KENTEL Corp",
    "DatabaseName": "KENTEL",
    "Version": " 6.2.150.6453",
    "StoreName": "84 West",
    "Address": " 123 W Main St",
    "City": "Dallas",
    "State": "TX",
    "Country": "United States",
    "ZipPostal": "55555",
    "PhoneNumber": "5555555555",
    "DealerCode": "5HYH7",
    "MachineName": "PC-512",
    "DeviceType": "iSC250",
    "PPEnabled": "Yes",
    "LastModified": "2017-03-28T15:16:58.313",
    "TransactionCount": 5,
    "LastTransactionDate": "2017-04-21T21:02:46.657"
}
Name Description
DoingBusinessAs (NVARCHAR(255)) Company name
DatabaseName (NVARCHAR(128)) Database name
Version (VARCHAR(20)) RQ version
StoreName (NVARCHAR(MAX)) Store name
Address (NVARCHAR(MAX)) Address
City (VARCHAR(50)) City
State (NVARCHAR(3)) State
Country (VARCHAR(50)) Country
ZipPostal (VARCHAR(15)) Zip/Postal code
PhoneNumber (VARCHAR(10)) Phone number
DealerCode (VARCHAR(100)) Dealer code
MachineName (VARCHAR(20)) Machine name
DeviceType (VARCHAR(50)) Device type
PPEnabled (VARCHAR(3)) A flag to indicate if Payment Processing is enabled
LastModified (DateTime) Last modified date
TransactionCount (INT) Number of transactions
LastTransactionDate (DateTime) Last transaction date

REQUESTS

GET Bill Payment Transactions

Definition

GET /Misc/BillPaymentTransactions?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&BillPayInvoice={BillPayInvoice}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /Misc/BillPaymentTransactions?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&BillPayInvoice=84WEABP515
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/Misc/BillPaymentTransactions?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&BillPayInvoice=84WEABP515" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingBillPaymentTransactions()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/Misc/BillPaymentTransactions?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&BillPayInvoice=84WEABP515");
    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 GettingBillPaymentTransactions() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/Misc/BillPaymentTransactions?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&BillPayInvoice=84WEABP515");
     
    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/Misc/BillPaymentTransactions?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&BillPayInvoice=84WEABP515', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

BillPaymentTransactionData

Example Response (Default)

HTTP 200 Content-Type: application/json
{
    "BillPaymentTransactionID": 24525,
    "VendorDepositID": 24759,
    "SaleInvoiceId": 2,
    "BillPaymentTransactionIDByStore": "TALLABP2386",
    "BillPaymentProviderID": 34,
    "TrackingNumber": "15123125126",
    "PaymentAmount": 25,
    "RoundingAmount": 0,
    "VendorDepositCalculatedFee": 0,
    "VRPCalculatedFee": 0,
    "NSPCalculatedFee": 0,
    "SummarizedTaxesAmount": 0,
    "ChangeAmount": 0,
    "WebsiteLaunched": false,
    "Comments": "Paid",
    "CreationDate": "2015-01-16T14:58:05.597",
    "CreationEmployeeID": 4063,
    "CreationStoreID": 6910,
    "TerminalID": 0,
    "CustomerId": 13699,
    "OriginalBPTransactionID": 13452,
    "CustomerSignature": "/////zy00lQpAAAABgAAACrZvlCja3x3yxkvc5w",
    "CustomerSignatureType": 0,
    "BillPaymentBillName": "",
    "SignatureCaptured": false,
    "ReferenceNumber": "213",
    "MerchantNumber": "102705",
    "LoyaltyProgramID": "e2ccd371-85f3-76a7-910a-5c814557836b",
    "BillPayValueTaxesAmount": 0,
    "SaleInvoiceAndLoyaltyProgramID": "bc81b551-d525-efa0-e1f3-0520f9f509a7",
    "CollectedForActivationDeposit": true,
    "BillPaymentGUID": "9180ebe8-56c8-1164-45eb-eefe55770651",
    "InvoiceComments": "Paid"
}

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "BillPaymentTransactionID": 24525,
    "VendorDepositID": 24759,
    "SaleInvoiceId": 2,
    "BillPaymentTransactionIDByStore": "TALLABP2386",
    "BillPaymentProviderID": 34,
    "TrackingNumber": "15123125126",
    "PaymentAmount": 25,
    "RoundingAmount": 0,
    "VendorDepositCalculatedFee": 0,
    "VRPCalculatedFee": 0,
    "NSPCalculatedFee": 0,
    "SummarizedTaxesAmount": 0,
    "ChangeAmount": 0,
    "WebsiteLaunched": false,
    "Comments": "Paid",
    "CreationDate": "2015-01-16T14:58:05.597",
    "CreationEmployeeID": 4063,
    "CreationStoreID": 6910,
    "TerminalID": 0,
    "CustomerId": 13699,
    "OriginalBPTransactionID": 13452,
    "CustomerSignature": "/////zy00lQpAAAABgAAACrZvlCja3x3yxkvc5w",
    "CustomerSignatureType": 0,
    "BillPaymentBillName": "",
    "SignatureCaptured": false,
    "ReferenceNumber": "213",
    "MerchantNumber": "102705",
    "LoyaltyProgramID": "e2ccd371-85f3-76a7-910a-5c814557836b",
    "BillPayValueTaxesAmount": 0,
    "SaleInvoiceAndLoyaltyProgramID": "bc81b551-d525-efa0-e1f3-0520f9f509a7",
    "CollectedForActivationDeposit": true,
    "BillPaymentGUID": "9180ebe8-56c8-1164-45eb-eefe55770651",
    "InvoiceComments": "Paid"
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <BillPaymentTransactionID>24525</BillPaymentTransactionID>
    <VendorDepositID>24759</VendorDepositID>
    <SaleInvoiceId>2</SaleInvoiceId>
    <BillPaymentTransactionIDByStore>TALLABP2386</BillPaymentTransactionIDByStore>
    <BillPaymentProviderID>34</BillPaymentProviderID>
    <TrackingNumber>15123125126</TrackingNumber>
    <PaymentAmount>25</PaymentAmount>
    <RoundingAmount>0</RoundingAmount>
    <VendorDepositCalculatedFee>0</VendorDepositCalculatedFee>
    <VRPCalculatedFee>0</VRPCalculatedFee>
    <NSPCalculatedFee>0</NSPCalculatedFee>
    <SummarizedTaxesAmount>0</SummarizedTaxesAmount>
    <ChangeAmount>0</ChangeAmount>
    <WebsiteLaunched>false</WebsiteLaunched>
    <Comments>Paid</Comments>
    <CreationDate>2015-01-16T14:58:05.597</CreationDate>
    <CreationEmployeeID>4063</CreationEmployeeID>
    <CreationStoreID>6910</CreationStoreID>
    <TerminalID>0</TerminalID>
    <CustomerId>13699</CustomerId>
    <OriginalBPTransactionID>13452</OriginalBPTransactionID>
    <CustomerSignature>/////zy00lQpAAAABgAAACrZvlCja3x3yxkvc5w</CustomerSignature>
    <CustomerSignatureType>0</CustomerSignatureType>
    <BillPaymentBillName></BillPaymentBillName>
    <SignatureCaptured>false</SignatureCaptured>
    <ReferenceNumber>213</ReferenceNumber>
    <MerchantNumber>102705</MerchantNumber>
    <LoyaltyProgramID>e2ccd371-85f3-76a7-910a-5c814557836b</LoyaltyProgramID>
    <BillPayValueTaxesAmount>0</BillPayValueTaxesAmount>
    <SaleInvoiceAndLoyaltyProgramID>bc81b551-d525-efa0-e1f3-0520f9f509a7</SaleInvoiceAndLoyaltyProgramID>
    <CollectedForActivationDeposit>true</CollectedForActivationDeposit>
    <BillPaymentGUID>9180ebe8-56c8-1164-45eb-eefe55770651</BillPaymentGUID>
    <InvoiceComments>Paid</InvoiceComments>
  </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
BillPaymentTransactionID,VendorDepositID,SaleInvoiceId,BillPaymentTransactionIDByStore,BillPaymentProviderID,TrackingNumber,PaymentAmount,RoundingAmount,VendorDepositCalculatedFee,VRPCalculatedFee,NSPCalculatedFee,SummarizedTaxesAmount,ChangeAmount,WebsiteLaunched,Comments,CreationDate,CreationEmployeeID,CreationStoreID,TerminalID,CustomerId,OriginalBPTransactionID,CustomerSignature,CustomerSignatureType,BillPaymentBillName,SignatureCaptured,ReferenceNumber,MerchantNumber,LoyaltyProgramID,BillPayValueTaxesAmount,SaleInvoiceAndLoyaltyProgramID,CollectedForActivationDeposit,BillPaymentGUID,InvoiceComments
24525,24759,2,TALLABP2386,34,15123125126,25,0,0,0,0,0,0,false,Paid,2015-01-16T14:58:05.597,4063,6910,0,13699,13452,/////zy00lQpAAAABgAAACrZvlCja3x3yxkvc5w,0,,false,213,102705,e2ccd371-85f3-76a7-910a-5c814557836b,0,bc81b551-d525-efa0-e1f3-0520f9f509a7,true,9180ebe8-56c8-1164-45eb-eefe55770651,Paid

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 the Workstation Payment Audit Report

This is a Carrier-specific request.

Definition

GET /Misc/workstationPaymentAudit?CompanyID={CompanyID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /Misc/workstationPaymentAudit?CompanyID=22575
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

WorkstationPaymentAuditData

Example Response (Default)

HTTP 200 Content-Type: application/json
{
    "DoingBusinessAs": "KENTEL Corp",
    "DatabaseName": "KENTEL",
    "Version": " 6.2.150.6453",
    "StoreName": "84 West",
    "Address": " 123 W Main St",
    "City": "Dallas",
    "State": "TX",
    "Country": "United States",
    "ZipPostal": "55555",
    "PhoneNumber": "5555555555",
    "DealerCode": "5HYH7",
    "MachineName": "PC-512",
    "DeviceType": "iSC250",
    "PPEnabled": "Yes",
    "LastModified": "2017-03-28T15:16:58.313",
    "TransactionCount": 5,
    "LastTransactionDate": "2017-04-21T21:02:46.657"
}

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "DoingBusinessAs": "KENTEL Corp",
    "DatabaseName": "KENTEL",
    "Version": " 6.2.150.6453",
    "StoreName": "84 West",
    "Address": " 123 W Main St",
    "City": "Dallas",
    "State": "TX",
    "Country": "United States",
    "ZipPostal": "55555",
    "PhoneNumber": "5555555555",
    "DealerCode": "5HYH7",
    "MachineName": "PC-512",
    "DeviceType": "iSC250",
    "PPEnabled": "Yes",
    "LastModified": "2017-03-28T15:16:58.313",
    "TransactionCount": 5,
    "LastTransactionDate": "2017-04-21T21:02:46.657"
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <DoingBusinessAs>KENTEL Corp</DoingBusinessAs>
    <DatabaseName>KENTEL</DatabaseName>
    <Version> 6.2.150.6453</Version>
    <StoreName>84 West</StoreName>
    <Address> 123 W Main St</Address>
    <City>Dallas</City>
    <State>TX</State>
    <Country>United States</Country>
    <ZipPostal>55555</ZipPostal>
    <PhoneNumber>5555555555</PhoneNumber>
    <DealerCode>5HYH7</DealerCode>
    <MachineName>PC-512</MachineName>
    <DeviceType>iSC250</DeviceType>
    <PPEnabled>Yes</PPEnabled>
    <LastModified>2017-03-28T15:16:58.313</LastModified>
    <TransactionCount>5</TransactionCount>
    <LastTransactionDate>2017-04-21T21:02:46.657</LastTransactionDate>
  </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
DoingBusinessAs,DatabaseName,Version,StoreName,Address,City,State,Country,ZipPostal,PhoneNumber,DealerCode,MachineName,DeviceType,PPEnabled,LastModified,TransactionCount,LastTransactionDate
KENTEL Corp,KENTEL, 6.2.150.6453,84 West, 123 W Main St,Dallas,TX,United States,55555,5555555555,5HYH7,PC-512,iSC250,Yes,2017-03-28T15:16:58.313,5,2017-04-21T21:02:46.657

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 Tokan 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
Was this page helpful?