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.

ENDPOINTS

RESOURCES

ActivationGrossProfitExtendedReportData

[
    {
        "InvoiceDate": "2016-12-22T16:17:07.557",
        "Invoice": "84WEAIN17137",
        "LocationName": "84 West",
        "LocationID": 1,
        "Profit": 114.99,
        "CustomerName": "John Smith",
        "PhoneDescription": "iPhone 6 Plus 16GB - Gold",
        "SerialNumber": "70000000000090",
        "PhoneNumber": "5555555555",
        "TermDescription": "2 YR Upgrade $69.99 - $89.98",
        "RatePlanDescription": "Act $69.99 to $89.98",
        "VendorAccountName": "Verizon 2",
        "EmployeeName": "iQmetrix.Employee",
        "UserName": "iQmetrix.Employee",
        "DistrictName": "Valley Area District",
        "RegionName": "Region A",
        "ChannelName": "Regina Channel",
        "LocationType": "Retail Store",
        "CustomerAcctNum": "C89555",
        "CustomerRSA": "",
        "OrigPurchAmt": 214.99,
        "BalanceToBeBilled": 0,
        "NumBillingPrds": 0,
        "BilltoAccount": true
    }
]
Name Description
InvoiceDate (DateTime) Invoice date
Invoice (VARCHAR(14)) Invoice # in RQ
LocationName (NVARCHAR(MAX)) Store name
LocationID (INT) Identifier for a Location
Profit (MONEY) Profit
CustomerName (VARCHAR(151)) Customer name
PhoneDescription (NVARCHAR(MAX)) Phone
SerialNumber (VARCHAR(100)) Serial number
PhoneNumber (VARCHAR(30)) Mobile number
TermDescription (NVARCHAR(MAX)) Term
RatePlanDescription (NVARCHAR(MAX)) Rate plan description
VendorAccountName (VARCHAR(100)) Vendor account
EmployeeName (VARCHAR(51)) Employee name
UserName (VARCHAR(51)) Employee user name
DistrictName (NVARCHAR(MAX)) District
RegionName (NVARCHAR(MAX)) Region
ChannelName (NVARCHAR(MAX)) Channel
LocationType (NVARCHAR(MAX)) Location type
CustomerAcctNum (VARCHAR(30)) Customer account number
CustomerRSA (VARCHAR(25)) Customer RSA
OrigPurchAmt (MONEY) Original purchase amount
BalanceToBeBilled (DECIMAL) Balance to be billed
NumBillingPrds (INT) Number of billing periods
BilltoAccount (BIT) Bill to account, a nullable boolean value

GLAccountsAndCategoriesReportData

[
    {
        "TransactionID": 1258877,
        "AccountID": 8,
        "StoreID": 34,
        "Debit": 0,
        "Credit": 15,
        "DateCreated": "2016-01-04T11:00:48.25",
        "DateCreatedAtMidnight": "2016-01-04T00:00:00",
        "GMTDate": "2016-01-04T17:00:48.25",
        "SourceType": 2,
        "SourceID": 126520,
        "SourceIDByStore": "TOTLIIN138",
        "Comments": "",
        "Exported": false,
        "TerminalID": 0,
        "InvoiceEditedDate": "2016-01-04T11:00:48.25",
        "ExtraData": "",
        "TaxID": 1,
        "SourceGUID": "bb6fe8f1-311e-8efa-d8ef-b80738b0ae41",
        "TaxTableType": 1,
        "RowThumbprint": "b586d384-2ca8-5a61-67f7-4effc82c20a3",
        "RowInserted": "2016-01-04T11:00:48.25",
        "RowUpdated": "2016-01-04T11:00:48.25",
        "IntegratedTaxGUID": "cf1caf02-f7d6-3219-a0ed-019e122a4a7e",
        "AccountName": "Updated_July20_update1",
        "CategoryName": "Income",
        "Enabled": false
    }
]
Name Description
TransactionID (BIGINT) Internal identifier of the transaction in RQ
AccountID (INT) Internal identifier of the account in RQ
StoreID (INT) Internal identifier of the store in RQ
Debit (MONEY) Debit
Credit (MONEY) Credit
DateCreated (DateTime) Created date
DateCreatedAtMidnight (DateTime) Midnight of created date
GMTDate (DateTime) Date created in GMT
SourceType (TINYINT) Indicates what the SourceIDByStore represents. See Get Source Types
SourceID (INT) Internal identifier in RQ
SourceIDByStore (VARCHAR(14)) Identifier in RQ for the transaction that entered GL
Comments (VARCHAR(100)) Comments
Exported (BIT) A flag to indicate if exported
TerminalID (INT) Internal identifier of a terminal in RQ
InvoiceEditedDate (DateTime) Date the invoice was last edited
ExtraData (VARCHAR(100)) Extra data
TaxID (INT) Internal identifier in RQ
SourceGUID (UNIQUEIDENTIFIER) Internal identifier in RQ
TaxTableType (TINYINT) Internal identifier in RQ
RowThumbprint (UNIQUEIDENTIFIER) Internal identifier in RQ
RowInserted (DateTime) Internal value in RQ
RowUpdated (DateTime) Internal value in RQ
IntegratedTaxGUID (UNIQUEIDENTIFIER) Internal identifier in RQ
AccountName (VARCHAR(100)) Account name
CategoryName (VARCHAR(30)) Account category name
Enabled (BIT) A flag to indicate if the account is enabled

GlobalProductsAndVendorsReportData

[
    {
        "GlobalProductID": 11168,
        "ProductIdentifier": "AAATAP000111",
        "CategoryNumber": "101027101210",
        "Description": "Amber Phone",
        "Enabled": true,
        "Discountable": false,
        "Refundable": true,
        "FloorPrice": 0,
        "MaxPrice": 99,
        "VendorID": 3,
        "VendorPartNumber": "",
        "VendorName": "Brightpoint"
    }
]
Name Description
GlobalProductID (INT) Internal identifier for a product in RQ
ProductIdentifier (VARCHAR(12)) Product SKU
CategoryNumber (VARCHAR(100)) Category number in RQ
Description (NVARCHAR(MAX)) Description
Enabled (BIT) A flag to indicate if the product is enabled
Discountable (BIT) A flag to indicate if the product is discountable
Refundable (BIT) A flag to indicate if the product is refundable
FloorPrice (MONEY) Floor price
MaxPrice (MONEY) Max price
VendorID (INT) Internal identifier for a vendor in RQ
VendorPartNumber (VARCHAR(25)) Vendor part number
VendorName (NVARCHAR(MAX)) Vendor name

ReceivingAndProductsReportData

[
    {
        "ReceivingID": 17250,
        "ReceivingIDByStore": "WETUMRE772",
        "PurchaseOrderID": 18486,
        "ReceiverStoreID": 9,
        "VendorInvoiceNumber": "1",
        "ExtraCosts": 0,
        "Comments": "",
        "DateReceived": "2016-08-02T14:29:04.69",
        "Posted": false,
        "GlobalProductID": 11168,
        "SerialNumber": "70000000000090",
        "UnitCost": 660,
        "Quantity": 1,
        "DateCreated": "2016-08-02T14:29:23.46"
    }
]
Name Description
ReceivingID (INT) Internal identifier of the receiving invoice in RQ
ReceivingIDByStore (VARCHAR(14)) Identifier of the receiving invoice in RQ
PurchaseOrderID (INT) Internal identifier of the purchase order in RQ
ReceiverStoreID (INT) Internal identifier of the receiving store in RQ
VendorInvoiceNumber (VARCHAR(20)) Vendor invoice number
ExtraCosts (MONEY) Extra costs
Comments (VARCHAR(500)) Comments
DateReceived (DateTime) Date received
Posted (BIT) A flag to indicate if posted
GlobalProductID (INT) Internal identifier for a product in RQ
SerialNumber (VARCHAR(100)) Serial number
UnitCost (MONEY) Unit cost
Quantity (INT) Quantity
DateCreated (DateTime) Created date

