API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

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

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

Rate Limiting

Example

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

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

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

ENDPOINTS

RESOURCES

ActivationGrossProfitReportData

[
    {
        "InvoiceDate": "2016-10-12T09:16:24.63",
        "InvoiceID": 129920,
        "InvoiceIDByStore": "84WEAIN15624",
        "StoreTypeName": "Retail Store",
        "LocationName": "84 West",
        "Profit": 667.99,
        "CustomerID": 108560,
        "CustomerName": "AAA AND ASSOCIATES",
        "PhoneDescription": "Apple iPhone 6 Plus 16GB White - AT&T",
        "PhoneNumber": "3065014785",
        "TermDescription": "CRU 2 YR Business New Act",
        "RatePlanDescription": "2 YR CRU Business Legacy Plan $0.01 - $9.99",
        "VendorAccountName": "AT&T",
        "EmployeeName": "iQmetrix User",
        "DistrictName": "Valley Area District",
        "RegionName": "Region A",
        "ChannelName": "Regina Channel"
    }
]
Name Description
InvoiceDate (DateTime) Date - date of the transaction
InvoiceID (INT) Identifier for an invoice in RQ
InvoiceIDByStore (VARCHAR(14)) Invoice # - invoice number of the transaction
StoreTypeName (NVARCHAR(MAX)) Location Type - location type where the transaction was performed
LocationName (NVARCHAR(MAX)) Location - location where the transaction occurred
Profit (MONEY) Profit - amount of profit made on the activation, includes the total profit for the parameters run
CustomerID (INT) Identifier for the customer in RQ
CustomerName (VARCHAR(151)) Customer - name of the customer on the invoice
PhoneDescription (NVARCHAR(MAX)) Phone - phone used in the activation
PhoneNumber (VARCHAR(30)) Phone # - phone number entered into the Phone Activation Wizard
TermDescription (NVARCHAR(MAX)) Term - term selected with the activation
RatePlanDescription (NVARCHAR(MAX)) Rate Plan - rate plan selected for the activation
VendorAccountName (VARCHAR(100)) Vendor Account - vendor account used in the activation
EmployeeName (VARCHAR(51)) Employee - sales person on the invoice
DistrictName (NVARCHAR(MAX)) District - district the store is in
RegionName (NVARCHAR(MAX)) Region - region the store is in
ChannelName (NVARCHAR(MAX)) Channel - channel the store is in

CouponSummaryReportData

[
    {
        "Date": "2016-01-01T00:00:00",
        "QuantityApplied": 1,
        "QuantityRefunded": 1,
        "NetQuantity": 0,
        "TotalValue": -10
    }
]
Name Description
Date (DateTime) Date - every day in the date range selected
QuantityApplied (INT) Qty Applied - total quantity of coupons applied for the day
QuantityRefunded (INT) Qty Refunded - total quantity of coupons refunded for the day
NetQuantity (INT) Net Qty - net quantity of coupons for the day calculated as Qty Applied - Qty Refunded
TotalValue (MONEY) Total Value - net dollar value of all coupons for the day

CustomerListReportData

[
    {
        "Address": "12 Hello St.",
        "Address2": "n/a",
        "BillingAccountNumber": "",
        "City": "Fargo",
        "ContactNumber": "5555555555",
        "ContactTypeName": "",
        "Country": "United States",
        "CustomerCompanyName": "KENTEL",
        "CustomerFirstName": "Carrie",
        "CustomerID": 2108754,
        "CustomerLastName": "Madison",
        "DateCreated": "2016-01-26T20:55:53.227",
        "DeclineToProvideEmail": false,
        "Email": "carry@test.iq",
        "EmployeeName": "iQmetrix Employee",
        "EmployeeNameAssignedTo": "iQmetrix Employee",
        "IndustryTypeName": "",
        "MultiLevelPriceID": 1,
        "NumberOfActivations": 0,
        "PositionTypeName": "",
        "PostalCode": "90123",
        "Province": "ND",
        "TracPointMemberNumber": "C2981754hduw",
        "TypeOfCustomer": 3,
        "VIPCustomer": 0
    }
]
Name Description
Address (VARCHAR(50)) Address - first line of the address
Address2 (VARCHAR(50)) Address 2 - second line of the address, if necessary
BillingAccountNumber (NVARCHAR(MAX)) BAN -  if your company uses BAN you will enter it in the Customer profile and it will show here
City (VARCHAR(50)) City - customer’s city
ContactNumber (VARCHAR(200)) Contact # - the number that is selected on the customer’s profile, it can be any of the number options there
ContactTypeName (NVARCHAR(MAX)) Contact Type - as defined in General Customer Setup and assigned in the Custom Fields section on the customer’s profile
Country (VARCHAR(50)) Country - customer’s country
CustomerCompanyName (VARCHAR(50)) Company Name - may be blank depending on the kind of customer
CustomerFirstName (VARCHAR(50)) First Name - may be blank depending on the kind of customer
CustomerID (INT) Identifier for a Customer in RQ
CustomerLastName (VARCHAR(50)) Last Name - may be blank depending on the kind of customer
DateCreated (DateTime) Created On - day and time the customer’s profile was created
DeclineToProvideEmail (BIT) Decline Email - the option for customers to decline email
Email (VARCHAR(200)) Email - may be blank, if so, the context menu will not have the Email Customer option
EmployeeName (VARCHAR(51)) Created By - employee who created the profile
EmployeeNameAssignedTo (VARCHAR(51)) Assigned To - may be blank if the customer has not been assigned to an employee
IndustryTypeName (NVARCHAR(MAX)) Industry Type - as defined in General Customer Setup and assigned in the Custom Fields section on the customer’s profile
MultiLevelPriceID (INT) Pricing Group - as defined in Multi-Level Pricing - Setup and assigned in the Discount Level field in the More Information section on the customer’s profile
NumberOfActivations (INT) # of Activations - number of Activations the customer has completed as recorded in RQ
PositionTypeName (NVARCHAR(MAX)) Position Type - as defined in General Customer Setup and assigned in the Custom Fields section on the customer’s profile
PostalCode (VARCHAR(15)) Zip/Postal Code - zip code (USA) or postal code (Canada)
Province (VARCHAR(50)) State/Province - customer’s state or province
TracPointMemberNumber (VARCHAR(30)) Member # - this number is automatically generated when a new customer is created
TypeOfCustomer (INT) Type Of Customer - 0 for Company, or 3 for Individual
VIPCustomer (TINYINT) VIP Customer - will be checked if this is a VIP Customer

EmployeeMasterListReportData

[
    {
        "Assigned Groups": "Sales Representative",
        "Assigned Locations": "84 West Target Dothan Wiregrass Commons Mall - Test Long Store Name Here",
        "City": "Dothan",
        "Clear Fingerprints": "No",
        "Commission Group": "Sales Representative",
        "Compensation Type": "Commission",
        "Country": "USA",
        "Disabled": "No",
        "Email Address": "hilary@kentel.com",
        "Email Display Name": "hilary@kentel.com",
        "Email Password": "test",
        "Email Server": "outlook.kentel.com",
        "Email User Name": "hilary",
        "Employee ID": 60,
        "Employee Name": "Hillary Oliver",
        "Fingerprint Enabled": "No",
        "Frequency": "N/A",
        "FrequencyEffective": "Jan 10 2011",
        "Gender": "Male",
        "ID #": "912345987654321",
        "Image Uploaded": "No",
        "Internal": "N/A",
        "Intrgration Username": "hilary.kentel",
        "Job Title": "Wireless Consultant",
        "Language": "en-us",
        "Locked": "No",
        "Part Time": 0,
        "Personal Days Available": 0,
        "Personal Email": "hilary@kentel.com",
        "Primary Location": "Corporate Office",
        "Rate Effective": "Jan 10 2011",
        "Rate": 0,
        "Role": "Store Manager",
        "Security Role": "Sales Representative",
        "Sick Days Available": 0,
        "Start Date": "Dec 05 2010",
        "State / Prov": "AL",
        "Supervisor": "Robyn Roberts",
        "Termination Date": "Today",
        "Termination Notes": "Vacation days to be paid",
        "Username": "Hillary.Oliver",
        "Vacation Days Available": 0,
        "Work #": "3347020770"
    }
]
Name Description
Assigned Groups (NVARCHAR(MAX)) Assigned Groups - states the groups assigned to the employee
Assigned Locations (NVARCHAR(MAX)) Assigned Locations - states the locations assigned to the individual
City (VARCHAR(50)) City - city of the employee as entered on their profile
Clear Fingerprints (VARCHAR(2)) Clear Fingerprints - this will allow you to clear fingerprints
Commission Group (VARCHAR(50)) Commission Group - commission group of the employee as entered on their profile
Compensation Type (VARCHAR(21)) Compensation Type - compensation type of the employee as entered on their profile
Country (VARCHAR(50)) Country - country of the employee as entered on their profile
Disabled (VARCHAR(3)) Disabled - indicates whether or not the employee is disabled
Email Address (VARCHAR(50)) Email Address - email address of the employee as entered on their profile (in the Email Settings section)
Email Display Name (VARCHAR(50)) Email Display Name - email display name of the employee as entered on their profile (in the Email Settings section)
Email Password (VARCHAR(1)) Email Password - email password of the employee as entered on their profile (in the Email Settings section)
Email Server (VARCHAR(50)) Email Server - email server of the employee as entered on their profile (in the Email Settings section)
Email User Name (VARCHAR(50)) Email Username -email username of the employee as entered on their profile (in the Email Settings section)
Employee ID (INT) Identifier for the employee in RQ
Employee Name (VARCHAR(51)) Employee Name - name of the employee as entered on their profile
Fingerprint Enabled (VARCHAR(3)) Fingerprint Entered - indicates if the employee has fingerprints entered
Frequency (VARCHAR(12)) Frequency - compensation frequency of the employee as entered on their profile
FrequencyEffective (NVARCHAR(4000)) Frequency Effective - the frequency effective date of the employee as entered on their profile
Gender (VARCHAR(9)) Gender - gender of the employee as entered on their profile
ID # (VARCHAR(25)) ID # - employees ID listed under the admin tab of the profile
Image Uploaded (VARCHAR(3)) Image Uploaded - indicates if the employee has a profile picture uploaded
Internal (VARCHAR(12)) Interval - compensation interval of the employee as entered on their profile
Intrgration Username (VARCHAR(255)) Username
Job Title (VARCHAR(50)) Job Title - job title of the employee as entered on their profile
Language (VARCHAR(255)) Language - employees primary language
Locked (VARCHAR(3)) Locked - employee is locked so they can not be accessed
Part Time (INT) Part Time - indicates if the employee is part time
Personal Days Available (INT) Personal Days Available - will state the personal days available
Personal Email (VARCHAR(50)) Personal Email - personal email of the employee as entered on their profile
Primary Location (NVARCHAR(MAX)) Primary Location - primary location of the employee as entered on their profile
Rate Effective (NVARCHAR(4000)) Rate Effective - rate effective date of the employee as entered on their profile
Rate (MONEY) Rate - compensation rate of the employee as entered on their profile
Role (VARCHAR(1)) Role - role of the employee as entered on their profile
Security Role (NVARCHAR(MAX)) Security Role - security role of the employee as entered on their profile
Sick Days Available (INT) Sick Days Available - will state the sick days available
Start Date (NVARCHAR(4000)) Start Date - the start date of the employee
State / Prov (VARCHAR(50)) State/Prov - state or province of the employee as entered on their profile
Supervisor (VARCHAR(51)) Supervisor - supervisor of the employee as entered on their profile
Termination Date (NVARCHAR(4000)) Termination Date - states the termination date of the employee
Termination Notes (VARCHAR(255)) Termination Notes - states the notes for the termination
Username (VARCHAR(51)) Username - username of the employee as entered in their profile
Vacation Days Available (INT) Vacation Days Available - will state the vacation days available
Work # (VARCHAR(50)) Work # - work number of the employee as entered on their profile

GraphedPerformanceMetrixReportData

[
    {
        "ID": 6,
        "Name": "51247 Test_update",
        "AttachmentRate": "1249 : 2",
        "AttachmentRateTarget": "0 : 0",
        "DisplayFormat": 2,
        "IsAttachmentRate": true,
        "Margin": null,
        "MarginTarget": null,
        "Priority": -1,
        "Profit": null,
        "ProfitTarget": null,
        "Quantity": null,
        "QuantityTarget": null,
        "Sales": null,
        "SalesTarget": null
    }
]
Name Description
ID (INT) Identifier for a performance metrix group in RQ
Name (NVARCHAR(MAX)) Name of a performance metrix group in RQ
AttachmentRate (VARCHAR(23)) Comparison of Performance Groups for the Attachment Rate displayed as a ratio
AttachmentRateTarget (VARCHAR(23)) Attachment rate target
DisplayFormat (INT) 1: Ratio Format, 2: Percentage Format
IsAttachmentRate (BIT) A flag to indicate if performance group is an attachment rate
Margin (MONEY) Margin on sales in this performance group
MarginTarget (MONEY) Margin target
Priority (INT) Priority
Profit (MONEY) Net profit amount of sales in this performance group
ProfitTarget (MONEY) Profit target
Quantity (INT) Net count of SKUs sold in this performance group
QuantityTarget (INT) Quantity target
Sales (MONEY) Net dollar amount of sales in this performance group
SalesTarget (MONEY) Sales target

GraphedPerformanceMetrixBreakdownReportData

