{% include linkrefs.html %}
Overview
To get started, see RQ 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 {{AuthenticationOptions}}.
Endpoints
- Sandbox: https://rqdataconnectdemo.iqmetrix.net
- Production: https://rqdataconnect.iqmetrix.net
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"<EMAIL_ADDRESS>"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"<EMAIL_ADDRESS>"Email Display Name"<EMAIL_ADDRESS>"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"<EMAIL_ADDRESS>"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"<EMAIL_ADDRESS>"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 |
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"
}
| Name | Description |
|---|---|
CompanyID (INTEGER ) |
Identifier for a Company |
CompanyName (VARCHAR(50) ) |
Company name |
Requests
Getting Partner Relationships
Request
GET /partner/relationships?Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/relationships
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/relationships"
Using RestSharp;
at the top of your file.
static IRestResponse GettingPartnerRelationships()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/relationships");
var request = new RestRequest(Method.GET);
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://rqdataconnectdemo.iqmetrix.net/partner/relationships");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/relationships', {
}
puts response
Response
Array[[relationship](#Relationship)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"CompanyID": 21090,
"CompanyName": "KENTEL"
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"Records": [
{
"CompanyID": 21090,
"CompanyName": "KENTEL"
}
],
"Schema": [
{
"Column_Name": "ColumnName",
"Type": "datatype",
"SafeType": "safetype",
"Length": 100
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=Csv
CompanyID,CompanyName 21090,KENTEL
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
content-disposition: attachment;filename=reportname-2016-07-11.xlsx Binary *.xlsx file
Getting the Activation Gross Profit Report
For more information, see {{support_ActivationGrossProfitReport}}.
Request
GET /partner/StatFlo/ActivationGrossProfitReport?CompanyId={CompanyId}&StartDate={StartDate}&StopDate={StopDate}&StoreType={StoreType}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ReasonCode={ReasonCode}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
CompanyId
(Required) - Identifier for a Company, for a list see Getting Partner Relationships -
StartDate
(Required) - Date at which report will begin -
StopDate
(Required) - Date at which report will end -
ReasonCode
(Required) - Identifier for a ReasonCode. Use -1 to specify All Reason Codes. For a complete list, see Getting Reason Codes -
StoreType
(Required) - Identifier for a StoreType. Use -1 to specify All Types. For a complete list, see Getting Store Types -
ForWho
(Optional) - Identifier for a level at which to perform the report. For a complete list, see Getting Report Levels in RQ. If LocationType is provided, this value is ignored -
ForWhoIDs
(Optional) - A comma seperated list of identifiers to filter the report. For a list of identifiers, see Getting Nodes By Location Type. If LocationTypeIDs is provided, this value is ignored. To ignore filtering use -1 -
LocationType
(Optional) - A LocationType to filter the report. For a complete list, see Getting Location Types. If this value is provided, ForWho is ignored -
LocationTypeIDs
(Optional) - A comma seperated list of RQCompanyTreeNode identifiers to filter the report. For a complete list, see Getting Location Ids. To ignore filtering, use -1 or *. If this value is provided, ForWhoIDs is ignored -
LanguageCode
(Optional) - Language code, defaults to en-us. For a complete list, see Getting Language Codes -
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/StatFlo/ActivationGrossProfitReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&StoreType=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&LanguageCode=en-us
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/ActivationGrossProfitReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&StoreType=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&LanguageCode=en-us"
Using RestSharp;
at the top of your file.
static IRestResponse GettingTheActivationGrossProfitReport()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/ActivationGrossProfitReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&StoreType=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&LanguageCode=en-us");
var request = new RestRequest(Method.GET);
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://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/ActivationGrossProfitReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&StoreType=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&LanguageCode=en-us");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/ActivationGrossProfitReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&StoreType=-1&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&ReasonCode=-1&LanguageCode=en-us', {
}
puts response
Response
Array[[activationgrossprofitreportdata](#ActivationGrossProfitReportData)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"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"
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"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
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=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
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
content-disposition: attachment;filename=reportname-2016-07-11.xlsx Binary *.xlsx file
Getting the Coupon Summary Report
For more information, see {{support_CouponSummaryReport}}.
Request
GET /partner/StatFlo/CouponSummaryReport?CompanyId={CompanyId}&StartDate={StartDate}&StopDate={StopDate}&ReportType={ReportType}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
CompanyId
(Required) - Identifier for a Company, for a list see Getting Partner Relationships -
StartDate
(Required) - Date at which report will begin -
StopDate
(Required) - Date at which report will end -
ReportType
(Required) - Acceptable values include DailySummary, LocationSummary, CouponSummary, CouponDetail, EmployeeSummary and CommissionDetail -
ForWho
(Optional) - Identifier for a level at which to perform the report. For a complete list, see Getting Report Levels in RQ. If LocationType is provided, this value is ignored -
ForWhoIDs
(Optional) - A comma seperated list of identifiers to filter the report. For a list of identifiers, see Getting Nodes By Location Type. If LocationTypeIDs is provided, this value is ignored. To ignore filtering use -1 -
LocationType
(Optional) - A LocationType to filter the report. For a complete list, see Getting Location Types. If this value is provided, ForWho is ignored -
LocationTypeIDs
(Optional) - A comma seperated list of RQCompanyTreeNode identifiers to filter the report. For a complete list, see Getting Location Ids. To ignore filtering, use -1 or *. If this value is provided, ForWhoIDs is ignored -
LanguageCode
(Optional) - Language code, defaults to en-us. For a complete list, see Getting Language Codes -
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/StatFlo/CouponSummaryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&ReportType=DailySummary&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/CouponSummaryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&ReportType=DailySummary&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us"
Using RestSharp;
at the top of your file.
static IRestResponse GettingTheCouponSummaryReport()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/CouponSummaryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&ReportType=DailySummary&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
var request = new RestRequest(Method.GET);
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://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/CouponSummaryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&ReportType=DailySummary&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/CouponSummaryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-01-01T08:00:00.000Z&ReportType=DailySummary&ForWho=4&ForWhoIDs=1&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
}
puts response
Response
Array[[couponsummaryreportdata](#CouponSummaryReportData)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"Date": "2016-01-01T00:00:00",
"QuantityApplied": 1,
"QuantityRefunded": 1,
"NetQuantity": 0,
"TotalValue": -10
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"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
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=Csv
Date,QuantityApplied,QuantityRefunded,NetQuantity,TotalValue 2016-01-01T00:00:00,1,1,0,-10
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
content-disposition: attachment;filename=reportname-2016-07-11.xlsx Binary *.xlsx file
Getting the Customer List Report for a Company
For more information, see {{support_CustomerListReport}}.
Request
GET /partner/StatFlo/CustomerListReport?CompanyId={CompanyId}&StartDate={StartDate}&StopDate={StopDate}&TypeOfCustomer={TypeOfCustomer}&FilterBy={FilterBy}&StoreIDLoggedIn={StoreIDLoggedIn}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
CompanyId
(Required) - Identifier for a Company, for a list see Getting Partner Relationships -
StartDate
(Required) - Date at which report will begin -
StopDate
(Required) - Date at which report will end -
TypeOfCustomer
(Required) - Acceptable values include -1 for all types, 1 for Company, 2 for Division, 3 for Group and 4 for Individual -
FilterBy
(Required) - Acceptable values include 0 for All Customers, 1 for First Activation and 2 for Sales -
StoreIDLoggedIn
(Required) - Identifier for a store in RQ. For a complete list, see Getting A List of Stores in RQ -
ForWho
(Optional) - Identifier for a level at which to perform the report. For a complete list, see Getting Report Levels in RQ. If LocationType is provided, this value is ignored -
ForWhoIDs
(Optional) - A comma seperated list of identifiers to filter the report. For a list of identifiers, see Getting Nodes By Location Type. If LocationTypeIDs is provided, this value is ignored. To ignore filtering use -1 -
LocationType
(Optional) - A LocationType to filter the report. For a complete list, see Getting Location Types. If this value is provided, ForWho is ignored -
LocationTypeIDs
(Optional) - A comma seperated list of RQCompanyTreeNode identifiers to filter the report. For a complete list, see Getting Location Ids. To ignore filtering, use -1 or *. If this value is provided, ForWhoIDs is ignored -
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/StatFlo/CustomerListReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/CustomerListReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2"
Using RestSharp;
at the top of your file.
static IRestResponse GettingTheCustomerListReportForACompany()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/CustomerListReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
var request = new RestRequest(Method.GET);
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://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/CustomerListReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/CustomerListReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2', {
}
puts response
Response
Array[[customerlistreportdata](#CustomerListReportData)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"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"<EMAIL_ADDRESS>"EmployeeName": "iQmetrix Employee",
"EmployeeNameAssignedTo": "iQmetrix Employee",
"IndustryTypeName": "",
"MultiLevelPriceID": 1,
"NumberOfActivations": 0,
"PositionTypeName": "",
"PostalCode": "90123",
"Province": "ND",
"TracPointMemberNumber": "C2981754hduw",
"TypeOfCustomer": 3,
"VIPCustomer": 0
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"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"<EMAIL_ADDRESS>"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
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=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
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
content-disposition: attachment;filename=reportname-2016-07-11.xlsx Binary *.xlsx file
Getting the Employee Master List Report
For more information, see {{support_EmployeeMasterListReport}}.
Request
GET /partner/StatFlo/EmployeeMasterListReport?CompanyId={CompanyId}&EnabledStatus={EnabledStatus}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
CompanyId
(Required) - Identifier for a Company, for a list see Getting Partner Relationships -
EnabledStatus
(Required) - Select employees with a status of Disabled (0), Enabled (1) or Any Status (2) -
ForWho
(Optional) - Identifier for a level at which to perform the report. For a complete list, see Getting Report Levels in RQ. If LocationType is provided, this value is ignored -
ForWhoIDs
(Optional) - A comma seperated list of identifiers to filter the report. For a list of identifiers, see Getting Nodes By Location Type. If LocationTypeIDs is provided, this value is ignored. To ignore filtering use -1 -
LocationType
(Optional) - A LocationType to filter the report. For a complete list, see Getting Location Types. If this value is provided, ForWho is ignored -
LocationTypeIDs
(Optional) - A comma seperated list of RQCompanyTreeNode identifiers to filter the report. For a complete list, see Getting Location Ids. To ignore filtering, use -1 or *. If this value is provided, ForWhoIDs is ignored -
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2"
Using RestSharp;
at the top of your file.
static IRestResponse GettingTheEmployeeMasterListReport()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
var request = new RestRequest(Method.GET);
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://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/EmployeeMasterListReport?CompanyId=21090&EnabledStatus=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2', {
}
puts response
Response
Array[[employeemasterlistreportdata](#EmployeeMasterListReportData)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"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"<EMAIL_ADDRESS>"Email Display Name"<EMAIL_ADDRESS>"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"<EMAIL_ADDRESS>"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"
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"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"<EMAIL_ADDRESS>"Email Display Name"<EMAIL_ADDRESS>"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"<EMAIL_ADDRESS>"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
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=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
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
content-disposition: attachment;filename=reportname-2016-07-11.xlsx Binary *.xlsx file
Getting the Graphed Performance Metrix Report
For more information, see {{support_GraphedPerformanceMetrixReport}}.
Request
GET /partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId={CompanyId}&PeriodID={PeriodID}&StartDate={StartDate}&StopDate={StopDate}&HideRebates={HideRebates}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
CompanyId
(Required) - Identifier for a Company, for a list see Getting Partner Relationships -
PeriodID
(Required) - Identifier for a Period in RQ, or -1 if a StartDate and StopDate will be used -
StartDate
(Required) - Date at which report will begin. If PeriodID is -1, this value will be ignored -
StopDate
(Required) - Date at which report will end. If PeriodID is -1, this value will be ignored -
HideRebates
(Required) - A flag to indicate if Rebates should be included in the report (1) or not (-1) -
ForWho
(Optional) - Identifier for a level at which to perform the report. For a complete list, see Getting Report Levels in RQ. If LocationType is provided, this value is ignored -
ForWhoIDs
(Optional) - A comma seperated list of identifiers to filter the report. For a list of identifiers, see Getting Nodes By Location Type. If LocationTypeIDs is provided, this value is ignored. To ignore filtering use -1 -
LocationType
(Optional) - A LocationType to filter the report. For a complete list, see Getting Location Types. If this value is provided, ForWho is ignored -
LocationTypeIDs
(Optional) - A comma seperated list of RQCompanyTreeNode identifiers to filter the report. For a complete list, see Getting Location Ids. To ignore filtering, use -1 or *. If this value is provided, ForWhoIDs is ignored -
LanguageCode
(Optional) - Language code, defaults to en-us. For a complete list, see Getting Language Codes -
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us"
Using RestSharp;
at the top of your file.
static IRestResponse GettingTheGraphedPerformanceMetrixReport()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
var request = new RestRequest(Method.GET);
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://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_PerformanceMetrix?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
}
puts response
Response
Array[[graphedperformancemetrixreportdata](#GraphedPerformanceMetrixReportData)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"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
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"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
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=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
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
content-disposition: attachment;filename=reportname-2016-07-11.xlsx Binary *.xlsx file
Getting the Graphed Performance Metrix Breakdown Report
For more information, see {{support_GraphedPerformanceMetrixReport}}.
Request
GET /partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId={CompanyId}&PeriodID={PeriodID}&StartDate={StartDate}&StopDate={StopDate}&HideRebates={HideRebates}&PerformanceGroupID={PerformanceGroupID}&TopN={TopN}&TopCriteria={TopCriteria}&ByWho={ByWho}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
CompanyId
(Required) - Identifier for a Company, for a list see Getting Partner Relationships -
PeriodID
(Required) - Identifier for a Period in RQ, or -1 if a StartDate and StopDate will be used -
StartDate
(Required) - Date at which report will begin. If PeriodID is -1, this value will be ignored -
StopDate
(Required) - Date at which report will end. If PeriodID is -1, this value will be ignored -
HideRebates
(Required) - A flag to indicate if Rebates should be included in the report (1) or not (-1) -
PerformanceGroupID
(Required) - Identifier for a Performance Group in RQ -
TopN
(Required) - Gets the top X entries for the report, ordered by the value in TopCriteria. Use -1 to return all results -
TopCriteria
(Required) - Acceptable values include Quantity, Sales, Profit, Margin and Rate -
ByWho
(Required) - This value will aggregate the report data at the Company (1), Region (2), Division (3), Location (4) or Employee (5) level -
ForWho
(Optional) - Identifier for a level at which to perform the report. For a complete list, see Getting Report Levels in RQ. If LocationType is provided, this value is ignored -
ForWhoIDs
(Optional) - A comma seperated list of identifiers to filter the report. For a list of identifiers, see Getting Nodes By Location Type. If LocationTypeIDs is provided, this value is ignored. To ignore filtering use -1 -
LocationType
(Optional) - A LocationType to filter the report. For a complete list, see Getting Location Types. If this value is provided, ForWho is ignored -
LocationTypeIDs
(Optional) - A comma seperated list of RQCompanyTreeNode identifiers to filter the report. For a complete list, see Getting Location Ids. To ignore filtering, use -1 or *. If this value is provided, ForWhoIDs is ignored -
LanguageCode
(Optional) - Language code, defaults to en-us. For a complete list, see Getting Language Codes -
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us"
Using RestSharp;
at the top of your file.
static IRestResponse GettingTheGraphedPerformanceMetrixBreakdownReport()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
var request = new RestRequest(Method.GET);
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://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/GraphedPerformanceMetricsReport_Breakdown?CompanyId=21090&PeriodID=1&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&HideRebates=-1&PerformanceGroupID=1&TopN=10&TopCriteria=Quantity&ByWho=5&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
}
puts response
Response
Array[[graphedperformancemetrixbreakdownreportdata](#GraphedPerformanceMetrixBreakdownReportData)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"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
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"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
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=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
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
content-disposition: attachment;filename=reportname-2016-07-11.xlsx Binary *.xlsx file
Getting the Location Master List Report
For more information, see {{support_LocationMasterListReport}}.
Request
GET /partner/StatFlo/LocationMasterListReport?CompanyId={CompanyId}&Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
CompanyId
(Required) - Identifier for a Company, for a list see Getting Partner Relationships -
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/StatFlo/LocationMasterListReport?CompanyId=21090
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/LocationMasterListReport?CompanyId=21090"
Using RestSharp;
at the top of your file.
static IRestResponse GettingTheLocationMasterListReport()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/LocationMasterListReport?CompanyId=21090");
var request = new RestRequest(Method.GET);
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://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/LocationMasterListReport?CompanyId=21090");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/LocationMasterListReport?CompanyId=21090', {
}
puts response
Response
Array[[locationmasterlistreportdata](#LocationMasterListReportData)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"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"<EMAIL_ADDRESS>"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"
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"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"<EMAIL_ADDRESS>"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
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=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
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
content-disposition: attachment;filename=reportname-2016-07-11.xlsx Binary *.xlsx file
Getting the Product Detail Report for a Company
For more information, see {{support_ProductDetailReport}}.
Note that this report has multiple responses, depending on the ReportPart specified.
| Report Part | Response |
|---|---|
| 1 | ProductDetailReportData |
| 2 | ProductDetailReportTaxDetailData |
| 3 | ProductDetailReportTaxColumnData |
Request
GET /partner/StatFlo/ProductDetailReport?CompanyId={CompanyId}&StartDate={StartDate}&StopDate={StopDate}&SearchMethod={SearchMethod}&CategoryNumber={CategoryNumber}&ReportPart={ReportPart}&ManufacturerID={ManufacturerID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ProductIdentifier={ProductIdentifier}&InvoiceIDByStore={InvoiceIDByStore}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
CompanyId
(Required) - Identifier for a Company, for a list see Getting Partner Relationships -
StartDate
(Required) - Date at which report will begin -
StopDate
(Required) - Date at which report will end -
SearchMethod
(Required) - Acceptable values include 1 for Product SKU, 2 for Manufacutrer, 3 for Category and 4 for Invoice Number -
CategoryNumber
(Required) - Identifier for a CategoryNumber. For a complete list see Getting Category Numbers -
ReportPart
(Required) - Acceptable values include 1 to return the default report, 2 for the tax detail report and 3 for tax column data -
ManufacturerID
(Required) - Identifier for a Manufacture in RQ. Use -1 for all Manufacturers. For a complete list see Getting a List of Manufacturers in RQ -
ForWho
(Optional) - Identifier for a level at which to perform the report. For a complete list, see Getting Report Levels in RQ. If LocationType is provided, this value is ignored -
ForWhoIDs
(Optional) - A comma seperated list of identifiers to filter the report. For a list of identifiers, see Getting Nodes By Location Type. If LocationTypeIDs is provided, this value is ignored. To ignore filtering use -1 -
LocationType
(Optional) - A LocationType to filter the report. For a complete list, see Getting Location Types. If this value is provided, ForWho is ignored -
LocationTypeIDs
(Optional) - A comma seperated list of RQCompanyTreeNode identifiers to filter the report. For a complete list, see Getting Location Ids. To ignore filtering, use -1 or *. If this value is provided, ForWhoIDs is ignored -
ProductIdentifier
(Optional) - Product SKU -
InvoiceIDByStore
(Optional) - Tracking number -
LanguageCode
(Optional) - Language code, defaults to en-us. For a complete list, see Getting Language Codes -
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/StatFlo/ProductDetailReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/ProductDetailReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us"
Using RestSharp;
at the top of your file.
static IRestResponse GettingTheProductDetailReportForACompany()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/ProductDetailReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us");
var request = new RestRequest(Method.GET);
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://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/ProductDetailReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/ProductDetailReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=3&CategoryNumber=10&ReportPart=1&ManufacturerID=-1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&InvoiceIDByStore=77224IN3&LanguageCode=en-us', {
}
puts response
Response
Array[[productdetailreportdata](#ProductDetailReportData)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"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": ""
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"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
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=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,,
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
content-disposition: attachment;filename=reportname-2016-07-11.xlsx Binary *.xlsx file
Getting the Vendor Rebate History Report for a Company
For more information, see {{support_VendorRebateHistoryReport}}.
Request
GET /partner/StatFlo/VendorRebateHistoryReport?CompanyId={CompanyId}&StartDate={StartDate}&StopDate={StopDate}&SearchMethod={SearchMethod}&ApplyShowOnInvoice={ApplyShowOnInvoice}&ReconciledStatus={ReconciledStatus}&EmployeeIDOfReconcilers={EmployeeIDOfReconcilers}&VendorAccountID={VendorAccountID}&CategoryNumber={CategoryNumber}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ProductIdentifier={ProductIdentifier}&LanguageCode={LanguageCode}&SerialNumber={SerialNumber}&JournalNumber={JournalNumber}&Auth={Auth}&Response={Response}
Headers
Authorization: Bearer (Access Token)
(Optional) - Bearer token used for authentication. For other methods of authentication, see {{AuthenticationOptions}}Accept-Encoding: gzip
(Optional) - Compression algorithm. For other methods of compression, see {{CompressionOptions}}
URI Parameters
-
CompanyId
(Required) - Identifier for a Company, for a list see Getting Partner Relationships -
StartDate
(Required) - Date at which report will begin -
StopDate
(Required) - Date at which report will end -
SearchMethod
(Required) - Acceptable values include 1 for Vendor Account, 2 for Journal Number, 3 for Reconciled By, 4 for Category, 5 for Tracking Number and 6 for Product SKU -
ApplyShowOnInvoice
(Required) - This value should always be 0 -
ReconciledStatus
(Required) - Acceptable values include 0 for Unreconciled, 1 for Reconciled and 2 for Any -
EmployeeIDOfReconcilers
(Required) - Identifier of an employee who reconciled the rebate. Use -1 for all employees -
VendorAccountID
(Required) - Identifier of a vendor account. Use -1 for all vendor accounts -
CategoryNumber
(Required) - Identifier for a CategoryNumber. For a complete list see Getting Category Numbers -
ForWho
(Optional) - Identifier for a level at which to perform the report. For a complete list, see Getting Report Levels in RQ. If LocationType is provided, this value is ignored -
ForWhoIDs
(Optional) - A comma seperated list of identifiers to filter the report. For a list of identifiers, see Getting Nodes By Location Type. If LocationTypeIDs is provided, this value is ignored. To ignore filtering use -1 -
LocationType
(Optional) - A LocationType to filter the report. For a complete list, see Getting Location Types. If this value is provided, ForWho is ignored -
LocationTypeIDs
(Optional) - A comma seperated list of RQCompanyTreeNode identifiers to filter the report. For a complete list, see Getting Location Ids. To ignore filtering, use -1 or *. If this value is provided, ForWhoIDs is ignored -
LanguageCode
(Optional) - Language code, defaults to en-us. For a complete list, see Getting Language Codes -
ProductIdentifier
(Optional) - Product SKU -
SerialNumber
(Optional) - Serial Number -
JournalNumber
(Optional) - Journal number -
Auth
(Optional) - Basic token used for authentication. For other methods of authentication, see {{AuthenticationOptions}} -
Response
(Optional) - Default is JSON. For other methods of response, see {{ResponseOptions}}
Example
GET /partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=-1&CategoryNumber=10&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff
curl -X GET "https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=-1&CategoryNumber=10&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff"
Using RestSharp;
at the top of your file.
static IRestResponse GettingTheVendorRebateHistoryReportForACompany()
{
var client = new RestClient("https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=-1&CategoryNumber=10&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);
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://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=-1&CategoryNumber=10&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff");
return httpClient.execute(request);
}
gem install rest-client
.
require 'rest-client'
response = RestClient.get 'https://rqdataconnectdemo.iqmetrix.net/partner/StatFlo/VendorRebateHistoryReport?CompanyId=21090&StartDate=1970-01-01T08:00:00.000Z&StopDate=2016-06-06T07:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=-1&CategoryNumber=10&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&ProductIdentifier=ASCLMO000001&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff', {
}
puts response
Response
Array[[vendorrebatehistoryreportdata](#VendorRebateHistoryReportData)]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the Auth
URI parameter
[
{
"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": ""
}
]
HTTP 200 Content-Type: application/json
This is the default result obtained by omitting the URI parameter Auth=JsonDataTable
. This response type wraps the data in a “Records” array and adds a “Schema” array, which contains information about each column in the report.
{
"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
}
]
}
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=Xml
HTTP 200 Content-Type: text/xml
This result is obtained by using the URL parameter Auth=XmlDataTable
. This response type appends to the bottom of the request a summary of information about each column in the report.
HTTP 200 Content-Type: text/csv
This result is obtained by using the URL parameter Auth=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,,
HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
This result is obtained by using the URL parameter Auth=Excel
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 429 |
Too Many Requests |
See Rate Limiting |
HTTP 500 |
Unexpected Error |
See Message in response for more information |