SalesExtendedDetailReportData

[
    {
        "ChannelName": "English Channel",
        "Cost": 14.5,
        "CustomerID": 85259,
        "CustomerName": "John Tester",
        "DateCreated": "2016-06-07T16:17:36.643",
        "EmployeeID": 3302,
        "EmployeeName": "iQmetrix Employee",
        "InvoiceNumber": "77123IN1",
        "LineID": 1,
        "Price": 29.99,
        "ProductSKU": "ASLCAP000089",
        "Quantity": 1,
        "RQPriority": 1,
        "SerialNumber": "2222222",
        "StoreID": 6680,
        "StoreName": "100: Pair Up Wireless LLC - Garland",
        "SpecialProductID": 2
    }
]
Name Description
ChannelName (NVARCHAR(MAX)) Name of a Channel in RQ
Cost (MONEY) Cost
CustomerID (INTEGER) Identifier of a customer in RQ
CustomerName (VARCHAR(101)) Name of a customer in RQ
DateCreated (DateTime) Sale date
EmployeeID (INTEGER) Identifier of an employee in RQ
EmployeeName (VARCHAR(51)) Name of an employee in RQ
InvoiceNumber (VARCHAR(14)) Invoice number
LineID (BIGINT)  
Price (MONEY) Price
ProductSKU (VARCHAR(32)) Product SKU
Quantity (INTEGER) Quantity
RQPriority (INTEGER)  
SerialNumber (VARCHAR (100) ) Serial number
StoreID (INTEGER) Identifier for a store in RQ
StoreName (NVARCHAR(MAX)) Name of a store in RQ
SpecialProductID (INTEGER) Acceptable values include 0 for Regular Product, 1 for Vendor Rebate, 2 for Non-Stocked Product, 3 for Gift Card, 4 for Non Revenue Product

SaleInvoicesAndProductsReportData

[
    {
        "DateCreatedAtMidnight": "2016-01-04T00:00:00",
        "SaleInvoiceID": 132469,
        "InvoiceIDByStore": "REDSTIN1397",
        "StoreID1": 13,
        "StoreID2": 13,
        "CustomerID1": 60187,
        "EmployeeID1": 3522,
        "EmployeeID2": 0,
        "EmployeeID3": 3522,
        "GlobalProductID": 11168,
        "SerialNumber": "001",
        "Priority": 1,
        "Quantity": 1,
        "UnitPrice": 5,
        "UnitCost": 0,
        "ListPrice": 400,
        "AssociationNumber": 1,
        "OriginalUnitPrice": 5,
        "AdjustedUnitCost": 1,
        "IsOldest": true,
        "ReceivedDate": "2016-12-28T17:32:07.05",
        "DaysOnHand": 0,
        "QtyInStock": 35,
        "MobileNumber": "4036473061",
        "ActivationAssociationNumber": 1,
        "ManufacturerID": 27,
        "ManufacturerPartNumber": ""
    }
]
Name Description
DateCreatedAtMidnight (DateTime) Midnight of created date
SaleInvoiceID (INT) Internal identifier for an invoice in RQ
InvoiceIDByStore (VARCHAR(14)) Identifier for an invoice in RQ
StoreID1 (INT) Internal identifier for a store in RQ
StoreID2 (INT) Internal identifier for a store in RQ
CustomerID1 (INT) Internal identifier for a customer in RQ
EmployeeID1 (INT) Internal identifier for an employee in RQ
EmployeeID2 (INT) Internal identifier for an employee in RQ
EmployeeID3 (INT) Internal identifier for an employee in RQ
GlobalProductID (INT) Internal identifier for a product in RQ
SerialNumber (VARCHAR(100)) Serial number
Priority (INT) Priority
Quantity (INT) Quantity
UnitPrice (MONEY) Unit price
UnitCost (MONEY) Unit cost
ListPrice (MONEY) List price
AssociationNumber (SMALLINT) Association number
OriginalUnitPrice (MONEY) Original unit price
AdjustedUnitCost (MONEY) Adjusted unit cost
IsOldest (BIT) A flag used for sorting
ReceivedDate (DateTime) Recieved date, in UTC
DaysOnHand (INT) Days on hand
QtyInStock (INT) Quantity in stock
MobileNumber (VARCHAR(30)) Phone number
ActivationAssociationNumber (SMALLINT) Activation association number
ManufacturerID (INT) Internal identifier for a manufacturer in RQ
ManufacturerPartNumber (VARCHAR(50)) Manufacturer part number

SecurityAuditReportPivotData

This resource will include every security role in your RQ database.

[
    {
        "ModuleName": "A/R: A/R Master List",
        "SecurityRoleName": "No Access"
    }
]
Name Description
ModuleName (VARCHAR(MAX)) Name of a security module in RQ
SecurityRoleName (VARCHAR(MAX)) Access for the given security role for this security module

SecurityAuditReportData

[
    {
        "RoleDescription": "Administrator",
        "ModuleName": "Inventory: Starting Inventory Count Import",
        "SecurityLevel": "Full Access"
    }
]
Name Description
RoleDescription (NVARCHAR(MAX)) Name of a role in RQ
ModuleName (VARCHAR(MAX)) Name of a security module in RQ
SecurityLevel (VARCHAR(MAX)) Security level for the module (ModuleName) for a security role (RoleDescription)

SourceType

[
    {
        "GL_SourceType": 1,
        "GP_SourceTypeName": "Opening Balance"
    }
]
Name Description
GL_SourceType (INT) Identifier
GP_SourceTypeName (NVARCHAR(50)) Source Type

RMAHistoryProductExtendedReportData