[
    {
        "ID": 1,
        "Name": "84 West",
        "GroupInvoiceCount": 839,
        "IsAttachmentRate": false,
        "Margin": -1691.5747,
        "MarginTarget": 0,
        "Profit": -45860859.08,
        "ProfitTarget": 0,
        "Quantity": 530,
        "QuantityTarget": 0,
        "Sales": 27111.34,
        "SalesTarget": 0,
        "TotalInvoiceCount": 2772
    }
]
Name Description
ID (INT) Internal idenfier in RQ
Name (NVARCHAR(MAX)) Name of company, region, division, location or employee depending on ByWho URL parameter
GroupInvoiceCount (INT) This number represents the size of the section of pie graph
IsAttachmentRate (BIT) A flag to indicate if performance group is an attachment rate
Margin (MONEY) Margin
MarginTarget (DECIMAL) Margin target
Profit (MONEY) Profit
ProfitTarget (MONEY) Profit target
Quantity (INT) Quantity
QuantityTarget (INT) Quantity target
Sales (MONEY) Total sales
SalesTarget (MONEY) Sales target
TotalInvoiceCount (INT) This number represents the total size of the graph

LocationMasterListReportData

[
    {
        "Abbreviation": "LIT22",
        "Address": "4970 Hillside Avenue",
        "AddressVerified": "Not Verified",
        "AdjustDST": false,
        "BankDetails": "CashSmart",
        "CashPolicy": "Single-Drawer",
        "ChannelName": "Alabama",
        "City": "Kansas",
        "Comment_on_OE": false,
        "Country": "United States",
        "DepositTaken": 0,
        "Disabled": 1,
        "DistrictName": "Smithton",
        "EmailAddress": "abarea@kentel.com",
        "FaxNumber": "5555555555",
        "GeneralLocationNotes": "note",
        "GLCode": "-MILLH",
        "HideCustomerAddress": false,
        "InsuranceAmount": 0,
        "InsuranceCompany": "Safefair",
        "LandlordName": "Jim Jones",
        "LandlordNotes": "sample note",
        "Latitude": 50.443559,
        "LeaseEndDate": "2014-12-24T00:00:00",
        "LeaseNotes": "note",
        "LeaseStartDate": "2014-11-26T00:00:00",
        "LocationCode": "500",
        "LocationEntityID": 48540,
        "Longitude": -104.612034,
        "ManagerCommissionable": false,
        "ManagerEmployeeID": 233,
        "MaxCashDrawer": 0,
        "OtherCharges": 0,
        "PAW_on_OE": false,
        "Phone_on_OE": true,
        "PhoneNumber": "4353424234",
        "PropertyTaxes": 0,
        "RegionName": "Abarea",
        "RelocationDate": "2016-02-26T00:00:00",
        "Rent": 0,
        "SaleInvoiceComment": "Sale Invoice Comments",
        "Serial_on_OE": false,
        "SquareFootage": 0,
        "StaffLevel": 12,
        "StateProv": "AL",
        "StoreID": 1187,
        "StoreName": "Dufferin Mall",
        "StoreType": "Retail Store",
        "Taxes": "GOODS AND SERVICES TAX (GST)",
        "TimeZone": "(GMT-06:00) Saskatchewan",
        "UseLocationEmail": false,
        "ZipPostal": "90210"
    }
]
Name Description
Abbreviation (VARCHAR(5)) Abbreviation - this cannot be edited
Address (NVARCHAR(MAX)) Address - address assigned to location
AddressVerified (VARCHAR(12)) Address Verified - if the address can not be verified then you will have the option to edit the Latitude and Longitude to verify it
AdjustDST (BIT) Adjust DST - check if the location adjusts for daylight savings
BankDetails (NVARCHAR(MAX)) Bank Details - the Banks name for the location
CashPolicy (VARCHAR(13)) Cash Policy - states the cash policy (single/multi-drawer)
ChannelName (NVARCHAR(MAX)) Channel - channel the region is assigned to
City (VARCHAR(50)) City - city the location resides in
Comment_on_OE (BIT) Comment on OE - show product and location comments on sales order
Country (VARCHAR(50)) Country - country the location is located in
DepositTaken (MONEY) Deposit Taken - lists the deposit if applicable
Disabled (INT) Disable - indicates if the location is enabled or disabled
DistrictName (NVARCHAR(MAX)) District - district the location is assigned to
EmailAddress (VARCHAR(255)) Email Address - email address assigned to the location
FaxNumber (VARCHAR(10)) Fax # - Fax # listed under the location
GeneralLocationNotes (VARCHAR(255)) General Location Notes - notes specific to the location
GLCode (VARCHAR(100)) Code - coded associated to the location
HideCustomerAddress (BIT) Hide Customer Address - prevents the customers address from being seen on an invoice
InsuranceAmount (MONEY) Insurance - cost of Insurance
InsuranceCompany (NVARCHAR(MAX)) Insurance Company - name of the insurance company
LandlordName (NVARCHAR(MAX)) Landlord Name - name of the landlord
LandlordNotes (NVARCHAR(MAX)) Landlord Notes - notes specific to the landlord
Latitude (DECIMAL) Latitude - latitude location of the store
LeaseEndDate (DateTime) Lease End Date - the day the lease ends
LeaseNotes (NVARCHAR(MAX)) Lease Notes - notes specific to the lease
LeaseStartDate (DateTime) Lease Start Date - day the lease started
LocationCode (VARCHAR(100)) Location Code - code entered in the property details tab in the Location Setup
LocationEntityID (INT) Identifier of the store as a Location in Entity Store
Longitude (DECIMAL) Longitude - longitude location of the store
ManagerCommissionable (BIT) Manager Commissionable - indicates if the manager is commissionable.
ManagerEmployeeID (INT) Manager - manager assigned to the location
MaxCashDrawer (MONEY) Max Cash Drawer - maximum amount of cash allowed in a cash drawer
OtherCharges (MONEY) Other Charges - other charges associated to the location
PAW_on_OE (BIT) PAW on OE - launch PAW on sales orders
Phone_on_OE (BIT) Force phone number for entry on sales orders
PhoneNumber (VARCHAR(10)) Phone # - designated number for the location
PropertyTaxes (MONEY) Property Taxes - applicable property taxes
RegionName (NVARCHAR(MAX)) Region - region the district is assigned to
RelocationDate (DateTime) Relocation Date - lists the date of the relocation if applicable
Rent (MONEY) Rent - rent amount for the location
SaleInvoiceComment (NVARCHAR(MAX)) Sale Invoice Comment - locations sales invoice comment
Serial_on_OE (BIT) Serial # on OE - force serial # for entry on sales orders
SquareFootage (INT) Square Feet - approx square feet of the store
StaffLevel (DECIMAL) Staff Level - designated staffing level for the location
StateProv (NVARCHAR(3)) State/Prov - state or province the location is located in
StoreID (INT) Internal identifier for the store in RQ
StoreName (NVARCHAR(MAX)) Store Name - name of the store
StoreType (NVARCHAR(MAX)) Store Type - will state the store type
Taxes (NVARCHAR(MAX)) Taxes - taxes assigned to the location
TimeZone (VARCHAR(200)) Time Zone - time zone assigned to location
UseLocationEmail (BIT) Use Location for Email - use the location for the email contact
ZipPostal (VARCHAR(15)) Zip/Postal - zip/postal for the location

ProductDetailReportData

