API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

Data Connect allows you to retrieve report data from 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

BillPayHistoryReportData

[
    {
        "CreationDate": "2015-01-16T14:58:05.597",
        "StoreName": "Cornwall",
        "BillPaymentTransactionID": 24525,
        "BillPaymentTransactionIDByStore": "TALLABP2386",
        "ProviderID": 1,
        "Provider": "zDataScape-VZ Bill Payment Legacy - VRP",
        "CustomerID": 124052,
        "CustomerName": "John Smith",
        "TrackingNumber": "15123125126",
        "PaymentAmount": 25,
        "RoundingAmount": 0,
        "ProcessingFee": 3,
        "Taxes": 1.25,
        "EmployeeName": "iQmetrix Employee",
        "SaleInvoiceID": 121735,
        "SaleInvoiceIDByStore": "TALLAIN7234",
        "DepositNRPGlobalProductID": 1,
        "DepositNRPProductIdentifier": ""
    }
]
Name Description
CreationDate (DateTime) Date - date and time the Bill Pay was tendered
StoreName (NVARCHAR(MAX)) Location - location that took the Bill Pay
BillPaymentTransactionID (INT) Internal identifier in RQ
BillPaymentTransactionIDByStore (VARCHAR(14)) Related Bill Pay - Bill Pay invoice for review, emailing or printing
ProviderID (INT) Identifier for a provider in RQ
Provider (NVARCHAR(MAX)) Provider - name of the Bill Pay provider, e.g. PreCash
CustomerID (INT) Internal identifier for a customer in RQ
CustomerName (VARCHAR(151)) Customer - customer who made the Bill Pay
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
ProcessingFee (MONEY) Processing Fee - processing fee charged
Taxes (MONEY) Taxes - any taxes collected or refunded
EmployeeName (VARCHAR(51)) Created By - employee took the Bill Pay
SaleInvoiceID (INT) Internal identifier for an invoice in RQ
SaleInvoiceIDByStore (VARCHAR(14)) Related Invoice - any invoice related to the primary invoice
DepositNRPGlobalProductID (INT) Internal identifier for a product in RQ
DepositNRPProductIdentifier (VARCHAR(12)) Related SKU - the Bill Pay SKU that is displayed on the related invoice, i.e. the RQ product that is sold in the Bill Pay

CashAuditTrailReportData

This resource has DYNAMIC COLUMNS, the properties/columns will change depending on the Payment Types defined in RQ.
[
    {
        "TransactionID": 121612,
        "TypeID": 20,
        "Terminal": "Default Terminal",
        "TransactionAbbr": "84WEAIN5543",
        "Employee1": "iQmetrix Employee",
        "Username1": "iQmetrix.Employee",
        "Employee2": "",
        "Username2": "",
        "StoreName": "84 West",
        "DateTime": "2015-01-02T13:58:21.427",
        "TID": 121612,
        "TerminalID": 0,
        "EnteredAmount": 0,
        "ExpectedAmount": 0,
        "Float": 0,
        "DepositAmount": 0
    }
]
Name Description
TransactionID (INT) Identifier for a transaction in RQ
TypeID (INT) Type. See SaleType
Terminal (VARCHAR(200)) Terminal - terminal the transaction was done at
TransactionAbbr (VARCHAR(32)) Transaction # - transaction # generated by the system
Employee1 (VARCHAR(51)) Employee 1 - name of the employee who did the transaction or was logged-in when the cashout was done
Username1 (VARCHAR(51)) Username1 - username of the employee who did the transaction or was logged-in when the cashout was done
Employee2 (VARCHAR(51)) Employee 2 - name of the employee who verified the transaction if present
Username2 (VARCHAR(51)) Username2 - username of the employee who verified the transaction if present
StoreName (NVARCHAR(MAX)) Location - where the transaction was done
DateTime (DateTime) Date/Time - date and time the transaction was made
TID (INT) Internal identifier in RQ
TerminalID (INT) Identifier for a terminal in RQ
EnteredAmount (MONEY) Cash Audit - Drawer Audits, note that these rows are highlighted in pink
ExpectedAmount (MONEY) Cash
Float (MONEY) Float Retained - float that was retained at the start of the day
DepositAmount (MONEY) Deposit - amount of a deposit that was taken

CashOutSummaryReportData

[
    {
        "CashOutID": 13775,
        "CashOutIDByStore": "84WEACA649",
        "StoreName": "84 West",
        "Reconciled": "No",
        "StartDate": "2012-08-20T18:18:52.023",
        "StopDate": "2015-02-24T13:40:33.21",
        "EmployeeName1": "iQmetrix Employee",
        "EmployeeUsername1": "iQmetrix.Employee",
        "EmployeeName2": "iQmetrix Employee",
        "EmployeeUsername2": "iQmetrix.Employee",
        "PaymentName": "Cash",
        "CreditCardPaymentType": "",
        "PaymentReconciled": "No",
        "Cashout": "",
        "Reconciliation": "",
        "DepositNumber": "100.00",
        "ActualTotal": 1884.1,
        "SystemTotal": 0,
        "Skim": 0,
        "Float": 0,
        "DifferenceTotal": 1884.1,
        "TransactionQuantity": 0,
        "CashAndCheque": 1884.1,
        "FloatRetained": 0,
        "DepositAmount": 1884.1,
        "CashInAmount": 0,
        "BankDetails": ""
    }
]
Name Description
CashOutID (INT) Internal identifier in RQ
CashOutIDByStore (VARCHAR(14)) Cashout # - number that the system generated for the cashout at the time it was created. To view the cashout simply click its underlined link
StoreName (NVARCHAR(MAX)) Name of the store
Reconciled (VARCHAR(3)) A flag to indicate if the cashout was reconciled
StartDate (DateTime) Started On - start time of this cashout’s interval. If this is the first cashout for this location then the Started On Date will be N/A
StopDate (DateTime) Stopped On - stop time of this cashout’s interval
EmployeeName1 (VARCHAR(51)) Employee 1 - name of the employee who was logged in when the cashout was done
EmployeeUsername1 (VARCHAR(51)) Username1 - username of the employee who was logged in when the cashout was done
EmployeeName2 (VARCHAR(51)) Employee 2 - name of the employee who verified the cashout was correct, this may be the same person as Employee 1
EmployeeUsername2 (VARCHAR(51)) Username2 - the username of the employee who was logged in when the cashout was done
PaymentName (NVARCHAR(MAX)) Payment - payment type for the row’s totals
CreditCardPaymentType (VARCHAR(20)) Credit card payment type
PaymentReconciled (VARCHAR(3)) Payment Reconciled - indicates whether the payment type has been reconciled or not
Cashout (VARCHAR(5000)) Cashout Comments - comments from the cashout
Reconciliation (VARCHAR(1000)) Reconciliation Comments - from the reconciliation if it has been done
DepositNumber (VARCHAR(50)) Deposit # - number for this particular deposit, e.g. bank deposit number
ActualTotal (MONEY) Your Total - total filled in by Employee 1 from the till totals for all transactions during the cashoutinterval for the row’s payment type
SystemTotal (MONEY) System Total - overall total the software has recorded for all transactions during the cashout interval for the row’s payment type. This includes all payments accepted for sales, bill pay and for customer account payments
Skim (MONEY) Internal value in RQ
Float (MONEY) Internal value in RQ
DifferenceTotal (MONEY) Difference - Your Total - System Total
TransactionQuantity (INT) Internal value in RQ
CashAndCheque (MONEY) Cash/check (cheque) - total for the cash and check payment types
FloatRetained (MONEY) Float Retained - dollar amount retained as a float
DepositAmount (MONEY) Deposit - actual deposit value for that cashout
CashInAmount (MONEY) Cashin - cashed in float amount
BankDetails (NVARCHAR(MAX)) Bank Details - states the bank associated to the cashout