[
    {
        "StockBalanceID": 1147,
        "StockBalanceIDByStore": "84WEASB12",
        "RMANumber": "1234",
        "DateCreated": "2015-07-22T15:16:16.007",
        "VendorName": "Offwire",
        "StoreName": "84 West",
        "DistrictName": "Valley Area District",
        "RegionName": "Region A",
        "ChannelName": "Regina Channel",
        "ProductIdentifier": "ASHCSA000120",
        "ProductName": "Samsung Galaxy Rugby LTE",
        "SerialNumberRemoved": "990000926066533",
        "SerialNumberAdded": "",
        "Quantity": 1,
        "UnitCost": 198,
        "TotalCost": 699,
        "UnitCostCredited": 459,
        "TotalCostCredited": 459,
        "VendorInvoiceNumber": "",
        "VendorPartNumber": "",
        "DateShipped": "2011-06-02T09:41:08.027",
        "EmployeeName1": "Skip Davis",
        "DateReceived": "2012-08-01T15:05:37.65",
        "EmployeeName2": "Skip Davis",
        "ActionTaken": 1
    }
]
Name Description
StockBalanceID (INT) Internal identifier for a RMA in RQ
StockBalanceIDByStore (VARCHAR(14)) Identifier for an RMA in RQ
RMANumber (VARCHAR(15)) RMA # - Number assigned to the RMA by RQ
DateCreated (DateTime) Creaed date
VendorName (NVARCHAR(MAX)) Vendor
StoreName (NVARCHAR(MAX)) Name of a store in RQ
DistrictName (NVARCHAR(MAX)) Name of a district in RQ
RegionName (NVARCHAR(MAX)) Name of a region in RQ
ChannelName (NVARCHAR(MAX)) Name of a channel in RQ
ProductIdentifier (VARCHAR(12)) Product SKU - the RQ generated SKU
ProductName (NVARCHAR(MAX)) Product Name - name of the product as it appears in the inventory
SerialNumberRemoved (VARCHAR(100)) Tracking # Shipped - tracking number shipped from inventory
SerialNumberAdded (VARCHAR(100)) Tracking # Received - tracking number received as replacement
Quantity (INT) Qty - total number of that product SKU on the purchase order
UnitCost (MONEY) Unit Cost - purchase cost per unit sent away on RMA; weighted average cost for non-serialized products and true cost for serialized products, click Inventory Valuation in RQ for more information
TotalCost (MONEY) Total Cost - Quantity X Unit Cost
UnitCostCredited (MONEY) Unit Cost Credited - dollar amount of the credit granted by the vendor per unit
TotalCostCredited (MONEY) Total Cost Credited - dollar amount credited by vendor for products on the RMA
VendorInvoiceNumber (VARCHAR (20)) Vendor Invoice # - invoice number assigned by the vendor for the purchase order
VendorPartNumber (VARCHAR (25)) RMA Vendor SKU - SKU assigned by the RMA Vendor
DateShipped (DateTime) Shipped On - date the item(s) was shipped
EmployeeName1 (VARCHAR(51)) Shipped By - name of the employee logged into RQ when the RMA was shipped
DateReceived (DateTime) Received On - date and time the RMA was received
EmployeeName2 (VARCHAR(51)) Received By - name of the employee logged into RQ when the RMA was received
ActionTaken (TINYINT) Type - indicated the type of RMA: Not Set (0), Credit (1), Replacement (2), Rejected (3) or Repaired (4)

SerializedInventoryAvailabilityDetailReportData

[
    {
        "SerialNumber": "4865416516",
        "isInStock": true,
        "LocationID": 112482,
        "StoreName": "Regina Store",
        "RetailerCatalogID": "e45b0a48-4111-0689-314d-197ae7acbf83",
        "ModelName": "Galaxy S4 16GB - Black",
        "ModelRemarks": "Smartphones",
        "WarrantyUnit": "",
        "WarrantyValue": 100,
        "Manufacturer": "Samsung",
        "MSRPAmount": 649,
        "MSRPCurrencyCode": "USD"
    }
]
Name Description
SerialNumber (VARCHAR(100)) Serial Number
isInStock (BIT) A flag to indicate if product is in stock
LocationID (INT) Identifier for a Location
StoreName (NVARCHAR(MAX)) Name of a store in RQ
RetailerCatalogID (UNIQUEIDENTIFIER) Identifier for a CatalogItem
ModelName (NVARCHAR(MAX)) Product model name
ModelRemarks (NVARCHAR(MAX)) Classification
WarrantyUnit (NVARCHAR(MAX)) Warranty unit
WarrantyValue (INT) Warranty value
Manufacturer (NVARCHAR(MAX)) Manufacturer name
MSRPAmount (MONEY) MSRP amount
MSRPCurrencyCode (NVARCHAR(MAX)) MSRP currency

PaymentIntegrationSummaryReportData

[
    {
        "LocationID": 48572,
        "StoreName": "Manchester City",
        "Terminals": 2,
        "Transactions": 11,
        "ManualEntries": 8
    }
]
Name Description
LocationID (INT) Identifier for a Location in Entity Store
StoreName (NVARCHAR(255)) Name of a store in RQ
Terminals (INT) Number of terminals
Transactions (INT) Number of transactions
ManualEntries (INT) Number of manual entries

REQUESTS

GET the Sales Extended Detail Report

Definition