[
    {
        "Activation_RowID": "d3d65281-5201-4927-9bac-6f3a47ddf56b",
        "AdjustedUnitPrice": 25,
        "BillingAccountNumber": "",
        "CarrierPrice": null,
        "CategoryPath": ">> Phones >> Galaxies",
        "ChannelName": "English Channel",
        "Comments": "",
        "ContractNumber": "12345",
        "CustomerID": 131149,
        "CustomerName": "Bob Jones",
        "DateCreated": "2016-05-13T12:18:08.723",
        "DistrictName": "Westminster",
        "EmployeeName": "iQmetrix User",
        "EmployeeID": 4,
        "GlobalProductID": 5179,
        "InvoicedAt": "100: My Network LLC - Anchorage",
        "InvoicedAt_StoreID": 1,
        "InvoicedBy": "100: My Network LLC - Anchorage",
        "InvoicedBy_StoreID": 1,
        "InvoiceIDByStore": "77224IN3",
        "IsOrderServiceDropShipProduct": null,
        "IsOrderServiceShippingProduct": null,
        "ListPrice": 449.95,
        "OriginalUnitPrice": 25,
        "Priority": 1,
        "ProductCouponDiscount": 0,
        "ProductIdentifier": "ASHCSA000120",
        "ProductName": "Samsung Galaxy Rugby LTE",
        "Quantity": 1,
        "Refund": 0,
        "RegionName": "London",
        "RetailerCatalogID": "null",
        "SaleInvoice_RowID": "8c6537ae-75a5-4155-82b2-c8647ed05f3d",
        "SaleInvoiceID": 128962,
        "SaleInvoiceProduct_RowID": "0099b78f-ba02-4a91-afd4-2f7eb0fbbb06",
        "SerialNumber": "1111111",
        "SoldAsUsed": false,
        "SpecialProductID": 0,
        "StoreInStoreFlowIsEnabledForStore": false,
        "StoreInStoreGrossProfit": null,
        "StoreInStoreListPrice": null,
        "StoreInStorePrice": null,
        "StoreTypeName": "Costco",
        "TenderedBy": "iQmetrix User",
        "TenderedBy_EmployeeID": 277,
        "TotalCost": 0,
        "TotalDiscount": 424.95,
        "TotalPrice": 25,
        "UnitCost": 0,
        "UnitPrice": 25,
        "VendorName": "",
        "VendorSKU": ""
    }
]
Name Description
Activation_RowID (UNIQUEIDENTIFIER) Internal identifier in RQ
AdjustedUnitPrice (MONEY) Adjusted Unit Price - price that the product was actually sold for
BillingAccountNumber (NVARCHAR(MAX)) BAN -  if your company uses BAN you will enter it in the Customer profile and it will show here
CarrierPrice (MONEY) Carrier Price - value or revenue that a carrier assigns this feature
CategoryPath (NVARCHAR(MAX)) Category - the category the product belongs to
ChannelName (NVARCHAR(MAX)) Channel - channel for the rows location
Comments (TEXT) Invoice Comments - comments added to the invoice
ContractNumber (VARCHAR (50)) Contract # - number of the contract, recorded at the time of sale
CustomerID (INT) Internal identifier for a customer in RQ
CustomerName (VARCHAR (101)) Customer - name of the customer as entered on their profile
DateCreated (DateTime) Sold On - date and time the invoice was tendered
DistrictName (NVARCHAR(MAX)) District - district for the rows location
EmployeeName (VARCHAR (51)) Sold By - name of the employee of record for the sale, i.e. the employee whose name is in the Commission box
EmployeeID (INT) Internal identifier for an employee in RQ
GlobalProductID (INT) Internal identifier in RQ
InvoicedAt (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
InvoicedAt_StoreID (INT) Internal identifier for a store in RQ
InvoicedBy (NVARCHAR(MAX)) 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
InvoicedBy_StoreID (INT) Internal identifier for a store in RQ
InvoiceIDByStore (VARCHAR (14)) Invoice # - invoice number assigned by RQ
IsOrderServiceDropShipProduct (BIT) Internal identifier in RQ
IsOrderServiceShippingProduct (BIT) Internal identifier in RQ
ListPrice (MONEY) List Price - current price as noted on the pricing tab in the inventory console for the product
OriginalUnitPrice (MONEY) Orig. Unit Price - original price on the invoice
Priority (INT) The order that the products were saved in on an Invoice
ProductCouponDiscount (MONEY) Coupon discount on the product
ProductIdentifier (VARCHAR(12)) Product SKU - the RQ generated SKU
ProductName (NVARCHAR(MAX)) Product Name - name of the product as it appears in the inventory
Quantity (INT) Qty - total number of times the Product SKU appears on the invoice
Refund (BIT) Refund - indicates if a negative quantity of this item was sold
RegionName (NVARCHAR(MAX)) Region - region for the rows location
RetailerCatalogID (VARCHAR (50)) Internal identifier in RQ
SaleInvoice_RowID (UNIQUEIDENTIFIER) Internal identifier in RQ
SaleInvoiceID (INT) Identifier for an invoice in RQ
SaleInvoiceProduct_RowID (UNIQUEIDENTIFIER) Internal identifier in RQ
SerialNumber (VARCHAR (100)) Tracking # - tracking number associated with this product, serialized products only
SoldAsUsed (BIT) Sold As Used - indicates the product was used when sold
SpecialProductID (INT) Internal identifier in RQ
StoreInStoreFlowIsEnabledForStore (BIT) Internal identifier in RQ
StoreInStoreGrossProfit (MONEY) SIS Gross Profit - profit, calculated as Total Sales - Cost for a SIS location.
StoreInStoreListPrice (MONEY) SIS List Price - Price from the store-in-store setup of the product
StoreInStorePrice (MONEY) SIS Price - The default price when sold through the store-in-store flow
StoreTypeName (NVARCHAR(MAX)) Location Type - the location type the the transaction was performed at
TenderedBy (VARCHAR (51)) Tendered By - name of the employee logged into RQ when the invoice was tendered
TenderedBy_EmployeeID (INT) Internal identifier for an employee in RQ
TotalCost (MONEY) Total Cost - total purchase cost for the product(s) on the invoice
TotalDiscount (DECIMAL (8, 4)) Total Discount - net discount amount for the Product SKU on the particular invoice
TotalPrice (MONEY) Total Sales - net dollar amount for the Product SKU on the particular invoice
UnitCost (MONEY) Unit Cost - purchase cost per unit
UnitPrice (MONEY) Sold For - price that appeared on the invoice (including hide on invoice items), i.e. negative if a refund
VendorName (NVARCHAR(MAX)) Name for a vendor in RQ
VendorSKU (VARCHAR(25)) Vendor SKU

ProductDetailReportTaxColumnData

[
    {
        "ColName": "T102",
        "ColCaption": "Flat tax",
        "CreditCardPaymentType": "null"
    }
]
Name Description
ColName (VARCHAR) Tax name
ColCaption (NVARCHAR(MAX)) Description
CreditCardPaymentType (VARCHAR (20)) Credit card information

ProductDetailReportTaxDetailData

[
    {
        "Amount": 22.5,
        "GlobalProductID": 5179,
        "Priority": 1,
        "SaleInvoiceID": 128996,
        "SerialNumber": "2222222",
        "TaxID": "T102",
        "TaxName": "Brad flat tax"
    }
]
Name Description
Amount (MONEY ) Amount
GlobalProductID (INT) Identifier of a Product in RQ
Priority (INT) Priority
SaleInvoiceID (INT) Identifier of a sale invoice in RQ
SerialNumber (VARCHAR (100) ) Serial number
TaxID (VARCHAR) Tax identifier
TaxName (NVARCHAR(MAX)) Tax name

SalesByCustomerReportData

[
    {
        "CustomerID": 57818,
        "CustomerName": "Ann Fox",
        "Customer_CompanyName": "KENTEL",
        "Customer_LastName": "Ann Fox",
        "CustomerAddress": "8105 Blanche Dr",
        "CustomerCity": "Panama City",
        "CustomerProvinceOrState": "FL",
        "CustomerCountry": "United States",
        "CustomerPostalCode": "32404",
        "CustomInteger1": "12",
        "CustomInteger2": "1",
        "CustomDate1": "2016-01-01T00:00:00",
        "CustomDate2": "2016-01-01T00:00:00",
        "CustomText1": "March",
        "CustomText2": "Orange",
        "CompanySize": "200",
        "CustomDropDown1": "2112",
        "CustomDropDown2": "Orange",
        "CustomDropDown3": "Three",
        "CustomDropDown4": "Ph.D",
        "CustomDropDown5": "Enabled",
        "TotalInvoiced": 1210.02,
        "Adjustment": 0,
        "TotalPrice": 1185.01,
        "TotalCost": 18.01,
        "TotalCoupon": 0,
        "TotalCouponTax": 0,
        "TotalProfit": 1167,
        "TotalDiscount": -784.01,
        "PercentProfit": 98.48,
        "QuantitySold": 18,
        "QuantityRefunded": -6,
        "NetQuantity": 12,
        "InvoicedAtDifferentLocation": 0,
        "CustomerIdentifier": "C10KNRVY",
        "BillingAccountNumber": "5555555555",
        "FinancedAmount": 0,
        "TotalDownPayment": 0,
        "TypeOfCustomer": 3
    }
]
Name Description
CustomerID (INT) Identifier for a customer in RQ
CustomerName (VARCHAR(151)) Customer - name of the customer as entered on their profile
Customer_CompanyName (VARCHAR(50)) Company name
Customer_LastName (VARCHAR(50)) Customer last name
CustomerAddress (VARCHAR(101)) Address - column will contain the contents of the Address and Address 2 fields in the Customer profile (new in 5.17)
CustomerCity (VARCHAR(50)) City - name of the city entered on the customers profile
CustomerProvinceOrState (VARCHAR(50)) State/Province - state or province selected from the drop down list on the customer’s profile
CustomerCountry (VARCHAR(50)) Country - name of the country entered on the customers profile
CustomerPostalCode (VARCHAR(15)) ZIP/Postal Code - zip or postal code as entered on the customers profile
CustomInteger1 (VARCHAR(20)) Custom value
CustomInteger2 (VARCHAR(20)) Custom value
CustomDate1 (DateTime) Custom value
CustomDate2 (DateTime) Custom value
CustomText1 (VARCHAR(150)) Custom value
CustomText2 (VARCHAR(150)) Custom value
CompanySize (NVARCHAR(MAX)) Company Size - a Category Field which may or not be enabled on your database
CustomDropDown1 (NVARCHAR(MAX)) Custom value
CustomDropDown2 (NVARCHAR(MAX)) Custom value
CustomDropDown3 (NVARCHAR(MAX)) Custom value
CustomDropDown4 (NVARCHAR(MAX)) Custom value
CustomDropDown5 (NVARCHAR(MAX)) Custom value
TotalInvoiced (MONEY) Total Invoiced - net dollar amount for this category, and sub-categories, or this specific product sold to this customer within the report criteria
Adjustment (MONEY) Adjustment - net dollar amount of any adjustments for this customer in this category or for this product
TotalPrice (MONEY) Sales - total dollar amount for this category, and sub-categories, or this specific product sold to this customer for the report criteria after any adjustment(s)
TotalCost (MONEY) Cost - total inventory cost for the products sold to this customer within the report criteria
TotalCoupon (MONEY) Coupon - dollar amount of coupons used on sale
TotalCouponTax (MONEY) Coupon Taxes - dollar amount of taxes applied to the coupon
TotalProfit (MONEY) Gross Profit - total gross profit, calculated as Sales - Cost
TotalDiscount (MONEY) Total Discount - total dollar amount of discount(s) applied to the customers invoices within the report criteria
PercentProfit (MONEY) % Profit - gross profit displayed as a percentage
QuantitySold (INT) Qty Sold - total number of products from this category, and sub-categories, or number of this specific product sold to this customer within the report criteria
QuantityRefunded (INT) Qty Ref - total number of products from this category, and sub-categories, or number of this specific product refunded from this customer within the report criteria
NetQuantity (INT) Net Qty - net total number of products from this category, and sub-categories, or number of this specific product sold to this customer within the report criteria
InvoicedAtDifferentLocation (INT) Amount invoices at a different location
CustomerIdentifier (VARCHAR(25)) Customer Identifier - customer identifier as entered on the customers profile
BillingAccountNumber (NVARCHAR(MAX)) BAN - contract number from a carrier and not editable
FinancedAmount (DECIMAL) Financed amount
TotalDownPayment (DECIMAL) Total down payment
TypeOfCustomer (INT) Type of Customer - column will display the customer type - Company, Division, Group, Individual (new in 5.17)

SerializedCouponReportData

[
    {
        "CouponID": 1089,
        "Customer": "John Test",
        "CouponName": "RQ API FpP Serialized",
        "SerialNumber": "cpn00000",
        "Issued": "2015-06-04T10:18:38.403",
        "Percentage": "15",
        "Amount": 0,
        "CouponSKU": "COUPON001089",
        "SaleInvoiceID": 7,
        "InvoiceIDByStore": "84WEAIN15624",
        "CustomerID": 2108754
    }
]
Name Description
CouponID (INT) Identifier for a coupon in RQ
Customer (VARCHAR(101)) Customer - customer name (will only show if assigned to the Customer using the Marketing List Report). If not, column will state imported serial number
CouponName (NVARCHAR(MAX)) Coupon Name - name of the coupon, i.e. Serialized $50
SerialNumber (VARCHAR(50)) Serial Number - serial number of the coupon
Issued (DateTime) Issued - date coupon was issued
Percentage (VARCHAR(31)) Percentage - percentage of the discount of the invoice (will only have a value if the coupon is for a percentage of the invoice)
Amount (MONEY) Amount - total amount of the coupon (will only have a value if the coupon is for a specific value)
CouponSKU (VARCHAR(32)) Coupon SKU - the SKU attached to the coupon used to identify it
SaleInvoiceID (Integer) Identifier of the sale invoice which created this commission in RQ
InvoiceIDByStore (VARCHAR(14)) Invoice # - invoice number of the transaction
CustomerID (INT) Identifier for a Customer in RQ

VendorRebateHistoryReportData

[
    {
        "ActivationAssociationNumber": 2,
        "ActivationRowID": "0d4652a7-a673-437a-817e-4641961ba3e6",
        "Adjusted": "No",
        "AssociationNumber": 3,
        "CarrierPrice": 0,
        "ChannelName": "English Channel",
        "ChargeBack": "No",
        "Collected": null,
        "Comments": "",
        "Comments2": "null",
        "ContractNumber": "123456789",
        "CustomerID1": 130834,
        "CustomerName1": "Bob Jones",
        "DateCreated": "2016-01-04T14:33:15.737",
        "DateReconciled": "null",
        "DistrictName": "District B2",
        "EmployeeID": 0,
        "EmployeeID1": 218,
        "EmployeeName": "",
        "EmployeeName1": "iQmetrix User",
        "ExtraField": "1234567890",
        "Flagged": "No",
        "GlobalProductID": 812,
        "InvoiceComments": "",
        "InvoicedAt": "Regina Store",
        "InvoicedAt_StoreID": 1,
        "InvoicedBy": "Regina Store",
        "InvoicedBy_StoreID": 1,
        "InvoiceIDByStore": "HJKIIIN2",
        "InvoiceRowID": "db8f28cf-5017-47f4-9ccf-b90cff32185d",
        "JournalNumber": "",
        "OriginalSaleDate": "null",
        "OriginalSaleInvoiceID": null,
        "OriginalSaleInvoiceIDByStore": "null",
        "PartialCB": 0,
        "PortNumber": "",
        "Postal_code": "56789",
        "ProductIdentifier": "ACVZRB000001",
        "ProductName": "Verizon New Act_EquipmentRebate",
        "ProductRowID": "27be5c76-b0ba-4a34-ba7d-fa34aba0ab9c",
        "Quantity": 1,
        "RatePlan": "Act $9.99 to $20.98",
        "RatePlan2": "",
        "Reconciled": "No",
        "RegionID": 9,
        "RegionName": "Region B",
        "RelatedCost": 404,
        "RelatedPrice": 69.99,
        "RelatedProduct": "Samsung Galaxy S4",
        "RelatedProductSerialNumbers": "ACVZCB0026",
        "RelatedProductSKU": "ACVZCB000244",
        "SaleInvoiceID": 126526,
        "SerialNumber": "123000000000000",
        "SocCode": "123000000000000",
        "SocCode2": "",
        "SpecialIdentifier": "1",
        "SpecialIdentifier1": "",
        "TermCode": "",
        "TotalPrice": 0,
        "UnitPrice": 0,
        "VendorAccountName": "Verizon 2",
        "VendorName": "Verizon",
        "VendorNumber": "",
        "VendorSKU": ""
    }
]
Name Description
ActivationAssociationNumber (INT) Every product that is part of the same activation from the Phone Activation Wizard will have the same ActivationAssociationNumber.
ActivationRowID (UNIQUEIDENTIFIER) Identifier in RQ
Adjusted (VARCHAR(3)) Adjusted - indicates if the rebate was adjusted
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 that a carrier assigns this feature
ChannelName (VARCHAR(100)) Channel - channel for the rows location
ChargeBack (DateTime) Charge Back - Yes or No column for if it is a Charge Back or not
Collected (MONEY) Collected - amount received from the carrier
Comments (VARCHAR(500)) Comments - any comments that were added as part of the reconciliation process
Comments2 (VARCHAR(500)) Comments2 - any comments that were added as part of the reconciliation process
ContractNumber (VARCHAR(50)) Contract # - number of the contract, recorded at the time of sale
CustomerID1 (INT) Customer Identifier - customer identifier as entered on the customers profile
CustomerName1 (VARCHAR(101)) Customer - name of the customer as entered on their profile
DateCreated (DateTime) Sold On - date and time the invoice was tendered
DateReconciled (DateTime) Reconciled On - date and time the rebate was reconciled
DistrictName (VARCHAR(100)) District - district for the rows location
EmployeeID (INT) Internal identifier for an employee in RQ, see EmployeeName
EmployeeID1 (INT) Internal identifier for an employee in RQ, see EmployeeName1
EmployeeName (VARCHAR(51)) Reconciled By - name of the employee logged in when the rebate was reconciled
EmployeeName1 (VARCHAR(51)) Sales Person - name of the employee of record for the sale, i.e. the employee whose name is in the Commission box
ExtraField (VARCHAR(30)) Extra Field - an optional field
Flagged (VARCHAR(3)) Flagged - flagged in the Vendor Rebate Reconciliation screen
GlobalProductID (INT) Identifier for a Product in RQ
InvoiceComments (VARCHAR(50)) Comments
InvoicedAt (VARCHAR(100)) 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
InvoicedAt_StoreID (INT) Internal identifier for a store in RQ
InvoicedBy (VARCHAR(100)) 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
InvoicedBy_StoreID (INT) Internal identifier for a store in RQ
InvoiceIDByStore (VARCHAR(14)) Invoice # - invoice number assigned by RQ
InvoiceRowID (UNIQUEIDENTIFIER) Internal identifier in RQ
JournalNumber (VARCHAR(20)) Journal # - vendor account journal on which the rebate was reconciled
OriginalSaleDate (DateTime) Original Sales Date - date of the original sale
OriginalSaleInvoiceID (INT) Internal identifier in RQ
OriginalSaleInvoiceIDByStore (VARCHAR(14)) Original Invoice - invoice number of the original transaction
PartialCB (MONEY) Partial CB - amount the carrier is charging back
PortNumber (VARCHAR(30)) Port Number - if entered in transaction
Postal_code (VARCHAR(15)) Zip/Postal Code - zip code (USA) or postal code (Canada)
ProductIdentifier (VARCHAR(12)) Product SKU - RQ generated SKU
ProductName (VARCHAR(100)) Product Name - description of the product as it appears in the inventory
ProductRowID (UNIQUEIDENTIFIER) Literally no description in the database but originates from [iQclerk_SaleInvoicesAndProducts].[RowID]
Quantity (INT) Qty - total quantity of this product SKU on the invoice
RatePlan (VARCHAR(100)) Rate Plan - name of the rate plan
RatePlan2 (VARCHAR(100)) Rate Plan 2 - second rate plan if necessary
Reconciled (VARCHAR(3)) Reconciled - has been marked as reconciled in the Vendor Rebate Reconciliation screen
RegionID (INT) Identifier for a region in RQ
RegionName (VARCHAR(100)) Region - region for the rows location
RelatedCost (MONEY) Related Cost - purchase cost for the product associated with this rebate
RelatedPrice (MONEY) Related Price - price the customer paid for the product related to this rebate
RelatedProduct (VARCHAR(100)) Related Product - product associated with this rebate
RelatedProductSerialNumbers (VARCHAR(1000)) Related SN - serial number associated with this rebate, if any
RelatedProductSKU (VARCHAR(12)) Related SKU - product SKU of the product associated with this rebate
SaleInvoiceID (INT) Internal identifier in RQ
SerialNumber (VARCHAR(100)) Tracking # - tracking number associated with this entry
SocCode (VARCHAR(50)) SOC Code - SOC Code if one was used
SocCode2 (VARCHAR(50)) SOC Code2 - Second SOC Code if used
SpecialIdentifier (VARCHAR(25)) Sales Person ID - ID number assigned to this sales person and recorded on the Admin tab of their Employee Profile
SpecialIdentifier1 (VARCHAR (25)) Internal identifier in RQ
TermCode (VARCHAR(200)) Term Code - [may not show in your database] indicates new activation, upgrade, etc.
TotalPrice (MONEY) Total Rebate - total value of the rebate on this invoice calculated as Qty X Unit Rebate
UnitPrice (MONEY) Unit Rebate - dollar value of this rebate
VendorAccountName (VARCHAR(100)) Vendor Account Name - vendor account for this rebate
VendorName (NVARCHAR(MAX)) Vendor name in RQ
VendorNumber (NVARCHAR(3)) Vendor # - vendor account number entered for Vendor # By Location [if used]
VendorSKU (VARCHAR(25)) Vendor SKU

Relationship

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

DealerRelationship

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

REQUESTS

GET Dealer Relationships

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

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

Example

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

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

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingDealerRelationships()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingDealerRelationships() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[DealerRelationship]

Example Response (Default)

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

Example Response (JsonDataTable)

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

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CompanyID>14146</CompanyID>
    <CompanyName>KENTEL</CompanyName>
    <LocationEntityID>14192</LocationEntityID>
    <LocationName>Region A</LocationName>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CompanyID,CompanyName,LocationEntityID,LocationName
14146,KENTEL,14192,Region A

Example Response (Excel)

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

GET Partner Relationships

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

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

Definition

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

Headers

Example Request

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

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

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingPartnerRelationships() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/relationships");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/relationships', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[Relationship]

Example Response (Default)

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

Example Response (JsonDataTable)

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

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CompanyID>21090</CompanyID>
    <CompanyName>KENTEL</CompanyName>
    <DoingBusinessAs>Kentel Corp</DoingBusinessAs>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CompanyID,CompanyName,DoingBusinessAs
21090,KENTEL,Kentel Corp

Example Response (Excel)

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

GET the Activation Gross Profit Report

For more information, see Activation Gross Profit Report.

Definition

GET /partner/StatFlo/ActivationGrossProfitReport?CompanyId={CompanyId}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&StoreType={StoreType}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ReasonCode={ReasonCode}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/ActivationGrossProfitReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&StoreType=-1&LocationEntityID=14188&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[ActivationGrossProfitReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "InvoiceDate": "2016-10-12T09:16:24.63",
        "InvoiceID": 129920,
        "InvoiceIDByStore": "84WEAIN15624",
        "StoreTypeName": "Retail Store",
        "LocationName": "84 West",
        "Profit": 667.99,
        "CustomerID": 108560,
        "CustomerName": "AAA AND ASSOCIATES",
        "PhoneDescription": "Apple iPhone 6 Plus 16GB White - AT&T",
        "PhoneNumber": "3065014785",
        "TermDescription": "CRU 2 YR Business New Act",
        "RatePlanDescription": "2 YR CRU Business Legacy Plan $0.01 - $9.99",
        "VendorAccountName": "AT&T",
        "EmployeeName": "iQmetrix User",
        "DistrictName": "Valley Area District",
        "RegionName": "Region A",
        "ChannelName": "Regina Channel"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "InvoiceDate": "2016-10-12T09:16:24.63",
            "InvoiceID": 129920,
            "InvoiceIDByStore": "84WEAIN15624",
            "StoreTypeName": "Retail Store",
            "LocationName": "84 West",
            "Profit": 667.99,
            "CustomerID": 108560,
            "CustomerName": "AAA AND ASSOCIATES",
            "PhoneDescription": "Apple iPhone 6 Plus 16GB White - AT&T",
            "PhoneNumber": "3065014785",
            "TermDescription": "CRU 2 YR Business New Act",
            "RatePlanDescription": "2 YR CRU Business Legacy Plan $0.01 - $9.99",
            "VendorAccountName": "AT&T",
            "EmployeeName": "iQmetrix User",
            "DistrictName": "Valley Area District",
            "RegionName": "Region A",
            "ChannelName": "Regina Channel"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <InvoiceDate>2016-10-12T09:16:24.63</InvoiceDate>
    <InvoiceID>129920</InvoiceID>
    <InvoiceIDByStore>84WEAIN15624</InvoiceIDByStore>
    <StoreTypeName>Retail Store</StoreTypeName>
    <LocationName>84 West</LocationName>
    <Profit>667.99</Profit>
    <CustomerID>108560</CustomerID>
    <CustomerName>AAA AND ASSOCIATES</CustomerName>
    <PhoneDescription>Apple iPhone 6 Plus 16GB White - AT&T</PhoneDescription>
    <PhoneNumber>3065014785</PhoneNumber>
    <TermDescription>CRU 2 YR Business New Act</TermDescription>
    <RatePlanDescription>2 YR CRU Business Legacy Plan $0.01 - $9.99</RatePlanDescription>
    <VendorAccountName>AT&T</VendorAccountName>
    <EmployeeName>iQmetrix User</EmployeeName>
    <DistrictName>Valley Area District</DistrictName>
    <RegionName>Region A</RegionName>
    <ChannelName>Regina Channel</ChannelName>
  </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,InvoiceID,InvoiceIDByStore,StoreTypeName,LocationName,Profit,CustomerID,CustomerName,PhoneDescription,PhoneNumber,TermDescription,RatePlanDescription,VendorAccountName,EmployeeName,DistrictName,RegionName,ChannelName
2016-10-12T09:16:24.63,129920,84WEAIN15624,Retail Store,84 West,667.99,108560,AAA AND ASSOCIATES,Apple iPhone 6 Plus 16GB White - AT&T,3065014785,CRU 2 YR Business New Act,2 YR CRU Business Legacy Plan $0.01 - $9.99,AT&T,iQmetrix User,Valley Area District,Region A,Regina Channel

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 Coupon Summary Report

For more information, see Coupon Summary Report.

Definition

GET /partner/StatFlo/CouponSummaryReport?CompanyId={CompanyId}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ReportType={ReportType}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/CouponSummaryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ReportType=DailySummary&LocationEntityID=14188&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/partner/StatFlo/CouponSummaryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ReportType=DailySummary&LocationEntityID=14188&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheCouponSummaryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/CouponSummaryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ReportType=DailySummary&LocationEntityID=14188&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 GettingTheCouponSummaryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/CouponSummaryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ReportType=DailySummary&LocationEntityID=14188&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/partner/StatFlo/CouponSummaryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ReportType=DailySummary&LocationEntityID=14188&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[CouponSummaryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Date": "2016-01-01T00:00:00",
        "QuantityApplied": 1,
        "QuantityRefunded": 1,
        "NetQuantity": 0,
        "TotalValue": -10
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Date": "2016-01-01T00:00:00",
            "QuantityApplied": 1,
            "QuantityRefunded": 1,
            "NetQuantity": 0,
            "TotalValue": -10
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Date>2016-01-01T00:00:00</Date>
    <QuantityApplied>1</QuantityApplied>
    <QuantityRefunded>1</QuantityRefunded>
    <NetQuantity>0</NetQuantity>
    <TotalValue>-10</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
Date,QuantityApplied,QuantityRefunded,NetQuantity,TotalValue
2016-01-01T00:00:00,1,1,0,-10

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 Customer List Report for a Company

For more information, see Customer List Report.

Definition

GET /partner/StatFlo/CustomerListReport?CompanyId={CompanyId}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&TypeOfCustomer={TypeOfCustomer}&FilterBy={FilterBy}&StoreIDLoggedIn={StoreIDLoggedIn}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/CustomerListReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/StatFlo/CustomerListReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheCustomerListReportForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/CustomerListReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
    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 GettingTheCustomerListReportForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/CustomerListReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/StatFlo/CustomerListReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[CustomerListReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Address": "12 Hello St.",
        "Address2": "n/a",
        "BillingAccountNumber": "",
        "City": "Fargo",
        "ContactNumber": "5555555555",
        "ContactTypeName": "",
        "Country": "United States",
        "CustomerCompanyName": "KENTEL",
        "CustomerFirstName": "Carrie",
        "CustomerID": 2108754,
        "CustomerLastName": "Madison",
        "DateCreated": "2016-01-26T20:55:53.227",
        "DeclineToProvideEmail": false,
        "Email": "carry@test.iq",
        "EmployeeName": "iQmetrix Employee",
        "EmployeeNameAssignedTo": "iQmetrix Employee",
        "IndustryTypeName": "",
        "MultiLevelPriceID": 1,
        "NumberOfActivations": 0,
        "PositionTypeName": "",
        "PostalCode": "90123",
        "Province": "ND",
        "TracPointMemberNumber": "C2981754hduw",
        "TypeOfCustomer": 3,
        "VIPCustomer": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Address": "12 Hello St.",
            "Address2": "n/a",
            "BillingAccountNumber": "",
            "City": "Fargo",
            "ContactNumber": "5555555555",
            "ContactTypeName": "",
            "Country": "United States",
            "CustomerCompanyName": "KENTEL",
            "CustomerFirstName": "Carrie",
            "CustomerID": 2108754,
            "CustomerLastName": "Madison",
            "DateCreated": "2016-01-26T20:55:53.227",
            "DeclineToProvideEmail": false,
            "Email": "carry@test.iq",
            "EmployeeName": "iQmetrix Employee",
            "EmployeeNameAssignedTo": "iQmetrix Employee",
            "IndustryTypeName": "",
            "MultiLevelPriceID": 1,
            "NumberOfActivations": 0,
            "PositionTypeName": "",
            "PostalCode": "90123",
            "Province": "ND",
            "TracPointMemberNumber": "C2981754hduw",
            "TypeOfCustomer": 3,
            "VIPCustomer": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Address>12 Hello St.</Address>
    <Address2>n/a</Address2>
    <BillingAccountNumber></BillingAccountNumber>
    <City>Fargo</City>
    <ContactNumber>5555555555</ContactNumber>
    <ContactTypeName></ContactTypeName>
    <Country>United States</Country>
    <CustomerCompanyName>KENTEL</CustomerCompanyName>
    <CustomerFirstName>Carrie</CustomerFirstName>
    <CustomerID>2108754</CustomerID>
    <CustomerLastName>Madison</CustomerLastName>
    <DateCreated>2016-01-26T20:55:53.227</DateCreated>
    <DeclineToProvideEmail>false</DeclineToProvideEmail>
    <Email>carry@test.iq</Email>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <EmployeeNameAssignedTo>iQmetrix Employee</EmployeeNameAssignedTo>
    <IndustryTypeName></IndustryTypeName>
    <MultiLevelPriceID>1</MultiLevelPriceID>
    <NumberOfActivations>0</NumberOfActivations>
    <PositionTypeName></PositionTypeName>
    <PostalCode>90123</PostalCode>
    <Province>ND</Province>
    <TracPointMemberNumber>C2981754hduw</TracPointMemberNumber>
    <TypeOfCustomer>3</TypeOfCustomer>
    <VIPCustomer>0</VIPCustomer>
  </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
Address,Address2,BillingAccountNumber,City,ContactNumber,ContactTypeName,Country,CustomerCompanyName,CustomerFirstName,CustomerID,CustomerLastName,DateCreated,DeclineToProvideEmail,Email,EmployeeName,EmployeeNameAssignedTo,IndustryTypeName,MultiLevelPriceID,NumberOfActivations,PositionTypeName,PostalCode,Province,TracPointMemberNumber,TypeOfCustomer,VIPCustomer
12 Hello St.,n/a,,Fargo,5555555555,,United States,KENTEL,Carrie,2108754,Madison,2016-01-26T20:55:53.227,false,carry@test.iq,iQmetrix Employee,iQmetrix Employee,,1,0,,90123,ND,C2981754hduw,3,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 Employee Master List Report

For more information, see Employee Master List Report.

Definition

GET /partner/StatFlo/EmployeeMasterListReport?CompanyId={CompanyId}&EnabledStatus={EnabledStatus}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheEmployeeMasterListReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
    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 GettingTheEmployeeMasterListReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[EmployeeMasterListReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Assigned Groups": "Sales Representative",
        "Assigned Locations": "84 West Target Dothan Wiregrass Commons Mall - Test Long Store Name Here",
        "City": "Dothan",
        "Clear Fingerprints": "No",
        "Commission Group": "Sales Representative",
        "Compensation Type": "Commission",
        "Country": "USA",
        "Disabled": "No",
        "Email Address": "hilary@kentel.com",
        "Email Display Name": "hilary@kentel.com",
        "Email Password": "test",
        "Email Server": "outlook.kentel.com",
        "Email User Name": "hilary",
        "Employee ID": 60,
        "Employee Name": "Hillary Oliver",
        "Fingerprint Enabled": "No",
        "Frequency": "N/A",
        "FrequencyEffective": "Jan 10 2011",
        "Gender": "Male",
        "ID #": "912345987654321",
        "Image Uploaded": "No",
        "Internal": "N/A",
        "Intrgration Username": "hilary.kentel",
        "Job Title": "Wireless Consultant",
        "Language": "en-us",
        "Locked": "No",
        "Part Time": 0,
        "Personal Days Available": 0,
        "Personal Email": "hilary@kentel.com",
        "Primary Location": "Corporate Office",
        "Rate Effective": "Jan 10 2011",
        "Rate": 0,
        "Role": "Store Manager",
        "Security Role": "Sales Representative",
        "Sick Days Available": 0,
        "Start Date": "Dec 05 2010",
        "State / Prov": "AL",
        "Supervisor": "Robyn Roberts",
        "Termination Date": "Today",
        "Termination Notes": "Vacation days to be paid",
        "Username": "Hillary.Oliver",
        "Vacation Days Available": 0,
        "Work #": "3347020770"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Assigned Groups": "Sales Representative",
            "Assigned Locations": "84 West Target Dothan Wiregrass Commons Mall - Test Long Store Name Here",
            "City": "Dothan",
            "Clear Fingerprints": "No",
            "Commission Group": "Sales Representative",
            "Compensation Type": "Commission",
            "Country": "USA",
            "Disabled": "No",
            "Email Address": "hilary@kentel.com",
            "Email Display Name": "hilary@kentel.com",
            "Email Password": "test",
            "Email Server": "outlook.kentel.com",
            "Email User Name": "hilary",
            "Employee ID": 60,
            "Employee Name": "Hillary Oliver",
            "Fingerprint Enabled": "No",
            "Frequency": "N/A",
            "FrequencyEffective": "Jan 10 2011",
            "Gender": "Male",
            "ID #": "912345987654321",
            "Image Uploaded": "No",
            "Internal": "N/A",
            "Intrgration Username": "hilary.kentel",
            "Job Title": "Wireless Consultant",
            "Language": "en-us",
            "Locked": "No",
            "Part Time": 0,
            "Personal Days Available": 0,
            "Personal Email": "hilary@kentel.com",
            "Primary Location": "Corporate Office",
            "Rate Effective": "Jan 10 2011",
            "Rate": 0,
            "Role": "Store Manager",
            "Security Role": "Sales Representative",
            "Sick Days Available": 0,
            "Start Date": "Dec 05 2010",
            "State / Prov": "AL",
            "Supervisor": "Robyn Roberts",
            "Termination Date": "Today",
            "Termination Notes": "Vacation days to be paid",
            "Username": "Hillary.Oliver",
            "Vacation Days Available": 0,
            "Work #": "3347020770"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Assigned Groups>Sales Representative</Assigned Groups>
    <Assigned Locations>84 West Target Dothan Wiregrass Commons Mall - Test Long Store Name Here</Assigned Locations>
    <City>Dothan</City>
    <Clear Fingerprints>No</Clear Fingerprints>
    <Commission Group>Sales Representative</Commission Group>
    <Compensation Type>Commission</Compensation Type>
    <Country>USA</Country>
    <Disabled>No</Disabled>
    <Email Address>hilary@kentel.com</Email Address>
    <Email Display Name>hilary@kentel.com</Email Display Name>
    <Email Password>test</Email Password>
    <Email Server>outlook.kentel.com</Email Server>
    <Email User Name>hilary</Email User Name>
    <Employee ID>60</Employee ID>
    <Employee Name>Hillary Oliver</Employee Name>
    <Fingerprint Enabled>No</Fingerprint Enabled>
    <Frequency>N/A</Frequency>
    <FrequencyEffective>Jan 10 2011</FrequencyEffective>
    <Gender>Male</Gender>
    <ID #>912345987654321</ID #>
    <Image Uploaded>No</Image Uploaded>
    <Internal>N/A</Internal>
    <Intrgration Username>hilary.kentel</Intrgration Username>
    <Job Title>Wireless Consultant</Job Title>
    <Language>en-us</Language>
    <Locked>No</Locked>
    <Part Time>0</Part Time>
    <Personal Days Available>0</Personal Days Available>
    <Personal Email>hilary@kentel.com</Personal Email>
    <Primary Location>Corporate Office</Primary Location>
    <Rate Effective>Jan 10 2011</Rate Effective>
    <Rate>0</Rate>
    <Role>Store Manager</Role>
    <Security Role>Sales Representative</Security Role>
    <Sick Days Available>0</Sick Days Available>
    <Start Date>Dec 05 2010</Start Date>
    <State / Prov>AL</State / Prov>
    <Supervisor>Robyn Roberts</Supervisor>
    <Termination Date>Today</Termination Date>
    <Termination Notes>Vacation days to be paid</Termination Notes>
    <Username>Hillary.Oliver</Username>
    <Vacation Days Available>0</Vacation Days Available>
    <Work #>3347020770</Work #>
  </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
Assigned Groups,Assigned Locations,City,Clear Fingerprints,Commission Group,Compensation Type,Country,Disabled,Email Address,Email Display Name,Email Password,Email Server,Email User Name,Employee ID,Employee Name,Fingerprint Enabled,Frequency,FrequencyEffective,Gender,ID #,Image Uploaded,Internal,Intrgration Username,Job Title,Language,Locked,Part Time,Personal Days Available,Personal Email,Primary Location,Rate Effective,Rate,Role,Security Role,Sick Days Available,Start Date,State / Prov,Supervisor,Termination Date,Termination Notes,Username,Vacation Days Available,Work #
Sales Representative,84 West Target Dothan Wiregrass Commons Mall - Test Long Store Name Here,Dothan,No,Sales Representative,Commission,USA,No,hilary@kentel.com,hilary@kentel.com,test,outlook.kentel.com,hilary,60,Hillary Oliver,No,N/A,Jan 10 2011,Male,912345987654321,No,N/A,hilary.kentel,Wireless Consultant,en-us,No,0,0,hilary@kentel.com,Corporate Office,Jan 10 2011,0,Store Manager,Sales Representative,0,Dec 05 2010,AL,Robyn Roberts,Today,Vacation days to be paid,Hillary.Oliver,0,3347020770

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 Graphed Performance Metrix Report

For more information, see Graphed Performance Metrix Report.

Definition

GET /partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId={CompanyId}&PeriodID={PeriodID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&HideRebates={HideRebates}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&LocationEntityID=14188&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/partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheGraphedPerformanceMetrixReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&LocationEntityID=14188&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 GettingTheGraphedPerformanceMetrixReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&LocationEntityID=14188&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/partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&LocationEntityID=14188&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[GraphedPerformanceMetrixReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": 6,
        "Name": "51247 Test_update",
        "AttachmentRate": "1249 : 2",
        "AttachmentRateTarget": "0 : 0",
        "DisplayFormat": 2,
        "IsAttachmentRate": true,
        "Margin": null,
        "MarginTarget": null,
        "Priority": -1,
        "Profit": null,
        "ProfitTarget": null,
        "Quantity": null,
        "QuantityTarget": null,
        "Sales": null,
        "SalesTarget": null
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": 6,
            "Name": "51247 Test_update",
            "AttachmentRate": "1249 : 2",
            "AttachmentRateTarget": "0 : 0",
            "DisplayFormat": 2,
            "IsAttachmentRate": true,
            "Margin": null,
            "MarginTarget": null,
            "Priority": -1,
            "Profit": null,
            "ProfitTarget": null,
            "Quantity": null,
            "QuantityTarget": null,
            "Sales": null,
            "SalesTarget": null
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>6</ID>
    <Name>51247 Test_update</Name>
    <AttachmentRate>1249 : 2</AttachmentRate>
    <AttachmentRateTarget>0 : 0</AttachmentRateTarget>
    <DisplayFormat>2</DisplayFormat>
    <IsAttachmentRate>true</IsAttachmentRate>
    <Margin>null</Margin>
    <MarginTarget>null</MarginTarget>
    <Priority>-1</Priority>
    <Profit>null</Profit>
    <ProfitTarget>null</ProfitTarget>
    <Quantity>null</Quantity>
    <QuantityTarget>null</QuantityTarget>
    <Sales>null</Sales>
    <SalesTarget>null</SalesTarget>
  </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
ID,Name,AttachmentRate,AttachmentRateTarget,DisplayFormat,IsAttachmentRate,Margin,MarginTarget,Priority,Profit,ProfitTarget,Quantity,QuantityTarget,Sales,SalesTarget
6,51247 Test_update,1249 : 2,0 : 0,2,true,null,null,-1,null,null,null,null,null,null

Example Response (Excel)

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

GET the Graphed Performance Metrix Breakdown Report

For more information, see Graphed Performance Metrix Report.

Definition

GET /partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId={CompanyId}&PeriodID={PeriodID}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&HideRebates={HideRebates}&PerformanceGroupID={PerformanceGroupID}&TopN={TopN}&TopCriteria={TopCriteria}&ByWho={ByWho}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&LocationEntityID=14188&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/partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheGraphedPerformanceMetrixBreakdownReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&LocationEntityID=14188&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 GettingTheGraphedPerformanceMetrixBreakdownReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&LocationEntityID=14188&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/partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&LocationEntityID=14188&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[GraphedPerformanceMetrixBreakdownReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": 1,
        "Name": "84 West",
        "GroupInvoiceCount": 839,
        "IsAttachmentRate": false,
        "Margin": -1691.5747,
        "MarginTarget": 0,
        "Profit": -45860859.08,
        "ProfitTarget": 0,
        "Quantity": 530,
        "QuantityTarget": 0,
        "Sales": 27111.34,
        "SalesTarget": 0,
        "TotalInvoiceCount": 2772
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": 1,
            "Name": "84 West",
            "GroupInvoiceCount": 839,
            "IsAttachmentRate": false,
            "Margin": -1691.5747,
            "MarginTarget": 0,
            "Profit": -45860859.08,
            "ProfitTarget": 0,
            "Quantity": 530,
            "QuantityTarget": 0,
            "Sales": 27111.34,
            "SalesTarget": 0,
            "TotalInvoiceCount": 2772
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>1</ID>
    <Name>84 West</Name>
    <GroupInvoiceCount>839</GroupInvoiceCount>
    <IsAttachmentRate>false</IsAttachmentRate>
    <Margin>-1691.5747</Margin>
    <MarginTarget>0</MarginTarget>
    <Profit>-45860859.08</Profit>
    <ProfitTarget>0</ProfitTarget>
    <Quantity>530</Quantity>
    <QuantityTarget>0</QuantityTarget>
    <Sales>27111.34</Sales>
    <SalesTarget>0</SalesTarget>
    <TotalInvoiceCount>2772</TotalInvoiceCount>
  </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
ID,Name,GroupInvoiceCount,IsAttachmentRate,Margin,MarginTarget,Profit,ProfitTarget,Quantity,QuantityTarget,Sales,SalesTarget,TotalInvoiceCount
1,84 West,839,false,-1691.5747,0,-45860859.08,0,530,0,27111.34,0,2772

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 Location Master List Report

For more information, see Location Master List Report.

Definition

GET /partner/StatFlo/LocationMasterListReport?CompanyId={CompanyId}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/LocationMasterListReport?CompanyId=21090
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/StatFlo/LocationMasterListReport?CompanyId=21090', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[LocationMasterListReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Abbreviation": "LIT22",
        "Address": "4970 Hillside Avenue",
        "AddressVerified": "Not Verified",
        "AdjustDST": false,
        "BankDetails": "CashSmart",
        "CashPolicy": "Single-Drawer",
        "ChannelName": "Alabama",
        "City": "Kansas",
        "Comment_on_OE": false,
        "Country": "United States",
        "DepositTaken": 0,
        "Disabled": 1,
        "DistrictName": "Smithton",
        "EmailAddress": "abarea@kentel.com",
        "FaxNumber": "5555555555",
        "GeneralLocationNotes": "note",
        "GLCode": "-MILLH",
        "HideCustomerAddress": false,
        "InsuranceAmount": 0,
        "InsuranceCompany": "Safefair",
        "LandlordName": "Jim Jones",
        "LandlordNotes": "sample note",
        "Latitude": 50.443559,
        "LeaseEndDate": "2014-12-24T00:00:00",
        "LeaseNotes": "note",
        "LeaseStartDate": "2014-11-26T00:00:00",
        "LocationCode": "500",
        "LocationEntityID": 48540,
        "Longitude": -104.612034,
        "ManagerCommissionable": false,
        "ManagerEmployeeID": 233,
        "MaxCashDrawer": 0,
        "OtherCharges": 0,
        "PAW_on_OE": false,
        "Phone_on_OE": true,
        "PhoneNumber": "4353424234",
        "PropertyTaxes": 0,
        "RegionName": "Abarea",
        "RelocationDate": "2016-02-26T00:00:00",
        "Rent": 0,
        "SaleInvoiceComment": "Sale Invoice Comments",
        "Serial_on_OE": false,
        "SquareFootage": 0,
        "StaffLevel": 12,
        "StateProv": "AL",
        "StoreID": 1187,
        "StoreName": "Dufferin Mall",
        "StoreType": "Retail Store",
        "Taxes": "GOODS AND SERVICES TAX (GST)",
        "TimeZone": "(GMT-06:00) Saskatchewan",
        "UseLocationEmail": false,
        "ZipPostal": "90210"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Abbreviation": "LIT22",
            "Address": "4970 Hillside Avenue",
            "AddressVerified": "Not Verified",
            "AdjustDST": false,
            "BankDetails": "CashSmart",
            "CashPolicy": "Single-Drawer",
            "ChannelName": "Alabama",
            "City": "Kansas",
            "Comment_on_OE": false,
            "Country": "United States",
            "DepositTaken": 0,
            "Disabled": 1,
            "DistrictName": "Smithton",
            "EmailAddress": "abarea@kentel.com",
            "FaxNumber": "5555555555",
            "GeneralLocationNotes": "note",
            "GLCode": "-MILLH",
            "HideCustomerAddress": false,
            "InsuranceAmount": 0,
            "InsuranceCompany": "Safefair",
            "LandlordName": "Jim Jones",
            "LandlordNotes": "sample note",
            "Latitude": 50.443559,
            "LeaseEndDate": "2014-12-24T00:00:00",
            "LeaseNotes": "note",
            "LeaseStartDate": "2014-11-26T00:00:00",
            "LocationCode": "500",
            "LocationEntityID": 48540,
            "Longitude": -104.612034,
            "ManagerCommissionable": false,
            "ManagerEmployeeID": 233,
            "MaxCashDrawer": 0,
            "OtherCharges": 0,
            "PAW_on_OE": false,
            "Phone_on_OE": true,
            "PhoneNumber": "4353424234",
            "PropertyTaxes": 0,
            "RegionName": "Abarea",
            "RelocationDate": "2016-02-26T00:00:00",
            "Rent": 0,
            "SaleInvoiceComment": "Sale Invoice Comments",
            "Serial_on_OE": false,
            "SquareFootage": 0,
            "StaffLevel": 12,
            "StateProv": "AL",
            "StoreID": 1187,
            "StoreName": "Dufferin Mall",
            "StoreType": "Retail Store",
            "Taxes": "GOODS AND SERVICES TAX (GST)",
            "TimeZone": "(GMT-06:00) Saskatchewan",
            "UseLocationEmail": false,
            "ZipPostal": "90210"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Abbreviation>LIT22</Abbreviation>
    <Address>4970 Hillside Avenue</Address>
    <AddressVerified>Not Verified</AddressVerified>
    <AdjustDST>false</AdjustDST>
    <BankDetails>CashSmart</BankDetails>
    <CashPolicy>Single-Drawer</CashPolicy>
    <ChannelName>Alabama</ChannelName>
    <City>Kansas</City>
    <Comment_on_OE>false</Comment_on_OE>
    <Country>United States</Country>
    <DepositTaken>0</DepositTaken>
    <Disabled>1</Disabled>
    <DistrictName>Smithton</DistrictName>
    <EmailAddress>abarea@kentel.com</EmailAddress>
    <FaxNumber>5555555555</FaxNumber>
    <GeneralLocationNotes>note</GeneralLocationNotes>
    <GLCode>-MILLH</GLCode>
    <HideCustomerAddress>false</HideCustomerAddress>
    <InsuranceAmount>0</InsuranceAmount>
    <InsuranceCompany>Safefair</InsuranceCompany>
    <LandlordName>Jim Jones</LandlordName>
    <LandlordNotes>sample note</LandlordNotes>
    <Latitude>50.443559</Latitude>
    <LeaseEndDate>2014-12-24T00:00:00</LeaseEndDate>
    <LeaseNotes>note</LeaseNotes>
    <LeaseStartDate>2014-11-26T00:00:00</LeaseStartDate>
    <LocationCode>500</LocationCode>
    <LocationEntityID>48540</LocationEntityID>
    <Longitude>-104.612034</Longitude>
    <ManagerCommissionable>false</ManagerCommissionable>
    <ManagerEmployeeID>233</ManagerEmployeeID>
    <MaxCashDrawer>0</MaxCashDrawer>
    <OtherCharges>0</OtherCharges>
    <PAW_on_OE>false</PAW_on_OE>
    <Phone_on_OE>true</Phone_on_OE>
    <PhoneNumber>4353424234</PhoneNumber>
    <PropertyTaxes>0</PropertyTaxes>
    <RegionName>Abarea</RegionName>
    <RelocationDate>2016-02-26T00:00:00</RelocationDate>
    <Rent>0</Rent>
    <SaleInvoiceComment>Sale Invoice Comments</SaleInvoiceComment>
    <Serial_on_OE>false</Serial_on_OE>
    <SquareFootage>0</SquareFootage>
    <StaffLevel>12</StaffLevel>
    <StateProv>AL</StateProv>
    <StoreID>1187</StoreID>
    <StoreName>Dufferin Mall</StoreName>
    <StoreType>Retail Store</StoreType>
    <Taxes>GOODS AND SERVICES TAX (GST)</Taxes>
    <TimeZone>(GMT-06:00) Saskatchewan</TimeZone>
    <UseLocationEmail>false</UseLocationEmail>
    <ZipPostal>90210</ZipPostal>
  </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
Abbreviation,Address,AddressVerified,AdjustDST,BankDetails,CashPolicy,ChannelName,City,Comment_on_OE,Country,DepositTaken,Disabled,DistrictName,EmailAddress,FaxNumber,GeneralLocationNotes,GLCode,HideCustomerAddress,InsuranceAmount,InsuranceCompany,LandlordName,LandlordNotes,Latitude,LeaseEndDate,LeaseNotes,LeaseStartDate,LocationCode,LocationEntityID,Longitude,ManagerCommissionable,ManagerEmployeeID,MaxCashDrawer,OtherCharges,PAW_on_OE,Phone_on_OE,PhoneNumber,PropertyTaxes,RegionName,RelocationDate,Rent,SaleInvoiceComment,Serial_on_OE,SquareFootage,StaffLevel,StateProv,StoreID,StoreName,StoreType,Taxes,TimeZone,UseLocationEmail,ZipPostal
LIT22,4970 Hillside Avenue,Not Verified,false,CashSmart,Single-Drawer,Alabama,Kansas,false,United States,0,1,Smithton,abarea@kentel.com,5555555555,note,-MILLH,false,0,Safefair,Jim Jones,sample note,50.443559,2014-12-24T00:00:00,note,2014-11-26T00:00:00,500,48540,-104.612034,false,233,0,0,false,true,4353424234,0,Abarea,2016-02-26T00:00:00,0,Sale Invoice Comments,false,0,12,AL,1187,Dufferin Mall,Retail Store,GOODS AND SERVICES TAX (GST),(GMT-06:00) Saskatchewan,false,90210

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 Product Detail Report for a Company

For more information, see Product Detail Report.

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

Report Part Response
1  
2  
3  

Definition

GET /partner/StatFlo/ProductDetailReport?CompanyId={CompanyId}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&SearchMethod={SearchMethod}&CategoryNumber={CategoryNumber}&ReportPart={ReportPart}&ManufacturerID={ManufacturerID}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ProductIdentifier={ProductIdentifier}&InvoiceIDByStore={InvoiceIDByStore}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/ProductDetailReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/StatFlo/ProductDetailReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheProductDetailReportForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/ProductDetailReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&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 GettingTheProductDetailReportForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/ProductDetailReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&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/partner/StatFlo/ProductDetailReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ProductDetailReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Activation_RowID": "d3d65281-5201-4927-9bac-6f3a47ddf56b",
        "AdjustedUnitPrice": 25,
        "BillingAccountNumber": "",
        "CarrierPrice": null,
        "CategoryPath": ">> Phones >> Galaxies",
        "ChannelName": "English Channel",
        "Comments": "",
        "ContractNumber": "12345",
        "CustomerID": 131149,
        "CustomerName": "Bob Jones",
        "DateCreated": "2016-05-13T12:18:08.723",
        "DistrictName": "Westminster",
        "EmployeeName": "iQmetrix User",
        "EmployeeID": 4,
        "GlobalProductID": 5179,
        "InvoicedAt": "100: My Network LLC - Anchorage",
        "InvoicedAt_StoreID": 1,
        "InvoicedBy": "100: My Network LLC - Anchorage",
        "InvoicedBy_StoreID": 1,
        "InvoiceIDByStore": "77224IN3",
        "IsOrderServiceDropShipProduct": null,
        "IsOrderServiceShippingProduct": null,
        "ListPrice": 449.95,
        "OriginalUnitPrice": 25,
        "Priority": 1,
        "ProductCouponDiscount": 0,
        "ProductIdentifier": "ASHCSA000120",
        "ProductName": "Samsung Galaxy Rugby LTE",
        "Quantity": 1,
        "Refund": 0,
        "RegionName": "London",
        "RetailerCatalogID": "null",
        "SaleInvoice_RowID": "8c6537ae-75a5-4155-82b2-c8647ed05f3d",
        "SaleInvoiceID": 128962,
        "SaleInvoiceProduct_RowID": "0099b78f-ba02-4a91-afd4-2f7eb0fbbb06",
        "SerialNumber": "1111111",
        "SoldAsUsed": false,
        "SpecialProductID": 0,
        "StoreInStoreFlowIsEnabledForStore": false,
        "StoreInStoreGrossProfit": null,
        "StoreInStoreListPrice": null,
        "StoreInStorePrice": null,
        "StoreTypeName": "Costco",
        "TenderedBy": "iQmetrix User",
        "TenderedBy_EmployeeID": 277,
        "TotalCost": 0,
        "TotalDiscount": 424.95,
        "TotalPrice": 25,
        "UnitCost": 0,
        "UnitPrice": 25,
        "VendorName": "",
        "VendorSKU": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Activation_RowID": "d3d65281-5201-4927-9bac-6f3a47ddf56b",
            "AdjustedUnitPrice": 25,
            "BillingAccountNumber": "",
            "CarrierPrice": null,
            "CategoryPath": ">> Phones >> Galaxies",
            "ChannelName": "English Channel",
            "Comments": "",
            "ContractNumber": "12345",
            "CustomerID": 131149,
            "CustomerName": "Bob Jones",
            "DateCreated": "2016-05-13T12:18:08.723",
            "DistrictName": "Westminster",
            "EmployeeName": "iQmetrix User",
            "EmployeeID": 4,
            "GlobalProductID": 5179,
            "InvoicedAt": "100: My Network LLC - Anchorage",
            "InvoicedAt_StoreID": 1,
            "InvoicedBy": "100: My Network LLC - Anchorage",
            "InvoicedBy_StoreID": 1,
            "InvoiceIDByStore": "77224IN3",
            "IsOrderServiceDropShipProduct": null,
            "IsOrderServiceShippingProduct": null,
            "ListPrice": 449.95,
            "OriginalUnitPrice": 25,
            "Priority": 1,
            "ProductCouponDiscount": 0,
            "ProductIdentifier": "ASHCSA000120",
            "ProductName": "Samsung Galaxy Rugby LTE",
            "Quantity": 1,
            "Refund": 0,
            "RegionName": "London",
            "RetailerCatalogID": "null",
            "SaleInvoice_RowID": "8c6537ae-75a5-4155-82b2-c8647ed05f3d",
            "SaleInvoiceID": 128962,
            "SaleInvoiceProduct_RowID": "0099b78f-ba02-4a91-afd4-2f7eb0fbbb06",
            "SerialNumber": "1111111",
            "SoldAsUsed": false,
            "SpecialProductID": 0,
            "StoreInStoreFlowIsEnabledForStore": false,
            "StoreInStoreGrossProfit": null,
            "StoreInStoreListPrice": null,
            "StoreInStorePrice": null,
            "StoreTypeName": "Costco",
            "TenderedBy": "iQmetrix User",
            "TenderedBy_EmployeeID": 277,
            "TotalCost": 0,
            "TotalDiscount": 424.95,
            "TotalPrice": 25,
            "UnitCost": 0,
            "UnitPrice": 25,
            "VendorName": "",
            "VendorSKU": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Activation_RowID>d3d65281-5201-4927-9bac-6f3a47ddf56b</Activation_RowID>
    <AdjustedUnitPrice>25</AdjustedUnitPrice>
    <BillingAccountNumber></BillingAccountNumber>
    <CarrierPrice>null</CarrierPrice>
    <CategoryPath>>> Phones >> Galaxies</CategoryPath>
    <ChannelName>English Channel</ChannelName>
    <Comments></Comments>
    <ContractNumber>12345</ContractNumber>
    <CustomerID>131149</CustomerID>
    <CustomerName>Bob Jones</CustomerName>
    <DateCreated>2016-05-13T12:18:08.723</DateCreated>
    <DistrictName>Westminster</DistrictName>
    <EmployeeName>iQmetrix User</EmployeeName>
    <EmployeeID>4</EmployeeID>
    <GlobalProductID>5179</GlobalProductID>
    <InvoicedAt>100: My Network LLC - Anchorage</InvoicedAt>
    <InvoicedAt_StoreID>1</InvoicedAt_StoreID>
    <InvoicedBy>100: My Network LLC - Anchorage</InvoicedBy>
    <InvoicedBy_StoreID>1</InvoicedBy_StoreID>
    <InvoiceIDByStore>77224IN3</InvoiceIDByStore>
    <IsOrderServiceDropShipProduct>null</IsOrderServiceDropShipProduct>
    <IsOrderServiceShippingProduct>null</IsOrderServiceShippingProduct>
    <ListPrice>449.95</ListPrice>
    <OriginalUnitPrice>25</OriginalUnitPrice>
    <Priority>1</Priority>
    <ProductCouponDiscount>0</ProductCouponDiscount>
    <ProductIdentifier>ASHCSA000120</ProductIdentifier>
    <ProductName>Samsung Galaxy Rugby LTE</ProductName>
    <Quantity>1</Quantity>
    <Refund>0</Refund>
    <RegionName>London</RegionName>
    <RetailerCatalogID>null</RetailerCatalogID>
    <SaleInvoice_RowID>8c6537ae-75a5-4155-82b2-c8647ed05f3d</SaleInvoice_RowID>
    <SaleInvoiceID>128962</SaleInvoiceID>
    <SaleInvoiceProduct_RowID>0099b78f-ba02-4a91-afd4-2f7eb0fbbb06</SaleInvoiceProduct_RowID>
    <SerialNumber>1111111</SerialNumber>
    <SoldAsUsed>false</SoldAsUsed>
    <SpecialProductID>0</SpecialProductID>
    <StoreInStoreFlowIsEnabledForStore>false</StoreInStoreFlowIsEnabledForStore>
    <StoreInStoreGrossProfit>null</StoreInStoreGrossProfit>
    <StoreInStoreListPrice>null</StoreInStoreListPrice>
    <StoreInStorePrice>null</StoreInStorePrice>
    <StoreTypeName>Costco</StoreTypeName>
    <TenderedBy>iQmetrix User</TenderedBy>
    <TenderedBy_EmployeeID>277</TenderedBy_EmployeeID>
    <TotalCost>0</TotalCost>
    <TotalDiscount>424.95</TotalDiscount>
    <TotalPrice>25</TotalPrice>
    <UnitCost>0</UnitCost>
    <UnitPrice>25</UnitPrice>
    <VendorName></VendorName>
    <VendorSKU></VendorSKU>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
Activation_RowID,AdjustedUnitPrice,BillingAccountNumber,CarrierPrice,CategoryPath,ChannelName,Comments,ContractNumber,CustomerID,CustomerName,DateCreated,DistrictName,EmployeeName,EmployeeID,GlobalProductID,InvoicedAt,InvoicedAt_StoreID,InvoicedBy,InvoicedBy_StoreID,InvoiceIDByStore,IsOrderServiceDropShipProduct,IsOrderServiceShippingProduct,ListPrice,OriginalUnitPrice,Priority,ProductCouponDiscount,ProductIdentifier,ProductName,Quantity,Refund,RegionName,RetailerCatalogID,SaleInvoice_RowID,SaleInvoiceID,SaleInvoiceProduct_RowID,SerialNumber,SoldAsUsed,SpecialProductID,StoreInStoreFlowIsEnabledForStore,StoreInStoreGrossProfit,StoreInStoreListPrice,StoreInStorePrice,StoreTypeName,TenderedBy,TenderedBy_EmployeeID,TotalCost,TotalDiscount,TotalPrice,UnitCost,UnitPrice,VendorName,VendorSKU
d3d65281-5201-4927-9bac-6f3a47ddf56b,25,,null,>> Phones >> Galaxies,English Channel,,12345,131149,Bob Jones,2016-05-13T12:18:08.723,Westminster,iQmetrix User,4,5179,100: My Network LLC - Anchorage,1,100: My Network LLC - Anchorage,1,77224IN3,null,null,449.95,25,1,0,ASHCSA000120,Samsung Galaxy Rugby LTE,1,0,London,null,8c6537ae-75a5-4155-82b2-c8647ed05f3d,128962,0099b78f-ba02-4a91-afd4-2f7eb0fbbb06,1111111,false,0,false,null,null,null,Costco,iQmetrix User,277,0,424.95,25,0,25,,

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 Sales by Customer Report

For more information, see Sales by Customer Report.

Definition

GET /partner/StatFlo/SalesByCustomerReport?CompanyId={CompanyId}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ShowVendorRebate={ShowVendorRebate}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&CategoryNumber={CategoryNumber}&ProductIdentifier={ProductIdentifier}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/SalesByCustomerReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ShowVendorRebate=true&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/StatFlo/SalesByCustomerReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ShowVendorRebate=true&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheSalesByCustomerReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/SalesByCustomerReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ShowVendorRebate=true&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001");
    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 GettingTheSalesByCustomerReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/SalesByCustomerReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ShowVendorRebate=true&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/StatFlo/SalesByCustomerReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ShowVendorRebate=true&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&CategoryNumber=10&ProductIdentifier=ASCLMO000001', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SalesByCustomerReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CustomerID": 57818,
        "CustomerName": "Ann Fox",
        "Customer_CompanyName": "KENTEL",
        "Customer_LastName": "Ann Fox",
        "CustomerAddress": "8105 Blanche Dr",
        "CustomerCity": "Panama City",
        "CustomerProvinceOrState": "FL",
        "CustomerCountry": "United States",
        "CustomerPostalCode": "32404",
        "CustomInteger1": "12",
        "CustomInteger2": "1",
        "CustomDate1": "2016-01-01T00:00:00",
        "CustomDate2": "2016-01-01T00:00:00",
        "CustomText1": "March",
        "CustomText2": "Orange",
        "CompanySize": "200",
        "CustomDropDown1": "2112",
        "CustomDropDown2": "Orange",
        "CustomDropDown3": "Three",
        "CustomDropDown4": "Ph.D",
        "CustomDropDown5": "Enabled",
        "TotalInvoiced": 1210.02,
        "Adjustment": 0,
        "TotalPrice": 1185.01,
        "TotalCost": 18.01,
        "TotalCoupon": 0,
        "TotalCouponTax": 0,
        "TotalProfit": 1167,
        "TotalDiscount": -784.01,
        "PercentProfit": 98.48,
        "QuantitySold": 18,
        "QuantityRefunded": -6,
        "NetQuantity": 12,
        "InvoicedAtDifferentLocation": 0,
        "CustomerIdentifier": "C10KNRVY",
        "BillingAccountNumber": "5555555555",
        "FinancedAmount": 0,
        "TotalDownPayment": 0,
        "TypeOfCustomer": 3
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CustomerID": 57818,
            "CustomerName": "Ann Fox",
            "Customer_CompanyName": "KENTEL",
            "Customer_LastName": "Ann Fox",
            "CustomerAddress": "8105 Blanche Dr",
            "CustomerCity": "Panama City",
            "CustomerProvinceOrState": "FL",
            "CustomerCountry": "United States",
            "CustomerPostalCode": "32404",
            "CustomInteger1": "12",
            "CustomInteger2": "1",
            "CustomDate1": "2016-01-01T00:00:00",
            "CustomDate2": "2016-01-01T00:00:00",
            "CustomText1": "March",
            "CustomText2": "Orange",
            "CompanySize": "200",
            "CustomDropDown1": "2112",
            "CustomDropDown2": "Orange",
            "CustomDropDown3": "Three",
            "CustomDropDown4": "Ph.D",
            "CustomDropDown5": "Enabled",
            "TotalInvoiced": 1210.02,
            "Adjustment": 0,
            "TotalPrice": 1185.01,
            "TotalCost": 18.01,
            "TotalCoupon": 0,
            "TotalCouponTax": 0,
            "TotalProfit": 1167,
            "TotalDiscount": -784.01,
            "PercentProfit": 98.48,
            "QuantitySold": 18,
            "QuantityRefunded": -6,
            "NetQuantity": 12,
            "InvoicedAtDifferentLocation": 0,
            "CustomerIdentifier": "C10KNRVY",
            "BillingAccountNumber": "5555555555",
            "FinancedAmount": 0,
            "TotalDownPayment": 0,
            "TypeOfCustomer": 3
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CustomerID>57818</CustomerID>
    <CustomerName>Ann Fox</CustomerName>
    <Customer_CompanyName>KENTEL</Customer_CompanyName>
    <Customer_LastName>Ann Fox</Customer_LastName>
    <CustomerAddress>8105 Blanche Dr</CustomerAddress>
    <CustomerCity>Panama City</CustomerCity>
    <CustomerProvinceOrState>FL</CustomerProvinceOrState>
    <CustomerCountry>United States</CustomerCountry>
    <CustomerPostalCode>32404</CustomerPostalCode>
    <CustomInteger1>12</CustomInteger1>
    <CustomInteger2>1</CustomInteger2>
    <CustomDate1>2016-01-01T00:00:00</CustomDate1>
    <CustomDate2>2016-01-01T00:00:00</CustomDate2>
    <CustomText1>March</CustomText1>
    <CustomText2>Orange</CustomText2>
    <CompanySize>200</CompanySize>
    <CustomDropDown1>2112</CustomDropDown1>
    <CustomDropDown2>Orange</CustomDropDown2>
    <CustomDropDown3>Three</CustomDropDown3>
    <CustomDropDown4>Ph.D</CustomDropDown4>
    <CustomDropDown5>Enabled</CustomDropDown5>
    <TotalInvoiced>1210.02</TotalInvoiced>
    <Adjustment>0</Adjustment>
    <TotalPrice>1185.01</TotalPrice>
    <TotalCost>18.01</TotalCost>
    <TotalCoupon>0</TotalCoupon>
    <TotalCouponTax>0</TotalCouponTax>
    <TotalProfit>1167</TotalProfit>
    <TotalDiscount>-784.01</TotalDiscount>
    <PercentProfit>98.48</PercentProfit>
    <QuantitySold>18</QuantitySold>
    <QuantityRefunded>-6</QuantityRefunded>
    <NetQuantity>12</NetQuantity>
    <InvoicedAtDifferentLocation>0</InvoicedAtDifferentLocation>
    <CustomerIdentifier>C10KNRVY</CustomerIdentifier>
    <BillingAccountNumber>5555555555</BillingAccountNumber>
    <FinancedAmount>0</FinancedAmount>
    <TotalDownPayment>0</TotalDownPayment>
    <TypeOfCustomer>3</TypeOfCustomer>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CustomerID,CustomerName,Customer_CompanyName,Customer_LastName,CustomerAddress,CustomerCity,CustomerProvinceOrState,CustomerCountry,CustomerPostalCode,CustomInteger1,CustomInteger2,CustomDate1,CustomDate2,CustomText1,CustomText2,CompanySize,CustomDropDown1,CustomDropDown2,CustomDropDown3,CustomDropDown4,CustomDropDown5,TotalInvoiced,Adjustment,TotalPrice,TotalCost,TotalCoupon,TotalCouponTax,TotalProfit,TotalDiscount,PercentProfit,QuantitySold,QuantityRefunded,NetQuantity,InvoicedAtDifferentLocation,CustomerIdentifier,BillingAccountNumber,FinancedAmount,TotalDownPayment,TypeOfCustomer
57818,Ann Fox,KENTEL,Ann Fox,8105 Blanche Dr,Panama City,FL,United States,32404,12,1,2016-01-01T00:00:00,2016-01-01T00:00:00,March,Orange,200,2112,Orange,Three,Ph.D,Enabled,1210.02,0,1185.01,18.01,0,0,1167,-784.01,98.48,18,-6,12,0,C10KNRVY,5555555555,0,0,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 the Serialized Coupon Report

For more information, see Serialized Coupon Report.

Definition

GET /partner/StatFlo/SerializedCouponReport?CompanyId={CompanyId}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&Enabled={Enabled}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&SerialNumberFilter={SerialNumberFilter}&CouponID={CouponID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/SerializedCouponReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&Enabled=true&LocationEntityID=14188&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumberFilter=866988333292854&CouponID=-1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/StatFlo/SerializedCouponReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&Enabled=true&LocationEntityID=14188&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumberFilter=866988333292854&CouponID=-1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheSerializedCouponReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/SerializedCouponReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&Enabled=true&LocationEntityID=14188&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumberFilter=866988333292854&CouponID=-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 GettingTheSerializedCouponReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/SerializedCouponReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&Enabled=true&LocationEntityID=14188&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumberFilter=866988333292854&CouponID=-1");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/StatFlo/SerializedCouponReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&Enabled=true&LocationEntityID=14188&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumberFilter=866988333292854&CouponID=-1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SerializedCouponReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CouponID": 1089,
        "Customer": "John Test",
        "CouponName": "RQ API FpP Serialized",
        "SerialNumber": "cpn00000",
        "Issued": "2015-06-04T10:18:38.403",
        "Percentage": "15",
        "Amount": 0,
        "CouponSKU": "COUPON001089",
        "SaleInvoiceID": 7,
        "InvoiceIDByStore": "84WEAIN15624",
        "CustomerID": 2108754
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CouponID": 1089,
            "Customer": "John Test",
            "CouponName": "RQ API FpP Serialized",
            "SerialNumber": "cpn00000",
            "Issued": "2015-06-04T10:18:38.403",
            "Percentage": "15",
            "Amount": 0,
            "CouponSKU": "COUPON001089",
            "SaleInvoiceID": 7,
            "InvoiceIDByStore": "84WEAIN15624",
            "CustomerID": 2108754
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CouponID>1089</CouponID>
    <Customer>John Test</Customer>
    <CouponName>RQ API FpP Serialized</CouponName>
    <SerialNumber>cpn00000</SerialNumber>
    <Issued>2015-06-04T10:18:38.403</Issued>
    <Percentage>15</Percentage>
    <Amount>0</Amount>
    <CouponSKU>COUPON001089</CouponSKU>
    <SaleInvoiceID>7</SaleInvoiceID>
    <InvoiceIDByStore>84WEAIN15624</InvoiceIDByStore>
    <CustomerID>2108754</CustomerID>
  </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
CouponID,Customer,CouponName,SerialNumber,Issued,Percentage,Amount,CouponSKU,SaleInvoiceID,InvoiceIDByStore,CustomerID
1089,John Test,RQ API FpP Serialized,cpn00000,2015-06-04T10:18:38.403,15,0,COUPON001089,7,84WEAIN15624,2108754

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 Vendor Rebate History Report for a Company

For more information, see Vendor Rebate History Report.

Definition

GET /partner/StatFlo/VendorRebateHistoryReport?CompanyId={CompanyId}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&SearchMethod={SearchMethod}&ApplyShowOnInvoice={ApplyShowOnInvoice}&ReconciledStatus={ReconciledStatus}&EmployeeIDOfReconcilers={EmployeeIDOfReconcilers}&VendorAccountID={VendorAccountID}&CategoryNumber={CategoryNumber}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ProductIdentifier={ProductIdentifier}&LanguageCode={LanguageCode}&SerialNumber={SerialNumber}&JournalNumber={JournalNumber}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=true&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=true&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheVendorRebateHistoryReportForACompany()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=true&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff");
    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 GettingTheVendorRebateHistoryReportForACompany() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=true&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-06-06T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=true&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[VendorRebateHistoryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ActivationAssociationNumber": 2,
        "ActivationRowID": "0d4652a7-a673-437a-817e-4641961ba3e6",
        "Adjusted": "No",
        "AssociationNumber": 3,
        "CarrierPrice": 0,
        "ChannelName": "English Channel",
        "ChargeBack": "No",
        "Collected": null,
        "Comments": "",
        "Comments2": "null",
        "ContractNumber": "123456789",
        "CustomerID1": 130834,
        "CustomerName1": "Bob Jones",
        "DateCreated": "2016-01-04T14:33:15.737",
        "DateReconciled": "null",
        "DistrictName": "District B2",
        "EmployeeID": 0,
        "EmployeeID1": 218,
        "EmployeeName": "",
        "EmployeeName1": "iQmetrix User",
        "ExtraField": "1234567890",
        "Flagged": "No",
        "GlobalProductID": 812,
        "InvoiceComments": "",
        "InvoicedAt": "Regina Store",
        "InvoicedAt_StoreID": 1,
        "InvoicedBy": "Regina Store",
        "InvoicedBy_StoreID": 1,
        "InvoiceIDByStore": "HJKIIIN2",
        "InvoiceRowID": "db8f28cf-5017-47f4-9ccf-b90cff32185d",
        "JournalNumber": "",
        "OriginalSaleDate": "null",
        "OriginalSaleInvoiceID": null,
        "OriginalSaleInvoiceIDByStore": "null",
        "PartialCB": 0,
        "PortNumber": "",
        "Postal_code": "56789",
        "ProductIdentifier": "ACVZRB000001",
        "ProductName": "Verizon New Act_EquipmentRebate",
        "ProductRowID": "27be5c76-b0ba-4a34-ba7d-fa34aba0ab9c",
        "Quantity": 1,
        "RatePlan": "Act $9.99 to $20.98",
        "RatePlan2": "",
        "Reconciled": "No",
        "RegionID": 9,
        "RegionName": "Region B",
        "RelatedCost": 404,
        "RelatedPrice": 69.99,
        "RelatedProduct": "Samsung Galaxy S4",
        "RelatedProductSerialNumbers": "ACVZCB0026",
        "RelatedProductSKU": "ACVZCB000244",
        "SaleInvoiceID": 126526,
        "SerialNumber": "123000000000000",
        "SocCode": "123000000000000",
        "SocCode2": "",
        "SpecialIdentifier": "1",
        "SpecialIdentifier1": "",
        "TermCode": "",
        "TotalPrice": 0,
        "UnitPrice": 0,
        "VendorAccountName": "Verizon 2",
        "VendorName": "Verizon",
        "VendorNumber": "",
        "VendorSKU": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ActivationAssociationNumber": 2,
            "ActivationRowID": "0d4652a7-a673-437a-817e-4641961ba3e6",
            "Adjusted": "No",
            "AssociationNumber": 3,
            "CarrierPrice": 0,
            "ChannelName": "English Channel",
            "ChargeBack": "No",
            "Collected": null,
            "Comments": "",
            "Comments2": "null",
            "ContractNumber": "123456789",
            "CustomerID1": 130834,
            "CustomerName1": "Bob Jones",
            "DateCreated": "2016-01-04T14:33:15.737",
            "DateReconciled": "null",
            "DistrictName": "District B2",
            "EmployeeID": 0,
            "EmployeeID1": 218,
            "EmployeeName": "",
            "EmployeeName1": "iQmetrix User",
            "ExtraField": "1234567890",
            "Flagged": "No",
            "GlobalProductID": 812,
            "InvoiceComments": "",
            "InvoicedAt": "Regina Store",
            "InvoicedAt_StoreID": 1,
            "InvoicedBy": "Regina Store",
            "InvoicedBy_StoreID": 1,
            "InvoiceIDByStore": "HJKIIIN2",
            "InvoiceRowID": "db8f28cf-5017-47f4-9ccf-b90cff32185d",
            "JournalNumber": "",
            "OriginalSaleDate": "null",
            "OriginalSaleInvoiceID": null,
            "OriginalSaleInvoiceIDByStore": "null",
            "PartialCB": 0,
            "PortNumber": "",
            "Postal_code": "56789",
            "ProductIdentifier": "ACVZRB000001",
            "ProductName": "Verizon New Act_EquipmentRebate",
            "ProductRowID": "27be5c76-b0ba-4a34-ba7d-fa34aba0ab9c",
            "Quantity": 1,
            "RatePlan": "Act $9.99 to $20.98",
            "RatePlan2": "",
            "Reconciled": "No",
            "RegionID": 9,
            "RegionName": "Region B",
            "RelatedCost": 404,
            "RelatedPrice": 69.99,
            "RelatedProduct": "Samsung Galaxy S4",
            "RelatedProductSerialNumbers": "ACVZCB0026",
            "RelatedProductSKU": "ACVZCB000244",
            "SaleInvoiceID": 126526,
            "SerialNumber": "123000000000000",
            "SocCode": "123000000000000",
            "SocCode2": "",
            "SpecialIdentifier": "1",
            "SpecialIdentifier1": "",
            "TermCode": "",
            "TotalPrice": 0,
            "UnitPrice": 0,
            "VendorAccountName": "Verizon 2",
            "VendorName": "Verizon",
            "VendorNumber": "",
            "VendorSKU": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ActivationAssociationNumber>2</ActivationAssociationNumber>
    <ActivationRowID>0d4652a7-a673-437a-817e-4641961ba3e6</ActivationRowID>
    <Adjusted>No</Adjusted>
    <AssociationNumber>3</AssociationNumber>
    <CarrierPrice>0</CarrierPrice>
    <ChannelName>English Channel</ChannelName>
    <ChargeBack>No</ChargeBack>
    <Collected>null</Collected>
    <Comments></Comments>
    <Comments2>null</Comments2>
    <ContractNumber>123456789</ContractNumber>
    <CustomerID1>130834</CustomerID1>
    <CustomerName1>Bob Jones</CustomerName1>
    <DateCreated>2016-01-04T14:33:15.737</DateCreated>
    <DateReconciled>null</DateReconciled>
    <DistrictName>District B2</DistrictName>
    <EmployeeID>0</EmployeeID>
    <EmployeeID1>218</EmployeeID1>
    <EmployeeName></EmployeeName>
    <EmployeeName1>iQmetrix User</EmployeeName1>
    <ExtraField>1234567890</ExtraField>
    <Flagged>No</Flagged>
    <GlobalProductID>812</GlobalProductID>
    <InvoiceComments></InvoiceComments>
    <InvoicedAt>Regina Store</InvoicedAt>
    <InvoicedAt_StoreID>1</InvoicedAt_StoreID>
    <InvoicedBy>Regina Store</InvoicedBy>
    <InvoicedBy_StoreID>1</InvoicedBy_StoreID>
    <InvoiceIDByStore>HJKIIIN2</InvoiceIDByStore>
    <InvoiceRowID>db8f28cf-5017-47f4-9ccf-b90cff32185d</InvoiceRowID>
    <JournalNumber></JournalNumber>
    <OriginalSaleDate>null</OriginalSaleDate>
    <OriginalSaleInvoiceID>null</OriginalSaleInvoiceID>
    <OriginalSaleInvoiceIDByStore>null</OriginalSaleInvoiceIDByStore>
    <PartialCB>0</PartialCB>
    <PortNumber></PortNumber>
    <Postal_code>56789</Postal_code>
    <ProductIdentifier>ACVZRB000001</ProductIdentifier>
    <ProductName>Verizon New Act_EquipmentRebate</ProductName>
    <ProductRowID>27be5c76-b0ba-4a34-ba7d-fa34aba0ab9c</ProductRowID>
    <Quantity>1</Quantity>
    <RatePlan>Act $9.99 to $20.98</RatePlan>
    <RatePlan2></RatePlan2>
    <Reconciled>No</Reconciled>
    <RegionID>9</RegionID>
    <RegionName>Region B</RegionName>
    <RelatedCost>404</RelatedCost>
    <RelatedPrice>69.99</RelatedPrice>
    <RelatedProduct>Samsung Galaxy S4</RelatedProduct>
    <RelatedProductSerialNumbers>ACVZCB0026</RelatedProductSerialNumbers>
    <RelatedProductSKU>ACVZCB000244</RelatedProductSKU>
    <SaleInvoiceID>126526</SaleInvoiceID>
    <SerialNumber>123000000000000</SerialNumber>
    <SocCode>123000000000000</SocCode>
    <SocCode2></SocCode2>
    <SpecialIdentifier>1</SpecialIdentifier>
    <SpecialIdentifier1></SpecialIdentifier1>
    <TermCode></TermCode>
    <TotalPrice>0</TotalPrice>
    <UnitPrice>0</UnitPrice>
    <VendorAccountName>Verizon 2</VendorAccountName>
    <VendorName>Verizon</VendorName>
    <VendorNumber></VendorNumber>
    <VendorSKU></VendorSKU>
  </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
ActivationAssociationNumber,ActivationRowID,Adjusted,AssociationNumber,CarrierPrice,ChannelName,ChargeBack,Collected,Comments,Comments2,ContractNumber,CustomerID1,CustomerName1,DateCreated,DateReconciled,DistrictName,EmployeeID,EmployeeID1,EmployeeName,EmployeeName1,ExtraField,Flagged,GlobalProductID,InvoiceComments,InvoicedAt,InvoicedAt_StoreID,InvoicedBy,InvoicedBy_StoreID,InvoiceIDByStore,InvoiceRowID,JournalNumber,OriginalSaleDate,OriginalSaleInvoiceID,OriginalSaleInvoiceIDByStore,PartialCB,PortNumber,Postal_code,ProductIdentifier,ProductName,ProductRowID,Quantity,RatePlan,RatePlan2,Reconciled,RegionID,RegionName,RelatedCost,RelatedPrice,RelatedProduct,RelatedProductSerialNumbers,RelatedProductSKU,SaleInvoiceID,SerialNumber,SocCode,SocCode2,SpecialIdentifier,SpecialIdentifier1,TermCode,TotalPrice,UnitPrice,VendorAccountName,VendorName,VendorNumber,VendorSKU
2,0d4652a7-a673-437a-817e-4641961ba3e6,No,3,0,English Channel,No,null,,null,123456789,130834,Bob Jones,2016-01-04T14:33:15.737,null,District B2,0,218,,iQmetrix User,1234567890,No,812,,Regina Store,1,Regina Store,1,HJKIIIN2,db8f28cf-5017-47f4-9ccf-b90cff32185d,,null,null,null,0,,56789,ACVZRB000001,Verizon New Act_EquipmentRebate,27be5c76-b0ba-4a34-ba7d-fa34aba0ab9c,1,Act $9.99 to $20.98,,No,9,Region B,404,69.99,Samsung Galaxy S4,ACVZCB0026,ACVZCB000244,126526,123000000000000,123000000000000,,1,,,0,0,Verizon 2,Verizon,,

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?