ChargeBackSummaryReportLocationData

[
    {
        "Quantity": 1,
        "StoreID": 6679,
        "StoreName": "100: My Network LLC - Anchorage",
        "TotalValue": -100
    }
]
Name Description
Quantity (INT) Qty
StoreID (INT) Internal identifier for a store in RQ
StoreName (NVARCHAR (MAX)) Location
TotalValue (MONEY) Total Value - dollar value of the charge backs

ChargeBackSummaryReportCategoryData

[
    {
        "CategoryName": "Financing",
        "CategoryNumber": "10101012",
        "CategoryPath": "Activations",
        "Quantity": 1,
        "TotalValue": -100
    }
]
Name Description
CategoryName (NVARCHAR (MAX)) Category Name
CategoryNumber (NVARCHAR (100)) Internal identifier for a Category in RQ
CategoryPath (NVARCHAR (MAX)) Category
Quantity (INT) Qty
TotalValue (MONEY) Total Value - dollar value of the charge backs

ChargeBackSummaryReportProductSummaryData

[
    {
        "GlobalProductID": 9809,
        "ProductIdentifier": "ACFNRB000008",
        "ProductName": "Vendor Rebate",
        "Quantity": 1,
        "TotalValue": -100
    }
]
Name Description
GlobalProductID (INT) Internal identifier for a product in RQ
ProductIdentifier (VARCHAR (12)) Product SKU
ProductName (NVARCHAR (MAX)) Product Name
Quantity (INT) Qty
TotalValue (MONEY) Total Value - dollar value of the charge backs

ChargeBackSummaryReportProductDetailData

[
    {
        "AssociationNumber": 7,
        "CarrierPrice": 0,
        "CategoryName": "10101012",
        "CategoryNumber": "Financing",
        "ChargeBackCode": "iQmetrix User",
        "ChargedBackByEmployee": "1",
        "ChargedBackByEmployeeID": 1,
        "Comments": "",
        "CustomerID": null,
        "CustomerName": "No Customer",
        "DateChargedBack": "2016-05-20T07:57:42.417",
        "DateInvoiced": "2016-05-20T06:47:10.543",
        "FullChargeBackID": "322aa012-82dc-4373-a7d6-82faa2b4738b",
        "FullChargeBackIDByStore": "77224FC1",
        "GlobalProductID": 9809,
        "InvoicedByEmployee": "iQmetrix User",
        "InvoicedByEmployeeID": 1,
        "ProductIdentifier": "ACFNRB000008",
        "ProductName": "Vendor Rebate",
        "Quantity": 1,
        "RelatedProduct": "",
        "RelatedProductID": 0,
        "SaleInvoiceID": 129036,
        "SaleInvoiceIDByStore": "77224IN5",
        "SerialNumber": "1123123132",
        "TotalValue": -100,
        "VendorName": "",
        "VendorSKU": ""
    }
]
Name Description
AssociationNumber (SMALLINT) When adding products with PAW all associated products from the sale have the same association number tied together, this value increments based on how many sales are made on that order
CarrierPrice (MONEY) Carrier Price - value or revenue assigned by the carrier
CategoryName (VARCHAR(100)) Category - inventory category to which the SKU belongs
CategoryNumber (VARCHAR(100)) Internal identifier for a Category in RQ
ChargeBackCode (VARCHAR(500)) Charge Back Code - specific code for this charge back
ChargedBackByEmployee (VARCHAR(160)) Tendered By - name of the employee logged into RQ when the invoice was tendered
ChargedBackByEmployeeID (INT) Identifier for an employee in RQ
Comments (NVARCHAR(MAX)) Comments - any comments associated with this charge back
CustomerID (INT) Internal identifier for a customer in RQ
CustomerName (VARCHAR(160)) Customer Name - name of the customer as entered on their profile
DateChargedBack (DateTime) Charged Back - date of the charge back
DateInvoiced (DateTime) Invoiced - date originally invoiced
FullChargeBackID (IDUNIQUEIDENTIFIER) Internal identifier in RQ
FullChargeBackIDByStore (VARCHAR(30)) Charge Back # - invoice number for the charge back
GlobalProductID (INT) Internal identifier in RQ
InvoicedByEmployee (VARCHAR(160)) Sales Person - name of the employee of record for the sale, i.e. the employee whose name is in the Commission box
InvoicedByEmployeeID (INT) Internal identifier for an Employee in RQ
ProductIdentifier (VARCHAR(12)) Product SKU - SKU of the product charged back
ProductName (VARCHAR(100)) Product Name - description of the product charged back
Quantity (INT) Qty - total count of charge backs
RelatedProduct (VARCHAR(100)) Related Product - related product, if applicable
RelatedProductID (INT) Internal identifier for a product in RQ
SaleInvoiceID (INT) Internal identifier for an invoice in RQ
SaleInvoiceIDByStore (VARCHAR(30)) Invoice # - original invoice number
SerialNumber (VARCHAR(100)) Tracking Number - tracking number associated with the product charged back
TotalValue (MONEY) Total Value - dollar value of the charge backs
VendorName (NVARCHAR(MAX)) Name for a vendor in RQ
VendorSKU (VARCHAR(25)) Vendor SKU in RQ

ChargeBackSummaryReportEmployeeData

[
    {
        "Commission": 0,
        "InvoicedByEmployee": "iQmetrix User",
        "InvoicedByEmployeeID": 1,
        "Quantity": 1,
        "TotalValue": 5
    }
]
Name Description
Commission (MONEY) Commission
InvoicedByEmployee (VARCHAR (51)) Employee
InvoicedByEmployeeID (INT) Internal identifier for an Employee in RQ
Quantity (INT) Qty
TotalValue (MONEY) Total Value - dollar value of the charge backs

ChargeBackSummaryReportHardwareCollectionData