GET /customizedreports/SalesExtendedDetailReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&DatePercision={DatePercision}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /customizedreports/SalesExtendedDetailReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[SalesExtendedDetailReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ChannelName": "English Channel",
        "Cost": 14.5,
        "CustomerID": 85259,
        "CustomerName": "John Tester",
        "DateCreated": "2016-06-07T16:17:36.643",
        "EmployeeID": 3302,
        "EmployeeName": "iQmetrix Employee",
        "InvoiceNumber": "77123IN1",
        "LineID": 1,
        "Price": 29.99,
        "ProductSKU": "ASLCAP000089",
        "Quantity": 1,
        "RQPriority": 1,
        "SerialNumber": "2222222",
        "StoreID": 6680,
        "StoreName": "100: Pair Up Wireless LLC - Garland",
        "SpecialProductID": 2
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ChannelName": "English Channel",
            "Cost": 14.5,
            "CustomerID": 85259,
            "CustomerName": "John Tester",
            "DateCreated": "2016-06-07T16:17:36.643",
            "EmployeeID": 3302,
            "EmployeeName": "iQmetrix Employee",
            "InvoiceNumber": "77123IN1",
            "LineID": 1,
            "Price": 29.99,
            "ProductSKU": "ASLCAP000089",
            "Quantity": 1,
            "RQPriority": 1,
            "SerialNumber": "2222222",
            "StoreID": 6680,
            "StoreName": "100: Pair Up Wireless LLC - Garland",
            "SpecialProductID": 2
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ChannelName>English Channel</ChannelName>
    <Cost>14.5</Cost>
    <CustomerID>85259</CustomerID>
    <CustomerName>John Tester</CustomerName>
    <DateCreated>2016-06-07T16:17:36.643</DateCreated>
    <EmployeeID>3302</EmployeeID>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <InvoiceNumber>77123IN1</InvoiceNumber>
    <LineID>1</LineID>
    <Price>29.99</Price>
    <ProductSKU>ASLCAP000089</ProductSKU>
    <Quantity>1</Quantity>
    <RQPriority>1</RQPriority>
    <SerialNumber>2222222</SerialNumber>
    <StoreID>6680</StoreID>
    <StoreName>100: Pair Up Wireless LLC - Garland</StoreName>
    <SpecialProductID>2</SpecialProductID>
  </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
ChannelName,Cost,CustomerID,CustomerName,DateCreated,EmployeeID,EmployeeName,InvoiceNumber,LineID,Price,ProductSKU,Quantity,RQPriority,SerialNumber,StoreID,StoreName,SpecialProductID
English Channel,14.5,85259,John Tester,2016-06-07T16:17:36.643,3302,iQmetrix Employee,77123IN1,1,29.99,ASLCAP000089,1,1,2222222,6680,100: Pair Up Wireless LLC - Garland,2

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 Sale Invoices and Products Report

Definition

GET /customizedreports/SaleInvoicesAndProductsReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreID={StoreID}&EmployeeID={EmployeeID}&CustomerID={CustomerID}&ManufactureID={ManufactureID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /customizedreports/SaleInvoicesAndProductsReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreID=1&EmployeeID=2&CustomerID=52&ManufactureID=5
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/customizedreports/SaleInvoicesAndProductsReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreID=1&EmployeeID=2&CustomerID=52&ManufactureID=5" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheSaleInvoicesAndProductsReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/customizedreports/SaleInvoicesAndProductsReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreID=1&EmployeeID=2&CustomerID=52&ManufactureID=5");
    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 GettingTheSaleInvoicesAndProductsReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/customizedreports/SaleInvoicesAndProductsReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreID=1&EmployeeID=2&CustomerID=52&ManufactureID=5");
     
    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/customizedreports/SaleInvoicesAndProductsReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&StoreID=1&EmployeeID=2&CustomerID=52&ManufactureID=5', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SaleInvoicesAndProductsReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "DateCreatedAtMidnight": "2016-01-04T00:00:00",
        "SaleInvoiceID": 132469,
        "InvoiceIDByStore": "REDSTIN1397",
        "StoreID1": 13,
        "StoreID2": 13,
        "CustomerID1": 60187,
        "EmployeeID1": 3522,
        "EmployeeID2": 0,
        "EmployeeID3": 3522,
        "GlobalProductID": 11168,
        "SerialNumber": "001",
        "Priority": 1,
        "Quantity": 1,
        "UnitPrice": 5,
        "UnitCost": 0,
        "ListPrice": 400,
        "AssociationNumber": 1,
        "OriginalUnitPrice": 5,
        "AdjustedUnitCost": 1,
        "IsOldest": true,
        "ReceivedDate": "2016-12-28T17:32:07.05",
        "DaysOnHand": 0,
        "QtyInStock": 35,
        "MobileNumber": "4036473061",
        "ActivationAssociationNumber": 1,
        "ManufacturerID": 27,
        "ManufacturerPartNumber": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "DateCreatedAtMidnight": "2016-01-04T00:00:00",
            "SaleInvoiceID": 132469,
            "InvoiceIDByStore": "REDSTIN1397",
            "StoreID1": 13,
            "StoreID2": 13,
            "CustomerID1": 60187,
            "EmployeeID1": 3522,
            "EmployeeID2": 0,
            "EmployeeID3": 3522,
            "GlobalProductID": 11168,
            "SerialNumber": "001",
            "Priority": 1,
            "Quantity": 1,
            "UnitPrice": 5,
            "UnitCost": 0,
            "ListPrice": 400,
            "AssociationNumber": 1,
            "OriginalUnitPrice": 5,
            "AdjustedUnitCost": 1,
            "IsOldest": true,
            "ReceivedDate": "2016-12-28T17:32:07.05",
            "DaysOnHand": 0,
            "QtyInStock": 35,
            "MobileNumber": "4036473061",
            "ActivationAssociationNumber": 1,
            "ManufacturerID": 27,
            "ManufacturerPartNumber": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <DateCreatedAtMidnight>2016-01-04T00:00:00</DateCreatedAtMidnight>
    <SaleInvoiceID>132469</SaleInvoiceID>
    <InvoiceIDByStore>REDSTIN1397</InvoiceIDByStore>
    <StoreID1>13</StoreID1>
    <StoreID2>13</StoreID2>
    <CustomerID1>60187</CustomerID1>
    <EmployeeID1>3522</EmployeeID1>
    <EmployeeID2>0</EmployeeID2>
    <EmployeeID3>3522</EmployeeID3>
    <GlobalProductID>11168</GlobalProductID>
    <SerialNumber>001</SerialNumber>
    <Priority>1</Priority>
    <Quantity>1</Quantity>
    <UnitPrice>5</UnitPrice>
    <UnitCost>0</UnitCost>
    <ListPrice>400</ListPrice>
    <AssociationNumber>1</AssociationNumber>
    <OriginalUnitPrice>5</OriginalUnitPrice>
    <AdjustedUnitCost>1</AdjustedUnitCost>
    <IsOldest>true</IsOldest>
    <ReceivedDate>2016-12-28T17:32:07.05</ReceivedDate>
    <DaysOnHand>0</DaysOnHand>
    <QtyInStock>35</QtyInStock>
    <MobileNumber>4036473061</MobileNumber>
    <ActivationAssociationNumber>1</ActivationAssociationNumber>
    <ManufacturerID>27</ManufacturerID>
    <ManufacturerPartNumber></ManufacturerPartNumber>
  </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
DateCreatedAtMidnight,SaleInvoiceID,InvoiceIDByStore,StoreID1,StoreID2,CustomerID1,EmployeeID1,EmployeeID2,EmployeeID3,GlobalProductID,SerialNumber,Priority,Quantity,UnitPrice,UnitCost,ListPrice,AssociationNumber,OriginalUnitPrice,AdjustedUnitCost,IsOldest,ReceivedDate,DaysOnHand,QtyInStock,MobileNumber,ActivationAssociationNumber,ManufacturerID,ManufacturerPartNumber
2016-01-04T00:00:00,132469,REDSTIN1397,13,13,60187,3522,0,3522,11168,001,1,1,5,0,400,1,5,1,true,2016-12-28T17:32:07.05,0,35,4036473061,1,27,

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 Global Products and Vendors Report

Definition

GET /customizedreports/GlobalProductsAndVendorsReport?LanguageCode={LanguageCode}&ProductIdentifier={ProductIdentifier}&CategoryNumber={CategoryNumber}&Enabled={Enabled}&Refundable={Refundable}&VendorID={VendorID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /customizedreports/GlobalProductsAndVendorsReport?LanguageCode=en-us&ProductIdentifier=ASCLMO000001&CategoryNumber=10&Enabled=true&Refundable=true&VendorID=51
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/customizedreports/GlobalProductsAndVendorsReport?LanguageCode=en-us&ProductIdentifier=ASCLMO000001&CategoryNumber=10&Enabled=true&Refundable=true&VendorID=51" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheGlobalProductsAndVendorsReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/customizedreports/GlobalProductsAndVendorsReport?LanguageCode=en-us&ProductIdentifier=ASCLMO000001&CategoryNumber=10&Enabled=true&Refundable=true&VendorID=51");
    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 GettingTheGlobalProductsAndVendorsReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/customizedreports/GlobalProductsAndVendorsReport?LanguageCode=en-us&ProductIdentifier=ASCLMO000001&CategoryNumber=10&Enabled=true&Refundable=true&VendorID=51");
     
    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/customizedreports/GlobalProductsAndVendorsReport?LanguageCode=en-us&ProductIdentifier=ASCLMO000001&CategoryNumber=10&Enabled=true&Refundable=true&VendorID=51', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GlobalProductsAndVendorsReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "GlobalProductID": 11168,
        "ProductIdentifier": "AAATAP000111",
        "CategoryNumber": "101027101210",
        "Description": "Amber Phone",
        "Enabled": true,
        "Discountable": false,
        "Refundable": true,
        "FloorPrice": 0,
        "MaxPrice": 99,
        "VendorID": 3,
        "VendorPartNumber": "",
        "VendorName": "Brightpoint"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "GlobalProductID": 11168,
            "ProductIdentifier": "AAATAP000111",
            "CategoryNumber": "101027101210",
            "Description": "Amber Phone",
            "Enabled": true,
            "Discountable": false,
            "Refundable": true,
            "FloorPrice": 0,
            "MaxPrice": 99,
            "VendorID": 3,
            "VendorPartNumber": "",
            "VendorName": "Brightpoint"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <GlobalProductID>11168</GlobalProductID>
    <ProductIdentifier>AAATAP000111</ProductIdentifier>
    <CategoryNumber>101027101210</CategoryNumber>
    <Description>Amber Phone</Description>
    <Enabled>true</Enabled>
    <Discountable>false</Discountable>
    <Refundable>true</Refundable>
    <FloorPrice>0</FloorPrice>
    <MaxPrice>99</MaxPrice>
    <VendorID>3</VendorID>
    <VendorPartNumber></VendorPartNumber>
    <VendorName>Brightpoint</VendorName>
  </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,CategoryNumber,Description,Enabled,Discountable,Refundable,FloorPrice,MaxPrice,VendorID,VendorPartNumber,VendorName
11168,AAATAP000111,101027101210,Amber Phone,true,false,true,0,99,3,,Brightpoint

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 Receiving and Products Report

Definition

GET /customizedreports/ReceivingAndProductsReport?ReceivingID={ReceivingID}&ReceivingIDByStore={ReceivingIDByStore}&PurchaseOrderID={PurchaseOrderID}&ReceiverStoreID={ReceiverStoreID}&VendorInvoiceNumber={VendorInvoiceNumber}&StartDateReceived={StartDateReceived}&StopDateReceived={StopDateReceived}&StartDateCreated={StartDateCreated}&StopDateCreated={StopDateCreated}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /customizedreports/ReceivingAndProductsReport?ReceivingID=17250&ReceivingIDByStore=WETUMRE772&PurchaseOrderID=18486&ReceiverStoreID=1&VendorInvoiceNumber=BDP123&StartDateReceived=1970-01-01T06:00:00.000Z&StopDateReceived=2016-01-01T06:00:00.000Z&StartDateCreated=1970-01-01T06:00:00.000Z&StopDateCreated=2016-01-01T06:00:00.000Z
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/customizedreports/ReceivingAndProductsReport?ReceivingID=17250&ReceivingIDByStore=WETUMRE772&PurchaseOrderID=18486&ReceiverStoreID=1&VendorInvoiceNumber=BDP123&StartDateReceived=1970-01-01T06:00:00.000Z&StopDateReceived=2016-01-01T06:00:00.000Z&StartDateCreated=1970-01-01T06:00:00.000Z&StopDateCreated=2016-01-01T06:00:00.000Z" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheReceivingAndProductsReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/customizedreports/ReceivingAndProductsReport?ReceivingID=17250&ReceivingIDByStore=WETUMRE772&PurchaseOrderID=18486&ReceiverStoreID=1&VendorInvoiceNumber=BDP123&StartDateReceived=1970-01-01T06:00:00.000Z&StopDateReceived=2016-01-01T06:00:00.000Z&StartDateCreated=1970-01-01T06:00:00.000Z&StopDateCreated=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 GettingTheReceivingAndProductsReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/customizedreports/ReceivingAndProductsReport?ReceivingID=17250&ReceivingIDByStore=WETUMRE772&PurchaseOrderID=18486&ReceiverStoreID=1&VendorInvoiceNumber=BDP123&StartDateReceived=1970-01-01T06:00:00.000Z&StopDateReceived=2016-01-01T06:00:00.000Z&StartDateCreated=1970-01-01T06:00:00.000Z&StopDateCreated=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/customizedreports/ReceivingAndProductsReport?ReceivingID=17250&ReceivingIDByStore=WETUMRE772&PurchaseOrderID=18486&ReceiverStoreID=1&VendorInvoiceNumber=BDP123&StartDateReceived=1970-01-01T06:00:00.000Z&StopDateReceived=2016-01-01T06:00:00.000Z&StartDateCreated=1970-01-01T06:00:00.000Z&StopDateCreated=2016-01-01T06:00:00.000Z', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ReceivingAndProductsReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ReceivingID": 17250,
        "ReceivingIDByStore": "WETUMRE772",
        "PurchaseOrderID": 18486,
        "ReceiverStoreID": 9,
        "VendorInvoiceNumber": "1",
        "ExtraCosts": 0,
        "Comments": "",
        "DateReceived": "2016-08-02T14:29:04.69",
        "Posted": false,
        "GlobalProductID": 11168,
        "SerialNumber": "70000000000090",
        "UnitCost": 660,
        "Quantity": 1,
        "DateCreated": "2016-08-02T14:29:23.46"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ReceivingID": 17250,
            "ReceivingIDByStore": "WETUMRE772",
            "PurchaseOrderID": 18486,
            "ReceiverStoreID": 9,
            "VendorInvoiceNumber": "1",
            "ExtraCosts": 0,
            "Comments": "",
            "DateReceived": "2016-08-02T14:29:04.69",
            "Posted": false,
            "GlobalProductID": 11168,
            "SerialNumber": "70000000000090",
            "UnitCost": 660,
            "Quantity": 1,
            "DateCreated": "2016-08-02T14:29:23.46"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ReceivingID>17250</ReceivingID>
    <ReceivingIDByStore>WETUMRE772</ReceivingIDByStore>
    <PurchaseOrderID>18486</PurchaseOrderID>
    <ReceiverStoreID>9</ReceiverStoreID>
    <VendorInvoiceNumber>1</VendorInvoiceNumber>
    <ExtraCosts>0</ExtraCosts>
    <Comments></Comments>
    <DateReceived>2016-08-02T14:29:04.69</DateReceived>
    <Posted>false</Posted>
    <GlobalProductID>11168</GlobalProductID>
    <SerialNumber>70000000000090</SerialNumber>
    <UnitCost>660</UnitCost>
    <Quantity>1</Quantity>
    <DateCreated>2016-08-02T14:29:23.46</DateCreated>
  </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
ReceivingID,ReceivingIDByStore,PurchaseOrderID,ReceiverStoreID,VendorInvoiceNumber,ExtraCosts,Comments,DateReceived,Posted,GlobalProductID,SerialNumber,UnitCost,Quantity,DateCreated
17250,WETUMRE772,18486,9,1,0,,2016-08-02T14:29:04.69,false,11168,70000000000090,660,1,2016-08-02T14:29:23.46

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 GL Accounts and Categories Report

Definition

GET /customizedreports/GLAccountsAndCategoriesReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&AccountName={AccountName}&CategoryName={CategoryName}&Enabled={Enabled}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /customizedreports/GLAccountsAndCategoriesReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&AccountName=Returns_July_2017&CategoryName=Income&Enabled=false
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/customizedreports/GLAccountsAndCategoriesReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&AccountName=Returns_July_2017&CategoryName=Income&Enabled=false" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheGlAccountsAndCategoriesReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/customizedreports/GLAccountsAndCategoriesReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&AccountName=Returns_July_2017&CategoryName=Income&Enabled=false");
    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 GettingTheGlAccountsAndCategoriesReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/customizedreports/GLAccountsAndCategoriesReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&AccountName=Returns_July_2017&CategoryName=Income&Enabled=false");
     
    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/customizedreports/GLAccountsAndCategoriesReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&AccountName=Returns_July_2017&CategoryName=Income&Enabled=false', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GLAccountsAndCategoriesReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "TransactionID": 1258877,
        "AccountID": 8,
        "StoreID": 34,
        "Debit": 0,
        "Credit": 15,
        "DateCreated": "2016-01-04T11:00:48.25",
        "DateCreatedAtMidnight": "2016-01-04T00:00:00",
        "GMTDate": "2016-01-04T17:00:48.25",
        "SourceType": 2,
        "SourceID": 126520,
        "SourceIDByStore": "TOTLIIN138",
        "Comments": "",
        "Exported": false,
        "TerminalID": 0,
        "InvoiceEditedDate": "2016-01-04T11:00:48.25",
        "ExtraData": "",
        "TaxID": 1,
        "SourceGUID": "bb6fe8f1-311e-8efa-d8ef-b80738b0ae41",
        "TaxTableType": 1,
        "RowThumbprint": "b586d384-2ca8-5a61-67f7-4effc82c20a3",
        "RowInserted": "2016-01-04T11:00:48.25",
        "RowUpdated": "2016-01-04T11:00:48.25",
        "IntegratedTaxGUID": "cf1caf02-f7d6-3219-a0ed-019e122a4a7e",
        "AccountName": "Updated_July20_update1",
        "CategoryName": "Income",
        "Enabled": false
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "TransactionID": 1258877,
            "AccountID": 8,
            "StoreID": 34,
            "Debit": 0,
            "Credit": 15,
            "DateCreated": "2016-01-04T11:00:48.25",
            "DateCreatedAtMidnight": "2016-01-04T00:00:00",
            "GMTDate": "2016-01-04T17:00:48.25",
            "SourceType": 2,
            "SourceID": 126520,
            "SourceIDByStore": "TOTLIIN138",
            "Comments": "",
            "Exported": false,
            "TerminalID": 0,
            "InvoiceEditedDate": "2016-01-04T11:00:48.25",
            "ExtraData": "",
            "TaxID": 1,
            "SourceGUID": "bb6fe8f1-311e-8efa-d8ef-b80738b0ae41",
            "TaxTableType": 1,
            "RowThumbprint": "b586d384-2ca8-5a61-67f7-4effc82c20a3",
            "RowInserted": "2016-01-04T11:00:48.25",
            "RowUpdated": "2016-01-04T11:00:48.25",
            "IntegratedTaxGUID": "cf1caf02-f7d6-3219-a0ed-019e122a4a7e",
            "AccountName": "Updated_July20_update1",
            "CategoryName": "Income",
            "Enabled": false
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <TransactionID>1258877</TransactionID>
    <AccountID>8</AccountID>
    <StoreID>34</StoreID>
    <Debit>0</Debit>
    <Credit>15</Credit>
    <DateCreated>2016-01-04T11:00:48.25</DateCreated>
    <DateCreatedAtMidnight>2016-01-04T00:00:00</DateCreatedAtMidnight>
    <GMTDate>2016-01-04T17:00:48.25</GMTDate>
    <SourceType>2</SourceType>
    <SourceID>126520</SourceID>
    <SourceIDByStore>TOTLIIN138</SourceIDByStore>
    <Comments></Comments>
    <Exported>false</Exported>
    <TerminalID>0</TerminalID>
    <InvoiceEditedDate>2016-01-04T11:00:48.25</InvoiceEditedDate>
    <ExtraData></ExtraData>
    <TaxID>1</TaxID>
    <SourceGUID>bb6fe8f1-311e-8efa-d8ef-b80738b0ae41</SourceGUID>
    <TaxTableType>1</TaxTableType>
    <RowThumbprint>b586d384-2ca8-5a61-67f7-4effc82c20a3</RowThumbprint>
    <RowInserted>2016-01-04T11:00:48.25</RowInserted>
    <RowUpdated>2016-01-04T11:00:48.25</RowUpdated>
    <IntegratedTaxGUID>cf1caf02-f7d6-3219-a0ed-019e122a4a7e</IntegratedTaxGUID>
    <AccountName>Updated_July20_update1</AccountName>
    <CategoryName>Income</CategoryName>
    <Enabled>false</Enabled>
  </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
TransactionID,AccountID,StoreID,Debit,Credit,DateCreated,DateCreatedAtMidnight,GMTDate,SourceType,SourceID,SourceIDByStore,Comments,Exported,TerminalID,InvoiceEditedDate,ExtraData,TaxID,SourceGUID,TaxTableType,RowThumbprint,RowInserted,RowUpdated,IntegratedTaxGUID,AccountName,CategoryName,Enabled
1258877,8,34,0,15,2016-01-04T11:00:48.25,2016-01-04T00:00:00,2016-01-04T17:00:48.25,2,126520,TOTLIIN138,,false,0,2016-01-04T11:00:48.25,,1,bb6fe8f1-311e-8efa-d8ef-b80738b0ae41,1,b586d384-2ca8-5a61-67f7-4effc82c20a3,2016-01-04T11:00:48.25,2016-01-04T11:00:48.25,cf1caf02-f7d6-3219-a0ed-019e122a4a7e,Updated_July20_update1,Income,false

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 Security Audit Report

This report allows you to see all security role, module and level combinations that have been configured in RQ.

For more information on configuring security in RQ, see Setting Security Roles and Descriptions.

Note that this report has multiple responses, depending on the Pivot value specified.

Data Pivot Response
A resource for each security module in RQ true SecurityAuditReportPivotData
A resource for each security role/module combination in RQ false SecurityAuditReportData