[
    {
        "AssociationNumber": 7,
        "CommissionRebate1": "SaslTel New Activation",
        "CommissionRebate2": "",
        "CustomerID": null,
        "CustomerName": "No Customer",
        "DateInvoiced": "2016-05-20T06:47:10.543",
        "EquipmentRebate": "",
        "HardwareRebateGlobalProductID": 1,
        "HardwareRebateSKU": "CPCCRB000104",
        "InvoicedByEmployee": "iQmetrix User",
        "InvoicedByEmployeeID": 1,
        "IsFullChargedBack1": "",
        "IsFullChargedBack2": "",
        "IsFullChargedBack3": "",
        "PhoneNumber": "",
        "Price": 99.99,
        "RatePlanRebate2GlobalProductID": 2,
        "RatePlanRebate2SKU": "",
        "RatePlanRebateGlobalProductID": 3,
        "RatePlanRebateSKU": "",
        "RelatedProduct": "",
        "RelatedProductID": 0,
        "SaleInvoiceID": 423,
        "SaleInvoiceIDByStore": "",
        "SerialNumber": "",
        "StoreID": 6679,
        "StoreName": "100: My Network LLC - Anchorage",
        "VendorName": "",
        "VendorSKU": ""
    }
]
Name Description
AssociationNumber (SMALLINT) When adding products with PAW all associated products from the sale have the same association number tied together, this value increments based on how many sales are made on that order
CommissionRebate1 (NVARCHAR(1000)) Commission Rebate 1 - name of the first commission rebate
CommissionRebate2 (NVARCHAR(1000)) Commission Rebate 2 - name of the second commission rebate
CustomerID (INT) Identifier for a customer in RQ
CustomerName (VARCHAR(160)) Customer Name - name of the customer as entered on their profile
DateInvoiced (DateTime) Tendered On - date tendered
EquipmentRebate (NVARCHAR(1000)) Equipment Rebate - name of the equipment rebate
HardwareRebateGlobalProductID (INT) Internal identifier for a product in RQ
HardwareRebateSKU (VARCHAR(12)) Equipment Rebate SKU - SKU of the equipment rebate
InvoicedByEmployee (VARCHAR(160)) Sales Person - name of the employee of record for the sale, i.e. the employee whose name is in the Commission box
InvoicedByEmployeeID (INT) Internal identifier for an employee in RQ
IsFullChargedBack1 (VARCHAR(10)) Charged Back - yes if charged back
IsFullChargedBack2 (VARCHAR(10)) Charged Back - yes if charged back
IsFullChargedBack3 (VARCHAR(10)) Charged Back - yes if charged back
PhoneNumber (VARCHAR(30)) Phone - Mobile number of the device
Price (MONEY) Price - actual invoiced price
RatePlanRebate2GlobalProductID (INT) Internal identifier in RQ
RatePlanRebate2SKU (VARCHAR(12)) Commission Rebate 2 SKU - SKU of the second commission rebate
RatePlanRebateGlobalProductID (INT) Internal identifier in RQ
RatePlanRebateSKU (VARCHAR(12)) Commission Rebate SKU - SKU of the first commission rebate
RelatedProduct (VARCHAR(100)) Related Product - product associated with this rebate
RelatedProductID (INT) Internal identifier in RQ
SaleInvoiceID (INT) Internal identifier in RQ
SaleInvoiceIDByStore (VARCHAR(30)) Invoice # - original invoice number
SerialNumber (VARCHAR(100)) Serial number
StoreID (INT) Identifier for a store in RQ
StoreName (VARCHAR(100)) Tendered At - location where tendered
VendorName (NVARCHAR(MAX)) Name for a vendor in RQ
VendorSKU (VARCHAR(25)) Vendor SKU

OutstandingGiftCardsReportData

[
    {
        "SerialNumber": "7777085179051274",
        "DateSold": "2016-10-14T13:05:14.133",
        "CustomerName": "Bill Smith",
        "LastRedeemedGMT": "2016-10-14T19:30:37.063",
        "LastRedeemed": "2016-10-14T13:30:37.063",
        "RedeemedAt": "84 West",
        "RedeemedBy": "Bill Smith",
        "Balance": 77.52,
        "SaleInvoiceID": 634,
        "InvoiceIDByStore": "MIL44AH9",
        "ProductName": "iTunes 20",
        "ProductSKU": "ASBTHT000018",
        "InvoiceSerialMask": 6
    }
]
Name Description
SerialNumber (VARCHAR(35)) Card Number - activation number for the gift card
DateSold (DateTime) Activated On - date the gift card was activated
CustomerName (VARCHAR(101)) Customer - name of the customer who purchased the gift card
LastRedeemedGMT (DateTime) Last Redeemed (GMT) - when the gift card was last redeemed, in GMT time
LastRedeemed (DateTime) Last Redeemed - when the gift card was last redeemed, local time
RedeemedAt (NVARCHAR(MAX)) Redeemed At - location where the card was redeemed
RedeemedBy (VARCHAR(151)) Redeemed By - name of the customer who redeemed the gift card
Balance (MONEY) Balance - remaining balance
SaleInvoiceID (INT) Internal identifier for an invoice in RQ
InvoiceIDByStore (VARCHAR(14)) Invoice Number - invoice number with a link to the invoice
ProductName (NVARCHAR(MAX)) Product Name - product description of the card
ProductSKU (VARCHAR(20)) Product SKU - product SKU assigned to the gift card
InvoiceSerialMask (INT) Amount of the SerialNumber to mask

PaymentIntegrationTransactionReportData

[
    {
        "InvoiceID": 122337,
        "StoreInvoiceID": "84WEAIN5981",
        "CustomerName": "Alice Kim",
        "EmployeeName": "Sam Smith",
        "InvoiceTypeID": 1,
        "InvoiceType": "Invoice",
        "LocationEntityID": 14192,
        "AuthType": "Sale",
        "TransType": "Credit",
        "CardTypeID": 2,
        "CardType": "Visa",
        "RequestedAmount": 4,
        "EntryTypeID": 2,
        "EntryType": "Swiped",
        "MerchantNumber": "1111",
        "TerminalID": "90572837",
        "AuthDateUTC": "2015-01-28T16:31:58.877",
        "AuthorizationNumber": "ABS251",
        "AuthorizedAmount": 5,
        "ResponseMessage": "APPROVAL",
        "CardholderName": "John Test",
        "CardBin": "545454",
        "LastFourDigits": "5454",
        "TransactionResult": "Approved",
        "ReversedVoided": 0,
        "ReversedVoidedReason": "Auto Void from Incomplete Invoice",
        "VoidedByEmployeeEntityID": "512",
        "VoidedDate": "2015-01-30T16:31:58.877"
    }
]
Name Description
InvoiceID (INT) Unique identifier for the invoice in RQ
StoreInvoiceID (VARCHAR(14)) Invoice identifier displayed to the user and on the printed invoice
CustomerName (VARCHAR(101)) Customer name
EmployeeName (VARCHAR(51)) Employee name
InvoiceTypeID (INT) Identifier for the InvoiceType, see InvoiceType property
InvoiceType (VARCHAR(15)) Name of the InvoiceType
LocationEntityID (INT) Identifier of the store as a Location in Entity Store
AuthType (VARCHAR(4)) Indicates sale or refund
TransType (VARCHAR(8)) What type of transaction this is (Credit/Debit)
CardTypeID (INT) Identifier for the CardType. See CardType property
CardType (VARCHAR(50)) Name of the CardType. See Getting Card Types for a list of possible values
RequestedAmount (MONEY) Amount requested
EntryTypeID (INT) Identifier for the EntryType, see EntryType property
EntryType (VARCHAR(50)) Name of the EntryType. See Getting Entry Types for a list of possible values
MerchantNumber (VARCHAR(50)) The Merchant Number / ID used in payment credentials for this transaction
TerminalID (VARCHAR(50)) The Terminal Number / ID used in payment credentials for this transaction
AuthDateUTC (DateTime) Date of Transaction in UTC
AuthorizationNumber (VARCHAR(10)) Authorization Number from Payment Processor
AuthorizedAmount (MONEY) Amount authorized
ResponseMessage (VARCHAR(100)) Response from Payment Processor
CardholderName (VARCHAR(100)) Name of Cardholder
CardBin (VARCHAR(6)) The payment cards Bank Identifiation Number (BIN)
LastFourDigits (VARCHAR(4)) Last four digits of card
TransactionResult (VARCHAR(110)) Indicated Approved or Declined
ReversedVoided (INT) A flag to indicate if the transaction was reversed/voided (1) or not (0)
ReversedVoidedReason (VARCHAR(150)) String explanation on why the original transaction was voided. Only appears on void transactions, not on the original sale transation
VoidedByEmployeeEntityID (NVARCHAR(50)) Identifier for a User who voided this transaction
VoidedDate (DateTime) Date Transaction was voided in UTC