Definition

GET /customizedreports/SecurityAuditReport?Pivot={Pivot}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /customizedreports/SecurityAuditReport?Pivot=false
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[SecurityAuditReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "RoleDescription": "Administrator",
        "ModuleName": "Inventory: Starting Inventory Count Import",
        "SecurityLevel": "Full Access"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "RoleDescription": "Administrator",
            "ModuleName": "Inventory: Starting Inventory Count Import",
            "SecurityLevel": "Full Access"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <RoleDescription>Administrator</RoleDescription>
    <ModuleName>Inventory: Starting Inventory Count Import</ModuleName>
    <SecurityLevel>Full Access</SecurityLevel>
  </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
RoleDescription,ModuleName,SecurityLevel
Administrator,Inventory: Starting Inventory Count Import,Full Access

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 Source Types

Definition

GET /lists/GL_SourceType

Headers

Example Request

GET /lists/GL_SourceType
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

Response Parameters

Array[SourceType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "GL_SourceType": 1,
        "GP_SourceTypeName": "Opening Balance"
    }
]

Example Response (JsonDataTable)

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

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <GL_SourceType>1</GL_SourceType>
    <GP_SourceTypeName>Opening Balance</GP_SourceTypeName>
  </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
GL_SourceType,GP_SourceTypeName
1,Opening Balance

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 Activation Gross Profit Extended Report

Definition

GET /customizedreports/ActivationGrossProfitExtendedReport?ReportType={ReportType}&CategoryNumber={CategoryNumber}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&DatePercision={DatePercision}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ReasonCode={ReasonCode}&StoreType={StoreType}&LanguageCode={LanguageCode}&VendorAccountID={VendorAccountID}&PaymentTypeIDforBilltoAccount={PaymentTypeIDforBilltoAccount}&VendorAccountIDforNumBillingPrds={VendorAccountIDforNumBillingPrds}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /customizedreports/ActivationGrossProfitExtendedReport?ReportType=FinancedAccessories&CategoryNumber=10&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&StoreType=-1&LanguageCode=en-us&VendorAccountID=1&PaymentTypeIDforBilltoAccount=0&VendorAccountIDforNumBillingPrds=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/customizedreports/ActivationGrossProfitExtendedReport?ReportType=FinancedAccessories&CategoryNumber=10&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&StoreType=-1&LanguageCode=en-us&VendorAccountID=1&PaymentTypeIDforBilltoAccount=0&VendorAccountIDforNumBillingPrds=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheActivationGrossProfitExtendedReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/customizedreports/ActivationGrossProfitExtendedReport?ReportType=FinancedAccessories&CategoryNumber=10&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&StoreType=-1&LanguageCode=en-us&VendorAccountID=1&PaymentTypeIDforBilltoAccount=0&VendorAccountIDforNumBillingPrds=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 GettingTheActivationGrossProfitExtendedReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/customizedreports/ActivationGrossProfitExtendedReport?ReportType=FinancedAccessories&CategoryNumber=10&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&StoreType=-1&LanguageCode=en-us&VendorAccountID=1&PaymentTypeIDforBilltoAccount=0&VendorAccountIDforNumBillingPrds=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/customizedreports/ActivationGrossProfitExtendedReport?ReportType=FinancedAccessories&CategoryNumber=10&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&StoreType=-1&LanguageCode=en-us&VendorAccountID=1&PaymentTypeIDforBilltoAccount=0&VendorAccountIDforNumBillingPrds=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ActivationGrossProfitExtendedReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "InvoiceDate": "2016-12-22T16:17:07.557",
        "Invoice": "84WEAIN17137",
        "LocationName": "84 West",
        "LocationID": 1,
        "Profit": 114.99,
        "CustomerName": "John Smith",
        "PhoneDescription": "iPhone 6 Plus 16GB - Gold",
        "SerialNumber": "70000000000090",
        "PhoneNumber": "5555555555",
        "TermDescription": "2 YR Upgrade $69.99 - $89.98",
        "RatePlanDescription": "Act $69.99 to $89.98",
        "VendorAccountName": "Verizon 2",
        "EmployeeName": "iQmetrix.Employee",
        "UserName": "iQmetrix.Employee",
        "DistrictName": "Valley Area District",
        "RegionName": "Region A",
        "ChannelName": "Regina Channel",
        "LocationType": "Retail Store",
        "CustomerAcctNum": "C89555",
        "CustomerRSA": "",
        "OrigPurchAmt": 214.99,
        "BalanceToBeBilled": 0,
        "NumBillingPrds": 0,
        "BilltoAccount": true
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "InvoiceDate": "2016-12-22T16:17:07.557",
            "Invoice": "84WEAIN17137",
            "LocationName": "84 West",
            "LocationID": 1,
            "Profit": 114.99,
            "CustomerName": "John Smith",
            "PhoneDescription": "iPhone 6 Plus 16GB - Gold",
            "SerialNumber": "70000000000090",
            "PhoneNumber": "5555555555",
            "TermDescription": "2 YR Upgrade $69.99 - $89.98",
            "RatePlanDescription": "Act $69.99 to $89.98",
            "VendorAccountName": "Verizon 2",
            "EmployeeName": "iQmetrix.Employee",
            "UserName": "iQmetrix.Employee",
            "DistrictName": "Valley Area District",
            "RegionName": "Region A",
            "ChannelName": "Regina Channel",
            "LocationType": "Retail Store",
            "CustomerAcctNum": "C89555",
            "CustomerRSA": "",
            "OrigPurchAmt": 214.99,
            "BalanceToBeBilled": 0,
            "NumBillingPrds": 0,
            "BilltoAccount": true
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <InvoiceDate>2016-12-22T16:17:07.557</InvoiceDate>
    <Invoice>84WEAIN17137</Invoice>
    <LocationName>84 West</LocationName>
    <LocationID>1</LocationID>
    <Profit>114.99</Profit>
    <CustomerName>John Smith</CustomerName>
    <PhoneDescription>iPhone 6 Plus 16GB - Gold</PhoneDescription>
    <SerialNumber>70000000000090</SerialNumber>
    <PhoneNumber>5555555555</PhoneNumber>
    <TermDescription>2 YR Upgrade $69.99 - $89.98</TermDescription>
    <RatePlanDescription>Act $69.99 to $89.98</RatePlanDescription>
    <VendorAccountName>Verizon 2</VendorAccountName>
    <EmployeeName>iQmetrix.Employee</EmployeeName>
    <UserName>iQmetrix.Employee</UserName>
    <DistrictName>Valley Area District</DistrictName>
    <RegionName>Region A</RegionName>
    <ChannelName>Regina Channel</ChannelName>
    <LocationType>Retail Store</LocationType>
    <CustomerAcctNum>C89555</CustomerAcctNum>
    <CustomerRSA></CustomerRSA>
    <OrigPurchAmt>214.99</OrigPurchAmt>
    <BalanceToBeBilled>0</BalanceToBeBilled>
    <NumBillingPrds>0</NumBillingPrds>
    <BilltoAccount>true</BilltoAccount>
  </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
InvoiceDate,Invoice,LocationName,LocationID,Profit,CustomerName,PhoneDescription,SerialNumber,PhoneNumber,TermDescription,RatePlanDescription,VendorAccountName,EmployeeName,UserName,DistrictName,RegionName,ChannelName,LocationType,CustomerAcctNum,CustomerRSA,OrigPurchAmt,BalanceToBeBilled,NumBillingPrds,BilltoAccount
2016-12-22T16:17:07.557,84WEAIN17137,84 West,1,114.99,John Smith,iPhone 6 Plus 16GB - Gold,70000000000090,5555555555,2 YR Upgrade $69.99 - $89.98,Act $69.99 to $89.98,Verizon 2,iQmetrix.Employee,iQmetrix.Employee,Valley Area District,Region A,Regina Channel,Retail Store,C89555,,214.99,0,0,true

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 RMA History Product Extended Report

Similar to RMA History Product Report except StartDate and StopDate are not applied to CreatedOn but rather CommittedOn or ShippedOn.

Definition