TaxDetailsReportData

This resource has DYNAMIC COLUMNS, the properties/columns will change depending on the Payment Types defined in RQ.
[
    {
        "DateCreated": "2015-12-31T12:35:07.05",
        "SaleInvoiceID": 166519,
        "InvoiceIDByStore": "MIL44AH9",
        "TenderedBy": "John Test",
        "TenderedAt": "Cornwall",
        "CustomerName": "Alice Smith",
        "Comments": "Return",
        "Invoiced": -910.94,
        "Sales": -910.94,
        "Cost": -405.67,
        "Profit": -505.27,
        "Adjusted": "No",
        "Taxable": "Yes",
        "Refund": "Yes",
        "VendorRebates": 0,
        "VendorRebatesTax": 0,
        "Coupons": 0,
        "CouponsTax": 0,
        "YourPriceTaxableSales": -910.94,
        "ListPriceTaxableSales": 0,
        "GreaterOfTaxableSales": -69.94,
        "FlatTaxableSales": 0,
        "NonTaxableSales": 0,
        "TaxCollected": -59.79,
        "TaxExemptReasonCode": "",
        "TotalTaxPaidAmount": -59.79
    }
]
Name Description
DateCreated (DateTime) Invoice Date - date the invoice was tendered
SaleInvoiceID (INT) Internal identifier for an Invoice in RQ
InvoiceIDByStore (VARCHAR(14)) Invoice #- invoice number assigned by RQ
TenderedBy (VARCHAR(51)) Invoiced By- name of the location which credited with the sale, usually the same as Invoiced At but will be different if a second location process a refund
TenderedAt (NVARCHAR(MAX)) Invoiced At- name of the location which takes the inventory on a refund, usually the same as Invoiced By but will be different if a second location process a refund
CustomerName (VARCHAR(151)) Customer Name - name of the customer as entered on their profile
Comments (NVARCHAR(MAX)) Invoice Comments - any comments on the invoice
Invoiced (MONEY) Total Invoiced - total dollar value of the invoice
Sales (MONEY) Total Sales - total dollar value of the sales on the invoice, usually the same as Total Invoiced except in the case of gift card sales
Cost (MONEY) Total Cost - total purchase cost for all product on the invoice
Profit (MONEY) Total GP - gross profit for the invoice
Adjusted (VARCHAR(32)) Adjusted - indicates if the invoice was adjusted
Taxable (VARCHAR(32)) Taxable - indicates if this line is taxable
Refund (VARCHAR(32)) Refund - indicates if this is a refund
VendorRebates (MONEY) Total Vendor Rebates - total vendor rebate dollar amount
VendorRebatesTax (MONEY) Tax On Vendor Rebates - dollar amount of tax on any vendor rebates
Coupons (MONEY) Total Coupons - total dollar amount of coupons
CouponsTax (MONEY) Tax On Coupons - total dollar amount of tax collected on coupons
YourPriceTaxableSales (MONEY) Full Your Price Taxable Amount - total your price taxable amount (based on the price the product was sold for)
ListPriceTaxableSales (MONEY) Full List Price Taxable Amount - total list price taxable amount (based on the original retail price rung up at the POS based on the inventory settings, prior to giving a discount)
GreaterOfTaxableSales (MONEY) Full Greater of Your Price And Cost Taxable Amount - based on (greater of the price the product sold for, or the cost of the product)
FlatTaxableSales (MONEY) Full Flat Taxable Amount - based on the price the product was sold for
NonTaxableSales (MONEY) Tax Exempt Amount - total tax exempt amount
TaxCollected (MONEY) Total Tax Paid Amount - total dollar amount of tax paid
TaxExemptReasonCode (VARCHAR(1))  
TotalTaxPaidAmount (MONEY) Total Tax Paid Amount - total dollar amount of tax paid

EntryType

[
    {
        "EntryTypeID": 1,
        "EntryTypeDescription": "Swiped",
        "Message": "Swiped"
    }
]
Name Description
EntryTypeID (INT) Identifier
EntryTypeDescription (VARCHAR(50)) Description
Message (NVARCHAR(MAX)) Message

CardType

[
    {
        "CardTypeID": 2,
        "FullName": "Mastercard",
        "Mnemonic": "MC",
        "AccountNumberLength": 16,
        "CvvLength": 3
    }
]
Name Description
CardTypeID (INT) Identifier
FullName (VARCHAR(50)) Full card name
Mnemonic (VARCHAR(2)) Card abbreviation
AccountNumberLength (INT) Length of account number
CvvLength (INT) Length of CVV number on card

BillPayProviderID

[
    {
        "ProviderID": 1,
        "ProviderName": "Simplified Bill Payment"
    }
]
Name Description
ProviderID (INT) Identifier
ProviderName (NVARCHAR(50)) Provider Name

ENUMERATIONS

InvoiceType

Id Name
1 Invoice
2 Pay Off Account
3 Vendor Deposit
4 Sale Order
5 Bill Payment

SaleType

Id Name
2 A/R Payment
4 Cashout
13 Sales Order
15 Petty Cash
20 Sale
28 Vendor Deposit
32 Cash-In
33 Cash Skim
34 Drawer Audit
35 Close Drawer
37 Bill Payment

REQUESTS

GET the Bill Pay History Report

For more information, see Bill Pay History Report.

Definition