GET /CustomizedReports/RMAHistoryProductExtendedReport?VendorID={VendorID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&StartDate={StartDate}&StopDate={StopDate}&DatePercision={DatePercision}&DateRange={DateRange}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /CustomizedReports/RMAHistoryProductExtendedReport?VendorID=51&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&DateRange=Today
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/CustomizedReports/RMAHistoryProductExtendedReport?VendorID=51&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&DateRange=Today" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheRmaHistoryProductExtendedReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/CustomizedReports/RMAHistoryProductExtendedReport?VendorID=51&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&DateRange=Today");
    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 GettingTheRmaHistoryProductExtendedReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/CustomizedReports/RMAHistoryProductExtendedReport?VendorID=51&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&DateRange=Today");
     
    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/CustomizedReports/RMAHistoryProductExtendedReport?VendorID=51&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&DateRange=Today', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[RMAHistoryProductExtendedReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "StockBalanceID": 1147,
        "StockBalanceIDByStore": "84WEASB12",
        "RMANumber": "1234",
        "DateCreated": "2015-07-22T15:16:16.007",
        "VendorName": "Offwire",
        "StoreName": "84 West",
        "DistrictName": "Valley Area District",
        "RegionName": "Region A",
        "ChannelName": "Regina Channel",
        "ProductIdentifier": "ASHCSA000120",
        "ProductName": "Samsung Galaxy Rugby LTE",
        "SerialNumberRemoved": "990000926066533",
        "SerialNumberAdded": "",
        "Quantity": 1,
        "UnitCost": 198,
        "TotalCost": 699,
        "UnitCostCredited": 459,
        "TotalCostCredited": 459,
        "VendorInvoiceNumber": "",
        "VendorPartNumber": "",
        "DateShipped": "2011-06-02T09:41:08.027",
        "EmployeeName1": "Skip Davis",
        "DateReceived": "2012-08-01T15:05:37.65",
        "EmployeeName2": "Skip Davis",
        "ActionTaken": 1
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "StockBalanceID": 1147,
            "StockBalanceIDByStore": "84WEASB12",
            "RMANumber": "1234",
            "DateCreated": "2015-07-22T15:16:16.007",
            "VendorName": "Offwire",
            "StoreName": "84 West",
            "DistrictName": "Valley Area District",
            "RegionName": "Region A",
            "ChannelName": "Regina Channel",
            "ProductIdentifier": "ASHCSA000120",
            "ProductName": "Samsung Galaxy Rugby LTE",
            "SerialNumberRemoved": "990000926066533",
            "SerialNumberAdded": "",
            "Quantity": 1,
            "UnitCost": 198,
            "TotalCost": 699,
            "UnitCostCredited": 459,
            "TotalCostCredited": 459,
            "VendorInvoiceNumber": "",
            "VendorPartNumber": "",
            "DateShipped": "2011-06-02T09:41:08.027",
            "EmployeeName1": "Skip Davis",
            "DateReceived": "2012-08-01T15:05:37.65",
            "EmployeeName2": "Skip Davis",
            "ActionTaken": 1
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <StockBalanceID>1147</StockBalanceID>
    <StockBalanceIDByStore>84WEASB12</StockBalanceIDByStore>
    <RMANumber>1234</RMANumber>
    <DateCreated>2015-07-22T15:16:16.007</DateCreated>
    <VendorName>Offwire</VendorName>
    <StoreName>84 West</StoreName>
    <DistrictName>Valley Area District</DistrictName>
    <RegionName>Region A</RegionName>
    <ChannelName>Regina Channel</ChannelName>
    <ProductIdentifier>ASHCSA000120</ProductIdentifier>
    <ProductName>Samsung Galaxy Rugby LTE</ProductName>
    <SerialNumberRemoved>990000926066533</SerialNumberRemoved>
    <SerialNumberAdded></SerialNumberAdded>
    <Quantity>1</Quantity>
    <UnitCost>198</UnitCost>
    <TotalCost>699</TotalCost>
    <UnitCostCredited>459</UnitCostCredited>
    <TotalCostCredited>459</TotalCostCredited>
    <VendorInvoiceNumber></VendorInvoiceNumber>
    <VendorPartNumber></VendorPartNumber>
    <DateShipped>2011-06-02T09:41:08.027</DateShipped>
    <EmployeeName1>Skip Davis</EmployeeName1>
    <DateReceived>2012-08-01T15:05:37.65</DateReceived>
    <EmployeeName2>Skip Davis</EmployeeName2>
    <ActionTaken>1</ActionTaken>
  </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
StockBalanceID,StockBalanceIDByStore,RMANumber,DateCreated,VendorName,StoreName,DistrictName,RegionName,ChannelName,ProductIdentifier,ProductName,SerialNumberRemoved,SerialNumberAdded,Quantity,UnitCost,TotalCost,UnitCostCredited,TotalCostCredited,VendorInvoiceNumber,VendorPartNumber,DateShipped,EmployeeName1,DateReceived,EmployeeName2,ActionTaken
1147,84WEASB12,1234,2015-07-22T15:16:16.007,Offwire,84 West,Valley Area District,Region A,Regina Channel,ASHCSA000120,Samsung Galaxy Rugby LTE,990000926066533,,1,198,699,459,459,,,2011-06-02T09:41:08.027,Skip Davis,2012-08-01T15:05:37.65,Skip Davis,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 the Serialized Inventory Availability Detail Report

Products in RQ must be mapped to Product Library to appear in this request.

To learn more about mapping products to Product Library, see Product Library.

Definition

GET /CustomizedReports/SerializedInventoryAvailabilityDetailReport?SerialNumber={SerialNumber}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /CustomizedReports/SerializedInventoryAvailabilityDetailReport?SerialNumber=4865416516
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[SerializedInventoryAvailabilityDetailReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "SerialNumber": "4865416516",
        "isInStock": true,
        "LocationID": 112482,
        "StoreName": "Regina Store",
        "RetailerCatalogID": "e45b0a48-4111-0689-314d-197ae7acbf83",
        "ModelName": "Galaxy S4 16GB - Black",
        "ModelRemarks": "Smartphones",
        "WarrantyUnit": "",
        "WarrantyValue": 100,
        "Manufacturer": "Samsung",
        "MSRPAmount": 649,
        "MSRPCurrencyCode": "USD"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "SerialNumber": "4865416516",
            "isInStock": true,
            "LocationID": 112482,
            "StoreName": "Regina Store",
            "RetailerCatalogID": "e45b0a48-4111-0689-314d-197ae7acbf83",
            "ModelName": "Galaxy S4 16GB - Black",
            "ModelRemarks": "Smartphones",
            "WarrantyUnit": "",
            "WarrantyValue": 100,
            "Manufacturer": "Samsung",
            "MSRPAmount": 649,
            "MSRPCurrencyCode": "USD"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <SerialNumber>4865416516</SerialNumber>
    <isInStock>true</isInStock>
    <LocationID>112482</LocationID>
    <StoreName>Regina Store</StoreName>
    <RetailerCatalogID>e45b0a48-4111-0689-314d-197ae7acbf83</RetailerCatalogID>
    <ModelName>Galaxy S4 16GB - Black</ModelName>
    <ModelRemarks>Smartphones</ModelRemarks>
    <WarrantyUnit></WarrantyUnit>
    <WarrantyValue>100</WarrantyValue>
    <Manufacturer>Samsung</Manufacturer>
    <MSRPAmount>649</MSRPAmount>
    <MSRPCurrencyCode>USD</MSRPCurrencyCode>
  </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
SerialNumber,isInStock,LocationID,StoreName,RetailerCatalogID,ModelName,ModelRemarks,WarrantyUnit,WarrantyValue,Manufacturer,MSRPAmount,MSRPCurrencyCode
4865416516,true,112482,Regina Store,e45b0a48-4111-0689-314d-197ae7acbf83,Galaxy S4 16GB - Black,Smartphones,,100,Samsung,649,USD

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 Payment Integration Summary Report

Definition

GET /CustomizedReports/PaymentIntegrationSummaryReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&Response={Response}&Auth={Auth}

Headers

Example Request

GET /CustomizedReports/PaymentIntegrationSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&Response=xml&Auth=vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[PaymentIntegrationSummaryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "LocationID": 48572,
        "StoreName": "Manchester City",
        "Terminals": 2,
        "Transactions": 11,
        "ManualEntries": 8
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "LocationID": 48572,
            "StoreName": "Manchester City",
            "Terminals": 2,
            "Transactions": 11,
            "ManualEntries": 8
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <LocationID>48572</LocationID>
    <StoreName>Manchester City</StoreName>
    <Terminals>2</Terminals>
    <Transactions>11</Transactions>
    <ManualEntries>8</ManualEntries>
  </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
LocationID,StoreName,Terminals,Transactions,ManualEntries
48572,Manchester City,2,11,8

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?