GET /reports/BillPayHistoryReport?ProviderID={ProviderID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/BillPayHistoryReport?ProviderID=10&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[BillPayHistoryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CreationDate": "2015-01-16T14:58:05.597",
        "StoreName": "Cornwall",
        "BillPaymentTransactionID": 24525,
        "BillPaymentTransactionIDByStore": "TALLABP2386",
        "ProviderID": 1,
        "Provider": "zDataScape-VZ Bill Payment Legacy - VRP",
        "CustomerID": 124052,
        "CustomerName": "John Smith",
        "TrackingNumber": "15123125126",
        "PaymentAmount": 25,
        "RoundingAmount": 0,
        "ProcessingFee": 3,
        "Taxes": 1.25,
        "EmployeeName": "iQmetrix Employee",
        "SaleInvoiceID": 121735,
        "SaleInvoiceIDByStore": "TALLAIN7234",
        "DepositNRPGlobalProductID": 1,
        "DepositNRPProductIdentifier": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CreationDate": "2015-01-16T14:58:05.597",
            "StoreName": "Cornwall",
            "BillPaymentTransactionID": 24525,
            "BillPaymentTransactionIDByStore": "TALLABP2386",
            "ProviderID": 1,
            "Provider": "zDataScape-VZ Bill Payment Legacy - VRP",
            "CustomerID": 124052,
            "CustomerName": "John Smith",
            "TrackingNumber": "15123125126",
            "PaymentAmount": 25,
            "RoundingAmount": 0,
            "ProcessingFee": 3,
            "Taxes": 1.25,
            "EmployeeName": "iQmetrix Employee",
            "SaleInvoiceID": 121735,
            "SaleInvoiceIDByStore": "TALLAIN7234",
            "DepositNRPGlobalProductID": 1,
            "DepositNRPProductIdentifier": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CreationDate>2015-01-16T14:58:05.597</CreationDate>
    <StoreName>Cornwall</StoreName>
    <BillPaymentTransactionID>24525</BillPaymentTransactionID>
    <BillPaymentTransactionIDByStore>TALLABP2386</BillPaymentTransactionIDByStore>
    <ProviderID>1</ProviderID>
    <Provider>zDataScape-VZ Bill Payment Legacy - VRP</Provider>
    <CustomerID>124052</CustomerID>
    <CustomerName>John Smith</CustomerName>
    <TrackingNumber>15123125126</TrackingNumber>
    <PaymentAmount>25</PaymentAmount>
    <RoundingAmount>0</RoundingAmount>
    <ProcessingFee>3</ProcessingFee>
    <Taxes>1.25</Taxes>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <SaleInvoiceID>121735</SaleInvoiceID>
    <SaleInvoiceIDByStore>TALLAIN7234</SaleInvoiceIDByStore>
    <DepositNRPGlobalProductID>1</DepositNRPGlobalProductID>
    <DepositNRPProductIdentifier></DepositNRPProductIdentifier>
  </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
CreationDate,StoreName,BillPaymentTransactionID,BillPaymentTransactionIDByStore,ProviderID,Provider,CustomerID,CustomerName,TrackingNumber,PaymentAmount,RoundingAmount,ProcessingFee,Taxes,EmployeeName,SaleInvoiceID,SaleInvoiceIDByStore,DepositNRPGlobalProductID,DepositNRPProductIdentifier
2015-01-16T14:58:05.597,Cornwall,24525,TALLABP2386,1,zDataScape-VZ Bill Payment Legacy - VRP,124052,John Smith,15123125126,25,0,3,1.25,iQmetrix Employee,121735,TALLAIN7234,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 Cash Audit Trail Report

This report has DYNAMIC COLUMNS, the resources returned by this report will include a column or property for every Payment Type defined in RQ.

For more information see Cash Audit Trail Report.

Definition

GET /reports/CashAuditTrailReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&TypeID={TypeID}&ForWho={ForWho}&ForWhoID={ForWhoID}&TerminalIDs={TerminalIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/CashAuditTrailReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&TypeID=-1&ForWho=4&ForWhoID=1&TerminalIDs=0&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/CashAuditTrailReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&TypeID=-1&ForWho=4&ForWhoID=1&TerminalIDs=0&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheCashAuditTrailReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/CashAuditTrailReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&TypeID=-1&ForWho=4&ForWhoID=1&TerminalIDs=0&LanguageCode=en-us");
    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 GettingTheCashAuditTrailReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/CashAuditTrailReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&TypeID=-1&ForWho=4&ForWhoID=1&TerminalIDs=0&LanguageCode=en-us");
     
    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/reports/CashAuditTrailReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&TypeID=-1&ForWho=4&ForWhoID=1&TerminalIDs=0&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[CashAuditTrailReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "TransactionID": 121612,
        "TypeID": 20,
        "Terminal": "Default Terminal",
        "TransactionAbbr": "84WEAIN5543",
        "Employee1": "iQmetrix Employee",
        "Username1": "iQmetrix.Employee",
        "Employee2": "",
        "Username2": "",
        "StoreName": "84 West",
        "DateTime": "2015-01-02T13:58:21.427",
        "TID": 121612,
        "TerminalID": 0,
        "EnteredAmount": 0,
        "ExpectedAmount": 0,
        "Float": 0,
        "DepositAmount": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "TransactionID": 121612,
            "TypeID": 20,
            "Terminal": "Default Terminal",
            "TransactionAbbr": "84WEAIN5543",
            "Employee1": "iQmetrix Employee",
            "Username1": "iQmetrix.Employee",
            "Employee2": "",
            "Username2": "",
            "StoreName": "84 West",
            "DateTime": "2015-01-02T13:58:21.427",
            "TID": 121612,
            "TerminalID": 0,
            "EnteredAmount": 0,
            "ExpectedAmount": 0,
            "Float": 0,
            "DepositAmount": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <TransactionID>121612</TransactionID>
    <TypeID>20</TypeID>
    <Terminal>Default Terminal</Terminal>
    <TransactionAbbr>84WEAIN5543</TransactionAbbr>
    <Employee1>iQmetrix Employee</Employee1>
    <Username1>iQmetrix.Employee</Username1>
    <Employee2></Employee2>
    <Username2></Username2>
    <StoreName>84 West</StoreName>
    <DateTime>2015-01-02T13:58:21.427</DateTime>
    <TID>121612</TID>
    <TerminalID>0</TerminalID>
    <EnteredAmount>0</EnteredAmount>
    <ExpectedAmount>0</ExpectedAmount>
    <Float>0</Float>
    <DepositAmount>0</DepositAmount>
  </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,TypeID,Terminal,TransactionAbbr,Employee1,Username1,Employee2,Username2,StoreName,DateTime,TID,TerminalID,EnteredAmount,ExpectedAmount,Float,DepositAmount
121612,20,Default Terminal,84WEAIN5543,iQmetrix Employee,iQmetrix.Employee,,,84 West,2015-01-02T13:58:21.427,121612,0,0,0,0,0

Example Response (Excel)

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

GET the Cashout Summary Report

For more information see Cashout Summary Report.

Definition

GET /reports/CashOutSummaryReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/CashOutSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[CashOutSummaryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CashOutID": 13775,
        "CashOutIDByStore": "84WEACA649",
        "StoreName": "84 West",
        "Reconciled": "No",
        "StartDate": "2012-08-20T18:18:52.023",
        "StopDate": "2015-02-24T13:40:33.21",
        "EmployeeName1": "iQmetrix Employee",
        "EmployeeUsername1": "iQmetrix.Employee",
        "EmployeeName2": "iQmetrix Employee",
        "EmployeeUsername2": "iQmetrix.Employee",
        "PaymentName": "Cash",
        "CreditCardPaymentType": "",
        "PaymentReconciled": "No",
        "Cashout": "",
        "Reconciliation": "",
        "DepositNumber": "100.00",
        "ActualTotal": 1884.1,
        "SystemTotal": 0,
        "Skim": 0,
        "Float": 0,
        "DifferenceTotal": 1884.1,
        "TransactionQuantity": 0,
        "CashAndCheque": 1884.1,
        "FloatRetained": 0,
        "DepositAmount": 1884.1,
        "CashInAmount": 0,
        "BankDetails": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CashOutID": 13775,
            "CashOutIDByStore": "84WEACA649",
            "StoreName": "84 West",
            "Reconciled": "No",
            "StartDate": "2012-08-20T18:18:52.023",
            "StopDate": "2015-02-24T13:40:33.21",
            "EmployeeName1": "iQmetrix Employee",
            "EmployeeUsername1": "iQmetrix.Employee",
            "EmployeeName2": "iQmetrix Employee",
            "EmployeeUsername2": "iQmetrix.Employee",
            "PaymentName": "Cash",
            "CreditCardPaymentType": "",
            "PaymentReconciled": "No",
            "Cashout": "",
            "Reconciliation": "",
            "DepositNumber": "100.00",
            "ActualTotal": 1884.1,
            "SystemTotal": 0,
            "Skim": 0,
            "Float": 0,
            "DifferenceTotal": 1884.1,
            "TransactionQuantity": 0,
            "CashAndCheque": 1884.1,
            "FloatRetained": 0,
            "DepositAmount": 1884.1,
            "CashInAmount": 0,
            "BankDetails": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CashOutID>13775</CashOutID>
    <CashOutIDByStore>84WEACA649</CashOutIDByStore>
    <StoreName>84 West</StoreName>
    <Reconciled>No</Reconciled>
    <StartDate>2012-08-20T18:18:52.023</StartDate>
    <StopDate>2015-02-24T13:40:33.21</StopDate>
    <EmployeeName1>iQmetrix Employee</EmployeeName1>
    <EmployeeUsername1>iQmetrix.Employee</EmployeeUsername1>
    <EmployeeName2>iQmetrix Employee</EmployeeName2>
    <EmployeeUsername2>iQmetrix.Employee</EmployeeUsername2>
    <PaymentName>Cash</PaymentName>
    <CreditCardPaymentType></CreditCardPaymentType>
    <PaymentReconciled>No</PaymentReconciled>
    <Cashout></Cashout>
    <Reconciliation></Reconciliation>
    <DepositNumber>100.00</DepositNumber>
    <ActualTotal>1884.1</ActualTotal>
    <SystemTotal>0</SystemTotal>
    <Skim>0</Skim>
    <Float>0</Float>
    <DifferenceTotal>1884.1</DifferenceTotal>
    <TransactionQuantity>0</TransactionQuantity>
    <CashAndCheque>1884.1</CashAndCheque>
    <FloatRetained>0</FloatRetained>
    <DepositAmount>1884.1</DepositAmount>
    <CashInAmount>0</CashInAmount>
    <BankDetails></BankDetails>
  </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
CashOutID,CashOutIDByStore,StoreName,Reconciled,StartDate,StopDate,EmployeeName1,EmployeeUsername1,EmployeeName2,EmployeeUsername2,PaymentName,CreditCardPaymentType,PaymentReconciled,Cashout,Reconciliation,DepositNumber,ActualTotal,SystemTotal,Skim,Float,DifferenceTotal,TransactionQuantity,CashAndCheque,FloatRetained,DepositAmount,CashInAmount,BankDetails
13775,84WEACA649,84 West,No,2012-08-20T18:18:52.023,2015-02-24T13:40:33.21,iQmetrix Employee,iQmetrix.Employee,iQmetrix Employee,iQmetrix.Employee,Cash,,No,,,100.00,1884.1,0,0,0,1884.1,0,1884.1,0,1884.1,0,

Example Response (Excel)

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

GET the Charge Back Summary Report

For more information, see Charge Back Summary Report.

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

Report Part Response
1 ChargeBackSummaryReportLocationData
2 ChargeBackSummaryReportCategoryData
3 ChargeBackSummaryReportProductSummaryData
4 ChargeBackSummaryReportProductDetailData
5 ChargeBackSummaryReportEmployeeData
6 ChargeBackSummaryReportHardwareCollectionData

Definition

GET /reports/chargebacksummaryreport?SearchMethod={SearchMethod}&CategoryNumber={CategoryNumber}&InvoiceStartDate={InvoiceStartDate}&InvoiceStopDate={InvoiceStopDate}&ChargeBackStartDate={ChargeBackStartDate}&ChargeBackStopDate={ChargeBackStopDate}&JournalIDs={JournalIDs}&QueryPart={QueryPart}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ProductIdentifier={ProductIdentifier}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/chargebacksummaryreport?SearchMethod=1&CategoryNumber=10&InvoiceStartDate=1970-01-01T06:00:00.000Z&InvoiceStopDate=2016-01-01T06:00:00.000Z&ChargeBackStartDate=1970-01-01T06:00:00.000Z&ChargeBackStopDate=2016-01-01T06:00:00.000Z&JournalIDs=-1&QueryPart=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/chargebacksummaryreport?SearchMethod=1&CategoryNumber=10&InvoiceStartDate=1970-01-01T06:00:00.000Z&InvoiceStopDate=2016-01-01T06:00:00.000Z&ChargeBackStartDate=1970-01-01T06:00:00.000Z&ChargeBackStopDate=2016-01-01T06:00:00.000Z&JournalIDs=-1&QueryPart=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheChargeBackSummaryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/chargebacksummaryreport?SearchMethod=1&CategoryNumber=10&InvoiceStartDate=1970-01-01T06:00:00.000Z&InvoiceStopDate=2016-01-01T06:00:00.000Z&ChargeBackStartDate=1970-01-01T06:00:00.000Z&ChargeBackStopDate=2016-01-01T06:00:00.000Z&JournalIDs=-1&QueryPart=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us");
    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 GettingTheChargeBackSummaryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/chargebacksummaryreport?SearchMethod=1&CategoryNumber=10&InvoiceStartDate=1970-01-01T06:00:00.000Z&InvoiceStopDate=2016-01-01T06:00:00.000Z&ChargeBackStartDate=1970-01-01T06:00:00.000Z&ChargeBackStopDate=2016-01-01T06:00:00.000Z&JournalIDs=-1&QueryPart=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us");
     
    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/reports/chargebacksummaryreport?SearchMethod=1&CategoryNumber=10&InvoiceStartDate=1970-01-01T06:00:00.000Z&InvoiceStopDate=2016-01-01T06:00:00.000Z&ChargeBackStartDate=1970-01-01T06:00:00.000Z&ChargeBackStopDate=2016-01-01T06:00:00.000Z&JournalIDs=-1&QueryPart=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ChargeBackSummaryReportLocationData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Quantity": 1,
        "StoreID": 6679,
        "StoreName": "100: My Network LLC - Anchorage",
        "TotalValue": -100
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Quantity": 1,
            "StoreID": 6679,
            "StoreName": "100: My Network LLC - Anchorage",
            "TotalValue": -100
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Quantity>1</Quantity>
    <StoreID>6679</StoreID>
    <StoreName>100: My Network LLC - Anchorage</StoreName>
    <TotalValue>-100</TotalValue>
  </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
Quantity,StoreID,StoreName,TotalValue
1,6679,100: My Network LLC - Anchorage,-100

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 Outstanding Gift Cards Report

For more information see Outstanding Gift Cards Report.

Definition

GET /reports/outstandinggiftcardsreport?DateAsOf={DateAsOf}&CardType={CardType}&CustomerID={CustomerID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/outstandinggiftcardsreport?DateAsOf=2016-11-23T19:56:38.000Z&CardType=-1&CustomerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/outstandinggiftcardsreport?DateAsOf=2016-11-23T19:56:38.000Z&CardType=-1&CustomerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheOutstandingGiftCardsReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/outstandinggiftcardsreport?DateAsOf=2016-11-23T19:56:38.000Z&CardType=-1&CustomerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
    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 GettingTheOutstandingGiftCardsReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/outstandinggiftcardsreport?DateAsOf=2016-11-23T19:56:38.000Z&CardType=-1&CustomerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
     
    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/reports/outstandinggiftcardsreport?DateAsOf=2016-11-23T19:56:38.000Z&CardType=-1&CustomerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[OutstandingGiftCardsReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "SerialNumber": "7777085179051274",
        "DateSold": "2016-10-14T13:05:14.133",
        "CustomerName": "Bill Smith",
        "LastRedeemedGMT": "2016-10-14T19:30:37.063",
        "LastRedeemed": "2016-10-14T13:30:37.063",
        "RedeemedAt": "84 West",
        "RedeemedBy": "Bill Smith",
        "Balance": 77.52,
        "SaleInvoiceID": 634,
        "InvoiceIDByStore": "MIL44AH9",
        "ProductName": "iTunes 20",
        "ProductSKU": "ASBTHT000018",
        "InvoiceSerialMask": 6
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "SerialNumber": "7777085179051274",
            "DateSold": "2016-10-14T13:05:14.133",
            "CustomerName": "Bill Smith",
            "LastRedeemedGMT": "2016-10-14T19:30:37.063",
            "LastRedeemed": "2016-10-14T13:30:37.063",
            "RedeemedAt": "84 West",
            "RedeemedBy": "Bill Smith",
            "Balance": 77.52,
            "SaleInvoiceID": 634,
            "InvoiceIDByStore": "MIL44AH9",
            "ProductName": "iTunes 20",
            "ProductSKU": "ASBTHT000018",
            "InvoiceSerialMask": 6
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <SerialNumber>7777085179051274</SerialNumber>
    <DateSold>2016-10-14T13:05:14.133</DateSold>
    <CustomerName>Bill Smith</CustomerName>
    <LastRedeemedGMT>2016-10-14T19:30:37.063</LastRedeemedGMT>
    <LastRedeemed>2016-10-14T13:30:37.063</LastRedeemed>
    <RedeemedAt>84 West</RedeemedAt>
    <RedeemedBy>Bill Smith</RedeemedBy>
    <Balance>77.52</Balance>
    <SaleInvoiceID>634</SaleInvoiceID>
    <InvoiceIDByStore>MIL44AH9</InvoiceIDByStore>
    <ProductName>iTunes 20</ProductName>
    <ProductSKU>ASBTHT000018</ProductSKU>
    <InvoiceSerialMask>6</InvoiceSerialMask>
  </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,DateSold,CustomerName,LastRedeemedGMT,LastRedeemed,RedeemedAt,RedeemedBy,Balance,SaleInvoiceID,InvoiceIDByStore,ProductName,ProductSKU,InvoiceSerialMask
7777085179051274,2016-10-14T13:05:14.133,Bill Smith,2016-10-14T19:30:37.063,2016-10-14T13:30:37.063,84 West,Bill Smith,77.52,634,MIL44AH9,iTunes 20,ASBTHT000018,6

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 Transaction Report

Definition

GET /reports/paymentintegrationtransactionbydatereport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&LocationEntityIDs={LocationEntityIDs}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/paymentintegrationtransactionbydatereport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationEntityIDs=33484,33496,33490,33492
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[PaymentIntegrationTransactionReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "InvoiceID": 122337,
        "StoreInvoiceID": "84WEAIN5981",
        "CustomerName": "Alice Kim",
        "EmployeeName": "Sam Smith",
        "InvoiceTypeID": 1,
        "InvoiceType": "Invoice",
        "LocationEntityID": 14192,
        "AuthType": "Sale",
        "TransType": "Credit",
        "CardTypeID": 2,
        "CardType": "Visa",
        "RequestedAmount": 4,
        "EntryTypeID": 2,
        "EntryType": "Swiped",
        "MerchantNumber": "1111",
        "TerminalID": "90572837",
        "AuthDateUTC": "2015-01-28T16:31:58.877",
        "AuthorizationNumber": "ABS251",
        "AuthorizedAmount": 5,
        "ResponseMessage": "APPROVAL",
        "CardholderName": "John Test",
        "CardBin": "545454",
        "LastFourDigits": "5454",
        "TransactionResult": "Approved",
        "ReversedVoided": 0,
        "ReversedVoidedReason": "Auto Void from Incomplete Invoice",
        "VoidedByEmployeeEntityID": "512",
        "VoidedDate": "2015-01-30T16:31:58.877"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "InvoiceID": 122337,
            "StoreInvoiceID": "84WEAIN5981",
            "CustomerName": "Alice Kim",
            "EmployeeName": "Sam Smith",
            "InvoiceTypeID": 1,
            "InvoiceType": "Invoice",
            "LocationEntityID": 14192,
            "AuthType": "Sale",
            "TransType": "Credit",
            "CardTypeID": 2,
            "CardType": "Visa",
            "RequestedAmount": 4,
            "EntryTypeID": 2,
            "EntryType": "Swiped",
            "MerchantNumber": "1111",
            "TerminalID": "90572837",
            "AuthDateUTC": "2015-01-28T16:31:58.877",
            "AuthorizationNumber": "ABS251",
            "AuthorizedAmount": 5,
            "ResponseMessage": "APPROVAL",
            "CardholderName": "John Test",
            "CardBin": "545454",
            "LastFourDigits": "5454",
            "TransactionResult": "Approved",
            "ReversedVoided": 0,
            "ReversedVoidedReason": "Auto Void from Incomplete Invoice",
            "VoidedByEmployeeEntityID": "512",
            "VoidedDate": "2015-01-30T16:31:58.877"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <InvoiceID>122337</InvoiceID>
    <StoreInvoiceID>84WEAIN5981</StoreInvoiceID>
    <CustomerName>Alice Kim</CustomerName>
    <EmployeeName>Sam Smith</EmployeeName>
    <InvoiceTypeID>1</InvoiceTypeID>
    <InvoiceType>Invoice</InvoiceType>
    <LocationEntityID>14192</LocationEntityID>
    <AuthType>Sale</AuthType>
    <TransType>Credit</TransType>
    <CardTypeID>2</CardTypeID>
    <CardType>Visa</CardType>
    <RequestedAmount>4</RequestedAmount>
    <EntryTypeID>2</EntryTypeID>
    <EntryType>Swiped</EntryType>
    <MerchantNumber>1111</MerchantNumber>
    <TerminalID>90572837</TerminalID>
    <AuthDateUTC>2015-01-28T16:31:58.877</AuthDateUTC>
    <AuthorizationNumber>ABS251</AuthorizationNumber>
    <AuthorizedAmount>5</AuthorizedAmount>
    <ResponseMessage>APPROVAL</ResponseMessage>
    <CardholderName>John Test</CardholderName>
    <CardBin>545454</CardBin>
    <LastFourDigits>5454</LastFourDigits>
    <TransactionResult>Approved</TransactionResult>
    <ReversedVoided>0</ReversedVoided>
    <ReversedVoidedReason>Auto Void from Incomplete Invoice</ReversedVoidedReason>
    <VoidedByEmployeeEntityID>512</VoidedByEmployeeEntityID>
    <VoidedDate>2015-01-30T16:31:58.877</VoidedDate>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
InvoiceID,StoreInvoiceID,CustomerName,EmployeeName,InvoiceTypeID,InvoiceType,LocationEntityID,AuthType,TransType,CardTypeID,CardType,RequestedAmount,EntryTypeID,EntryType,MerchantNumber,TerminalID,AuthDateUTC,AuthorizationNumber,AuthorizedAmount,ResponseMessage,CardholderName,CardBin,LastFourDigits,TransactionResult,ReversedVoided,ReversedVoidedReason,VoidedByEmployeeEntityID,VoidedDate
122337,84WEAIN5981,Alice Kim,Sam Smith,1,Invoice,14192,Sale,Credit,2,Visa,4,2,Swiped,1111,90572837,2015-01-28T16:31:58.877,ABS251,5,APPROVAL,John Test,545454,5454,Approved,0,Auto Void from Incomplete Invoice,512,2015-01-30T16:31:58.877

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 Tax Details Report

For more information, see Tax Details Report.

This report has DYNAMIC COLUMNS, the resources returned by this report will include a column or property for every Tax defined in RQ.

Definition

GET /reports/taxdetailsreport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}

Headers

Example Request

GET /reports/taxdetailsreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[TaxDetailsReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "DateCreated": "2015-12-31T12:35:07.05",
        "SaleInvoiceID": 166519,
        "InvoiceIDByStore": "MIL44AH9",
        "TenderedBy": "John Test",
        "TenderedAt": "Cornwall",
        "CustomerName": "Alice Smith",
        "Comments": "Return",
        "Invoiced": -910.94,
        "Sales": -910.94,
        "Cost": -405.67,
        "Profit": -505.27,
        "Adjusted": "No",
        "Taxable": "Yes",
        "Refund": "Yes",
        "VendorRebates": 0,
        "VendorRebatesTax": 0,
        "Coupons": 0,
        "CouponsTax": 0,
        "YourPriceTaxableSales": -910.94,
        "ListPriceTaxableSales": 0,
        "GreaterOfTaxableSales": -69.94,
        "FlatTaxableSales": 0,
        "NonTaxableSales": 0,
        "TaxCollected": -59.79,
        "TaxExemptReasonCode": "",
        "TotalTaxPaidAmount": -59.79
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "DateCreated": "2015-12-31T12:35:07.05",
            "SaleInvoiceID": 166519,
            "InvoiceIDByStore": "MIL44AH9",
            "TenderedBy": "John Test",
            "TenderedAt": "Cornwall",
            "CustomerName": "Alice Smith",
            "Comments": "Return",
            "Invoiced": -910.94,
            "Sales": -910.94,
            "Cost": -405.67,
            "Profit": -505.27,
            "Adjusted": "No",
            "Taxable": "Yes",
            "Refund": "Yes",
            "VendorRebates": 0,
            "VendorRebatesTax": 0,
            "Coupons": 0,
            "CouponsTax": 0,
            "YourPriceTaxableSales": -910.94,
            "ListPriceTaxableSales": 0,
            "GreaterOfTaxableSales": -69.94,
            "FlatTaxableSales": 0,
            "NonTaxableSales": 0,
            "TaxCollected": -59.79,
            "TaxExemptReasonCode": "",
            "TotalTaxPaidAmount": -59.79
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <DateCreated>2015-12-31T12:35:07.05</DateCreated>
    <SaleInvoiceID>166519</SaleInvoiceID>
    <InvoiceIDByStore>MIL44AH9</InvoiceIDByStore>
    <TenderedBy>John Test</TenderedBy>
    <TenderedAt>Cornwall</TenderedAt>
    <CustomerName>Alice Smith</CustomerName>
    <Comments>Return</Comments>
    <Invoiced>-910.94</Invoiced>
    <Sales>-910.94</Sales>
    <Cost>-405.67</Cost>
    <Profit>-505.27</Profit>
    <Adjusted>No</Adjusted>
    <Taxable>Yes</Taxable>
    <Refund>Yes</Refund>
    <VendorRebates>0</VendorRebates>
    <VendorRebatesTax>0</VendorRebatesTax>
    <Coupons>0</Coupons>
    <CouponsTax>0</CouponsTax>
    <YourPriceTaxableSales>-910.94</YourPriceTaxableSales>
    <ListPriceTaxableSales>0</ListPriceTaxableSales>
    <GreaterOfTaxableSales>-69.94</GreaterOfTaxableSales>
    <FlatTaxableSales>0</FlatTaxableSales>
    <NonTaxableSales>0</NonTaxableSales>
    <TaxCollected>-59.79</TaxCollected>
    <TaxExemptReasonCode></TaxExemptReasonCode>
    <TotalTaxPaidAmount>-59.79</TotalTaxPaidAmount>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
DateCreated,SaleInvoiceID,InvoiceIDByStore,TenderedBy,TenderedAt,CustomerName,Comments,Invoiced,Sales,Cost,Profit,Adjusted,Taxable,Refund,VendorRebates,VendorRebatesTax,Coupons,CouponsTax,YourPriceTaxableSales,ListPriceTaxableSales,GreaterOfTaxableSales,FlatTaxableSales,NonTaxableSales,TaxCollected,TaxExemptReasonCode,TotalTaxPaidAmount
2015-12-31T12:35:07.05,166519,MIL44AH9,John Test,Cornwall,Alice Smith,Return,-910.94,-910.94,-405.67,-505.27,No,Yes,Yes,0,0,0,0,-910.94,0,-69.94,0,0,-59.79,,-59.79

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

Definition

GET /lists/entrytypes?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/entrytypes?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[EntryType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "EntryTypeID": 1,
        "EntryTypeDescription": "Swiped",
        "Message": "Swiped"
    }
]

Example Response (JsonDataTable)

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

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <EntryTypeID>1</EntryTypeID>
    <EntryTypeDescription>Swiped</EntryTypeDescription>
    <Message>Swiped</Message>
  </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
EntryTypeID,EntryTypeDescription,Message
1,Swiped,Swiped

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

Definition

GET /lists/cardtypes

Headers

Example Request

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

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

puts response

Response Parameters

Array[CardType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CardTypeID": 2,
        "FullName": "Mastercard",
        "Mnemonic": "MC",
        "AccountNumberLength": 16,
        "CvvLength": 3
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CardTypeID": 2,
            "FullName": "Mastercard",
            "Mnemonic": "MC",
            "AccountNumberLength": 16,
            "CvvLength": 3
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CardTypeID>2</CardTypeID>
    <FullName>Mastercard</FullName>
    <Mnemonic>MC</Mnemonic>
    <AccountNumberLength>16</AccountNumberLength>
    <CvvLength>3</CvvLength>
  </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
CardTypeID,FullName,Mnemonic,AccountNumberLength,CvvLength
2,Mastercard,MC,16,3

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 Bill Pay Provider IDs

Definition

GET /lists/BillPayProviderID

Headers

Example Request

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

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

puts response

Response Parameters

Array[BillPayProviderID]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ProviderID": 1,
        "ProviderName": "Simplified Bill Payment"
    }
]

Example Response (JsonDataTable)

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

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ProviderID>1</ProviderID>
    <ProviderName>Simplified Bill Payment</ProviderName>
  </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
ProviderID,ProviderName
1,Simplified Bill Payment

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?