API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

Data Connect allows you to retrieve report data from your RQ database (v4.23 and up).

To get started, see Data Connect Guide.

Note

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

Authentication

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

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

Report List

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

ENDPOINTS

RESOURCES

CommissionByInvoiceReportData

[
    {
        "CustomerName": "",
        "SaleInvoiceID": 134582,
        "DateCreated": "2017-04-03T00:00:00",
        "StoreName": "84 West",
        "RefundCodeID": "1cb93936-5777-2781-039f-c38e9c5a8b2c",
        "InvoiceIDByStore": "84WEAIN17784",
        "Comments": "",
        "TotalCommission": 19.93,
        "EmployeeName": "iQmetrix Employee",
        "EmployeeUsername": "iQmetrix.Employee",
        "FullChargeBackID": "720b9402-afdd-468c-1ea2-973f7a58adb2",
        "RowID": "87e3ff8c-db9c-1731-3085-3fede2e36355"
    }
]
Name Description
CustomerName (VARCHAR(151)) Customer - customer on the invoice. If the sale was not applied to a customer then No Customer is the customer
SaleInvoiceID (INT) Internal identifier in RQ
DateCreated (DateTime) Created On - date the invoice was tendered / date the Charge Back was completed
StoreName (NVARCHAR(MAX)) Location - where the invoice was tendered / Location affected by the Charge Back regardless of where the Charge Back was done
RefundCodeID (UNIQUEIDENTIFIER) Internal identifier in RQ
InvoiceIDByStore (VARCHAR(14)) Invoice # - an invoice number may appear more than once if the commission is split between two employees. If there is no invoice number, it was a manual commission ledger entry
Comments (NVARCHAR(MAX)) Invoice Comments - any comments added to the refund
TotalCommission (MONEY) Commission - amount of commission credited to each employee on the invoice
EmployeeName (VARCHAR(51)) Employee - any employee who is credited with commission on any invoice within the search parameters
EmployeeUsername (VARCHAR(51)) Username - username for the employee
FullChargeBackID (UNIQUEIDENTIFIER) Internal identifier in RQ
RowID (UNIQUEIDENTIFIER) Internal identifier in RQ

CommissionByProductReportData

[
    {
        "SaleInvoiceID": 134582,
        "InvoiceIDByStore": "84WEAIN17784",
        "DateCreated": "2017-04-03T00:00:00",
        "GlobalProductID": 2833,
        "ProductIdentifier": "KLERNB000025",
        "SpecialProductID": 0,
        "ProductName": "iPhone 7",
        "Quantity": 1,
        "SerialNumber": "",
        "PriceWithVR": 45,
        "PriceWithoutVR": 45,
        "Cost": 0,
        "Profit": 45,
        "Adjustment": 0,
        "Commission": 4.6,
        "SoldBy": 268,
        "SoldByName": "iQmetrix Employee",
        "TenderedBy": 268,
        "TenderedByName": "iQmetrix Employee",
        "Split": false,
        "SplitWith": 0,
        "SplitWithName": "",
        "SplitRate": "",
        "InvoiceRowID": "b73943f9-e566-5c07-34e5-52f7ea302551",
        "ProductRowID": "77a6b2a7-d44c-f905-0bbe-d7a53e93b139"
    }
]
Name Description
SaleInvoiceID (INT) Internal identifier in RQ
InvoiceIDByStore (VARCHAR(14)) Invoice # - invoice number assigned by RQ
DateCreated (DateTime) Sold On - date and time the invoice was tendered
GlobalProductID (INT) Internal identifier in RQ
ProductIdentifier (VARCHAR(32)) Product SKU - RQ generated SKU
SpecialProductID (INT) Internal identifier in RQ
ProductName (NVARCHAR(MAX)) Product Name - name of the product as it appears in the inventory
Quantity (INT) Qty - total number of the product SKU sold on the invoice
SerialNumber (VARCHAR(100)) Tracking # - tracking number associated with this product, serialized products only
PriceWithVR (MONEY) Price with VR- dollar amount the customer was charged on the invoice
PriceWithoutVR (MONEY) Price without VR - dollar amount the customer was charged on the invoice
Cost (MONEY) Cost - purchase cost of the individual product
Profit (MONEY) Profit - gross profit, calculated as Price - Cost
Adjustment (MONEY) Adjustment - the net dollar amount of any adjustments
Commission (MONEY) Commission - dollar amount of commission calculated
SoldBy (INT) Internal identifier for an Employee in RQ
SoldByName (VARCHAR(51)) Sold By - name of the employee of record for the sale, i.e. the employee whose name is in the Commission box
TenderedBy (INT) Internal identifier for an Employee in RQ
TenderedByName (VARCHAR(51)) Tendered By - name of the employee logged into RQ when the invoice was tendered
Split (BIT) Split - indicates if the commission was split with a second employee
SplitWith (INT) Internal identifier for an Employee in RQ
SplitWithName (VARCHAR(51)) Split With - name of the second employee who received commission
SplitRate (VARCHAR(7)) Split Rate - rate of split expressed as a percentage
InvoiceRowID (UNIQUEIDENTIFIER) Internal identifier in RQ
ProductRowID (UNIQUEIDENTIFIER) Internal identifier in RQ

CommissionLedgerActivityReportData

[
    {
        "LedgerEntryID": 183842,
        "CustomerName": "",
        "StoreName": "84 West",
        "SaleInvoiceID": 134582,
        "FullChargeBackID": "87129c26-e07f-cb10-a7a9-3fd0112f77ad",
        "DateCreated": "2017-04-03T00:00:00",
        "InvoiceIDByStore": "84WEAIN17784",
        "Quantity": 1,
        "TransactionType": 1,
        "UnitCommission": 15.33,
        "TotalCommission": 15.33,
        "ProductIdentifier": "ASBCJA000115",
        "ProductName": "500 mAh li ion battery",
        "SerialNumber": "",
        "Split": false,
        "SplitRate1": 100,
        "SplitRate2": 0,
        "EmployeeName1": "iQmetrix Employee",
        "EmployeeUsername1": "iQmetrix.Employee",
        "SpecialIdentifier": "912345987654321",
        "EmployeeName2": "",
        "EmployeeUsername2": "",
        "CommissionType": 2,
        "CommissionRate": 10.22,
        "CommissionSPIF": 10.21,
        "CommissionFixedCost": 10.22,
        "CommissionFloatingCost": 10.22,
        "Comments": "",
        "Suspend": false,
        "HasBeenReversed": false,
        "EmployeeName3": "iQmetrix Employee",
        "EmployeeUsername3": "iQmetrix.Employee",
        "ContractNumber": "",
        "Reconciled": false,
        "ReconciledDate": "1900-01-01T00:00:00",
        "CBReconciledDate": "1900-01-01T00:00:00",
        "JournalName": "",
        "CBJournalName": ""
    }
]
Name Description
LedgerEntryID (INT) Internal identifier in RQ
CustomerName (VARCHAR(151)) Customer - customer to whom the sale was made. If it is a Quick Sale, this will be blank. You will not be able to use the search fields for Quick Sales but if you wish to use the search filters you will need to check the first [blank] option
StoreName (NVARCHAR(MAX)) Location - location where the invoice was tendered
SaleInvoiceID (INT) Internal identifier in RQ
FullChargeBackID (UNIQUEIDENTIFIER) Internal identifier in RQ
DateCreated (DateTime) Created On - date the commission ledger was made. This may be the same as the invoice date but may differ if it is a manual entry. A reversal may also be the date a Charge Back was completed.
InvoiceIDByStore (VARCHAR(14)) Invoice # - invoice on which the commission was calculated, if there are multiple commissionable products the number will be on the list multiple times. If the Invoice # is blank, it is a manual commission ledger entry. This can also be the Charge Back transaction number
Quantity (INT) Qty - quantity of the product as noted on the invoice, this is always negative for Charge Backs
TransactionType (TINYINT) Type - types of commission ledger. For a complete list, see TransactionTypes
UnitCommission (MONEY) Unit Comm - amount of commission paid on one unit of this product SKU
TotalCommission (MONEY) Total - total for this line, calculated as Qty times Unit Comm
ProductIdentifier (VARCHAR(32)) Product SKU - product SKU for the commissionable product on the invoice or the SKU that was charged back
ProductName (NVARCHAR(MAX)) Product Name - name of the product as it appears in the inventory
SerialNumber (VARCHAR(100)) Tracking # - tracking number, if there is one
Split (BIT) Split - indicates whether or not the commission was split
SplitRate1 (DECIMAL) Rate % - percentage of the commission the Paid To employee received
SplitRate2 (DECIMAL) Rate % - percentage of the commission the Split With employee received
EmployeeName1 (VARCHAR(51)) Paid To - employee who was paid the commission
EmployeeUsername1 (VARCHAR(51)) Paid To Username - username of the employee who was paid the commission
SpecialIdentifier (VARCHAR(25)) ID # - this is the employee ID number
EmployeeName2 (VARCHAR(51)) Split With - second employee if the commission was split
EmployeeUsername2 (VARCHAR(51)) Split With Username - username of the second employee if the commission was split
CommissionType (TINYINT) Commission Type - this is the type of commission applied to the product. For a complete list, see CommissionTypes
CommissionRate (DECIMAL) Rate % - this is the rate for the commission type for the employee in the search parameters and their commission group for the product
CommissionSPIF (MONEY) SPIFF $ - this is the dollar value for the SPIFF for the employee in the search parameters and their commission group for the product
CommissionFixedCost (MONEY) Fixed Cost $ - this is the dollar value for the fixed cost for the employee in the search parameters and their commission group for the product
CommissionFloatingCost (MONEY) Floating Cost $ - this is a dollar value for the floating cost for the employee in the search parameters and their commission group for the product
Comments (VARCHAR(255)) Comments - comments from manual commission journal entries. This is an editable field in this report.
Suspend (BIT) Suspend - a check box indicates if the commission has been suspended. You can suspend commissions in the report, simply check the box and click save
HasBeenReversed (BIT) Has Been Reversed - if the commission has been reversed it will say Yes
EmployeeName3 (VARCHAR(51)) Tendered By - employee who tendered the invoice or who was logged on when Charge Back was completed
EmployeeUsername3 (VARCHAR(51)) Tendered By Username - username of the employee who tendered the invoice or who was logged in
ContractNumber (VARCHAR(50)) Contract # - contract number for the vendor rebate, if recorded
Reconciled (BIT) Reconciled - notes whether the vendor rebate which earned the was commission has been reconciled or not
ReconciledDate (DateTime) Reconciled date
CBReconciledDate (DateTime) CB Reconciled Date - date the Charge Back was reconciled
JournalName (VARCHAR(50)) Journal Name - Vendor Account Journal on which the rebate was reconciled
CBJournalName (VARCHAR(50)) CB Journal Name - Charge Back Journal on which the rebate was reconciled

CommissionSummaryReportData

[
    {
        "EmployeeName": "iQmetrix Employee",
        "EmployeeUsername": "iQmetrix.Employee",
        "EmployeeRole": "Corporate Account Executive",
        "EmployeeSpecialIdentifier": "",
        "StoreName": "84 West",
        "TotalCommission": 79.3
    }
]
Name Description
EmployeeName (VARCHAR(51)) Employee - name of each employee who earned commission at the location
EmployeeUsername (VARCHAR(51)) Username - username of the name of each employee who earned commission at the location
EmployeeRole (VARCHAR(50)) Role - assigned role that for the employee
EmployeeSpecialIdentifier (VARCHAR(25)) Employee ID - employee’s ID number
StoreName (NVARCHAR(MAX)) Location - location where the commission was earned
TotalCommission (MONEY) Total - total dollar amount of commission that the employee earned at that location

EmployeeCommissionStatusReportData

[
    {
        "EmployeeID": 216,
        "FirstName": "iQmetrix",
        "LastName": "Employee",
        "EmployeeName": "iQmetrix Employee",
        "Username": "iQmetrix.Employee",
        "SpecialIdentifier": "912345987654321",
        "RGPCommission": 5.72,
        "NSPCommission": 0,
        "VRPCommission": 0,
        "Coupon": 0,
        "VRPReconciledCommission": 0,
        "PartialCB": 0,
        "VRPRefunded": 0,
        "ChargeBack": 0,
        "ManualAdjustment": 0,
        "MilestoneRewardCommission": 0,
        "SuspendedCommission": 0
    }
]
Name Description
EmployeeID (INT) Internal identifier in RQ
FirstName (VARCHAR(25)) First name
LastName (VARCHAR(25)) Last name
EmployeeName (VARCHAR(51)) Employee - name of the employee
Username (VARCHAR(51)) Username - username of the employee as set up in the employee profile
SpecialIdentifier (VARCHAR(25)) ID # - employee ID number
RGPCommission (MONEY) Regular Product - commission dollar value for all regular products sold by the employee during the date range based upon the employee commission group and the product details for commissioning for that group. The amount can be positive or negative, depending on the company setup rules regarding commissioning.
NSPCommission (MONEY) Non-Stocked Product - commission dollar value for all non-stocked products sold by the employee during the date range based upon the employee commission group and the product details for commissioning that group. The amount can be positive or negative, depending on the company setup rules regarding commissioning.
VRPCommission (MONEY) Vendor Rebate - commission dollar value for all vendor rebate (VR) products sold by the employee during the date range based upon the employee commission group and the product details for commissioning for that group. The amount can be positive or negative, depending on the company setup rules regarding commissioning. If the item has been reconciled, it may be adjusted.
Coupon (MONEY) Coupon - commission dollar value for all coupons sold by the employee during the date range based on the employee commission group and the product details for commissioning that group
VRPReconciledCommission (MONEY) Reconciled VR - commission dollar value for all VR products that were sold by the employee and have been reconciled during the date range chosen. The amount can be positive or negative, depending on the company setup rules regarding commissioning, and when the transactions occurred. If the item has been reconciled, it may be adjusted.
PartialCB (MONEY) Partial CB - commission dollar value for all VR products that were sold by the employee and have been charged back during the date range chosen. This will always be a negative commission value as a charge back is always negative.
VRPRefunded (MONEY) Refunded VR - commission dollar value for all VR products that were sold by the employee and have been refunded during the date range chosen. These can be either a positive or negative commission value.
ChargeBack (MONEY) Charge Backs - commission value of the charge back transaction for the employee that was used in the search parameters
ManualAdjustment (MONEY) Manual Entry - will list the total dollar value of manual commission entries that the employee has received during the time period specified. The amount can be positive or negative.
MilestoneRewardCommission (MONEY) Milestone Reward - if Milestones are set up this column will show the commission reward for the sale
SuspendedCommission (MONEY) Suspended - all commissions that are suspended will be totaled in one column, regardless of the product type the commission came from. All suspended commissions as of the end of the date range chosen will be included.

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) Internal identifier in RQ
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

PartialChargeBackHistoryReportData

[
    {
        "CarrierPrice": 0,
        "ChargeBack": -1,
        "ChargeBackID": 25,
        "ChargeBackIDByStore": "REDSTCB10",
        "DateAdjusted": "2016-05-10T00:00:00",
        "DateCreated": "2016-05-10T08:18:57.377",
        "EmployeeName": "iQmetrix User",
        "InvoiceDate": "2016-03-16T00:00:00",
        "InvoiceIDByStore": "REDSTIN916",
        "ProductIdentifier": "ASBORB000098",
        "ProductName": "Apple iPhone 6 Plus 16GB Space Gray - AT&T",
        "Quantity": 1,
        "SaleInvoiceID": 127354,
        "SerialNumber": "123",
        "TotalPrice": 699,
        "UnitPrice": 700,
        "VendorName": "",
        "VendorSKU": ""
    }
]
Name Description
CarrierPrice (DECIMAL) Carrier Price - value or revenue that a carrier assigns this feature
ChargeBack (MONEY) Charge Back - amount the carrier is charging back
ChargeBackID (INT) RQ identifier for a Charge Back
ChargeBackIDByStore (VARCHAR (30)) Charge Back # - charge back invoice number assigned by RQ
DateAdjusted (DateTime) Applied Date - date the charge back was applied
DateCreated (DateTime) Charge Back Date - date the charge back took effect
EmployeeName (VARCHAR (51)) Charged Back By - name of the employee logged into RQ when the Charge Back was done
InvoiceDate (DateTime) Invoice Date - date of the original sale invoice
InvoiceIDByStore (VARCHAR (14)) Invoice # - invoice number assigned by RQ
ProductIdentifier (VARCHAR (12)) Product SKU - the RQ generated SKU
ProductName (NVARCHAR (MAX)) Product Name - description of the product as it appears in the inventory
Quantity (INT) Qty - total count of particular charged back SKUs on the charge back invoice
SaleInvoiceID (INT) Identifier for an invoice in RQ
SerialNumber (VARCHAR (100)) Tracking # - the tracking number associated with this entry, most frequently the customers mobile number
TotalPrice (MONEY) Total Rebate - original rebate less the return amount
UnitPrice (MONEY) Unit Rebate - reconciled amount, either the actual original amount or the adjusted from reconciliation amount
VendorName (NVARCHAR(MAX)) Name for a vendor in RQ
VendorSKU (VARCHAR(25)) Vendor SKU

ENUMERATIONS

CommissionReconcStatusTypes

Id Description
-1 All
0 NonReconciled
1 Reconciled
2 Journal
3 ReconciledAndNonReconcileable
4 JournalAndNonReconcileable
5 NonReconcileable

CommissionTypes

Id Description
0 NonCommissionable
1 SPIF
2 PercentageOfGrossSale
3 PercentageOfMargin
4 SPIFPlusPercentOfGrossSale
5 SPIFPlusPercentOfMargin
6 FixedCost
7 FloatingCost
8 PercentAboveFixedCost
9 PercentOfCoupon
10 Manual
11 MilestoneReward

TransactionTypes

Id Description
0 NotSet
1 Invoice
2 Refund
3 PartialChargeback
4 FullChargeback
5 SalesOrder
6 VendorRebateAdjustment

REQUESTS

GET the Commission By Invoice Report

For more information, see Commission by Invoice Report.

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/CommissionByInvoiceReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheCommissionByInvoiceReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/CommissionByInvoiceReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

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

public static CloseableHttpResponse GettingTheCommissionByInvoiceReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/CommissionByInvoiceReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/CommissionByInvoiceReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[CommissionByInvoiceReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CustomerName": "",
        "SaleInvoiceID": 134582,
        "DateCreated": "2017-04-03T00:00:00",
        "StoreName": "84 West",
        "RefundCodeID": "1cb93936-5777-2781-039f-c38e9c5a8b2c",
        "InvoiceIDByStore": "84WEAIN17784",
        "Comments": "",
        "TotalCommission": 19.93,
        "EmployeeName": "iQmetrix Employee",
        "EmployeeUsername": "iQmetrix.Employee",
        "FullChargeBackID": "720b9402-afdd-468c-1ea2-973f7a58adb2",
        "RowID": "87e3ff8c-db9c-1731-3085-3fede2e36355"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CustomerName": "",
            "SaleInvoiceID": 134582,
            "DateCreated": "2017-04-03T00:00:00",
            "StoreName": "84 West",
            "RefundCodeID": "1cb93936-5777-2781-039f-c38e9c5a8b2c",
            "InvoiceIDByStore": "84WEAIN17784",
            "Comments": "",
            "TotalCommission": 19.93,
            "EmployeeName": "iQmetrix Employee",
            "EmployeeUsername": "iQmetrix.Employee",
            "FullChargeBackID": "720b9402-afdd-468c-1ea2-973f7a58adb2",
            "RowID": "87e3ff8c-db9c-1731-3085-3fede2e36355"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CustomerName></CustomerName>
    <SaleInvoiceID>134582</SaleInvoiceID>
    <DateCreated>2017-04-03T00:00:00</DateCreated>
    <StoreName>84 West</StoreName>
    <RefundCodeID>1cb93936-5777-2781-039f-c38e9c5a8b2c</RefundCodeID>
    <InvoiceIDByStore>84WEAIN17784</InvoiceIDByStore>
    <Comments></Comments>
    <TotalCommission>19.93</TotalCommission>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <EmployeeUsername>iQmetrix.Employee</EmployeeUsername>
    <FullChargeBackID>720b9402-afdd-468c-1ea2-973f7a58adb2</FullChargeBackID>
    <RowID>87e3ff8c-db9c-1731-3085-3fede2e36355</RowID>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CustomerName,SaleInvoiceID,DateCreated,StoreName,RefundCodeID,InvoiceIDByStore,Comments,TotalCommission,EmployeeName,EmployeeUsername,FullChargeBackID,RowID
,134582,2017-04-03T00:00:00,84 West,1cb93936-5777-2781-039f-c38e9c5a8b2c,84WEAIN17784,,19.93,iQmetrix Employee,iQmetrix.Employee,720b9402-afdd-468c-1ea2-973f7a58adb2,87e3ff8c-db9c-1731-3085-3fede2e36355

Example Response (Excel)

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

GET the Commission By Product Report

For more information, see Commission by Product Report.

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/CommissionByProductReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&SearchMethod=1&CategoryNumber=10" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheCommissionByProductReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/CommissionByProductReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&SearchMethod=1&CategoryNumber=10");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

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

public static CloseableHttpResponse GettingTheCommissionByProductReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/CommissionByProductReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&SearchMethod=1&CategoryNumber=10");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


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

puts response

URI Parameters

Response Parameters

Array[CommissionByProductReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "SaleInvoiceID": 134582,
        "InvoiceIDByStore": "84WEAIN17784",
        "DateCreated": "2017-04-03T00:00:00",
        "GlobalProductID": 2833,
        "ProductIdentifier": "KLERNB000025",
        "SpecialProductID": 0,
        "ProductName": "iPhone 7",
        "Quantity": 1,
        "SerialNumber": "",
        "PriceWithVR": 45,
        "PriceWithoutVR": 45,
        "Cost": 0,
        "Profit": 45,
        "Adjustment": 0,
        "Commission": 4.6,
        "SoldBy": 268,
        "SoldByName": "iQmetrix Employee",
        "TenderedBy": 268,
        "TenderedByName": "iQmetrix Employee",
        "Split": false,
        "SplitWith": 0,
        "SplitWithName": "",
        "SplitRate": "",
        "InvoiceRowID": "b73943f9-e566-5c07-34e5-52f7ea302551",
        "ProductRowID": "77a6b2a7-d44c-f905-0bbe-d7a53e93b139"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "SaleInvoiceID": 134582,
            "InvoiceIDByStore": "84WEAIN17784",
            "DateCreated": "2017-04-03T00:00:00",
            "GlobalProductID": 2833,
            "ProductIdentifier": "KLERNB000025",
            "SpecialProductID": 0,
            "ProductName": "iPhone 7",
            "Quantity": 1,
            "SerialNumber": "",
            "PriceWithVR": 45,
            "PriceWithoutVR": 45,
            "Cost": 0,
            "Profit": 45,
            "Adjustment": 0,
            "Commission": 4.6,
            "SoldBy": 268,
            "SoldByName": "iQmetrix Employee",
            "TenderedBy": 268,
            "TenderedByName": "iQmetrix Employee",
            "Split": false,
            "SplitWith": 0,
            "SplitWithName": "",
            "SplitRate": "",
            "InvoiceRowID": "b73943f9-e566-5c07-34e5-52f7ea302551",
            "ProductRowID": "77a6b2a7-d44c-f905-0bbe-d7a53e93b139"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <SaleInvoiceID>134582</SaleInvoiceID>
    <InvoiceIDByStore>84WEAIN17784</InvoiceIDByStore>
    <DateCreated>2017-04-03T00:00:00</DateCreated>
    <GlobalProductID>2833</GlobalProductID>
    <ProductIdentifier>KLERNB000025</ProductIdentifier>
    <SpecialProductID>0</SpecialProductID>
    <ProductName>iPhone 7</ProductName>
    <Quantity>1</Quantity>
    <SerialNumber></SerialNumber>
    <PriceWithVR>45</PriceWithVR>
    <PriceWithoutVR>45</PriceWithoutVR>
    <Cost>0</Cost>
    <Profit>45</Profit>
    <Adjustment>0</Adjustment>
    <Commission>4.6</Commission>
    <SoldBy>268</SoldBy>
    <SoldByName>iQmetrix Employee</SoldByName>
    <TenderedBy>268</TenderedBy>
    <TenderedByName>iQmetrix Employee</TenderedByName>
    <Split>false</Split>
    <SplitWith>0</SplitWith>
    <SplitWithName></SplitWithName>
    <SplitRate></SplitRate>
    <InvoiceRowID>b73943f9-e566-5c07-34e5-52f7ea302551</InvoiceRowID>
    <ProductRowID>77a6b2a7-d44c-f905-0bbe-d7a53e93b139</ProductRowID>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
SaleInvoiceID,InvoiceIDByStore,DateCreated,GlobalProductID,ProductIdentifier,SpecialProductID,ProductName,Quantity,SerialNumber,PriceWithVR,PriceWithoutVR,Cost,Profit,Adjustment,Commission,SoldBy,SoldByName,TenderedBy,TenderedByName,Split,SplitWith,SplitWithName,SplitRate,InvoiceRowID,ProductRowID
134582,84WEAIN17784,2017-04-03T00:00:00,2833,KLERNB000025,0,iPhone 7,1,,45,45,0,45,0,4.6,268,iQmetrix Employee,268,iQmetrix Employee,false,0,,,b73943f9-e566-5c07-34e5-52f7ea302551,77a6b2a7-d44c-f905-0bbe-d7a53e93b139

Example Response (Excel)

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

GET the Commission Ledger Activity Report

For more information, see Commission Ledger Activity Report.

Definition

GET /reports/CommissionLedgerActivityReport?LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&LanguageCode={LanguageCode}&TransactionType={TransactionType}&ReconcStatus={ReconcStatus}&ProductIdentifier={ProductIdentifier}&JournalIDs={JournalIDs}&Auth={Auth}&Response={Response}

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/CommissionLedgerActivityReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&TransactionType=0&ReconcStatus=-1&ProductIdentifier=ASCLMO000001&JournalIDs=-1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheCommissionLedgerActivityReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/CommissionLedgerActivityReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&TransactionType=0&ReconcStatus=-1&ProductIdentifier=ASCLMO000001&JournalIDs=-1");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

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

public static CloseableHttpResponse GettingTheCommissionLedgerActivityReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/CommissionLedgerActivityReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&TransactionType=0&ReconcStatus=-1&ProductIdentifier=ASCLMO000001&JournalIDs=-1");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/CommissionLedgerActivityReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us&TransactionType=0&ReconcStatus=-1&ProductIdentifier=ASCLMO000001&JournalIDs=-1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[CommissionLedgerActivityReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "LedgerEntryID": 183842,
        "CustomerName": "",
        "StoreName": "84 West",
        "SaleInvoiceID": 134582,
        "FullChargeBackID": "87129c26-e07f-cb10-a7a9-3fd0112f77ad",
        "DateCreated": "2017-04-03T00:00:00",
        "InvoiceIDByStore": "84WEAIN17784",
        "Quantity": 1,
        "TransactionType": 1,
        "UnitCommission": 15.33,
        "TotalCommission": 15.33,
        "ProductIdentifier": "ASBCJA000115",
        "ProductName": "500 mAh li ion battery",
        "SerialNumber": "",
        "Split": false,
        "SplitRate1": 100,
        "SplitRate2": 0,
        "EmployeeName1": "iQmetrix Employee",
        "EmployeeUsername1": "iQmetrix.Employee",
        "SpecialIdentifier": "912345987654321",
        "EmployeeName2": "",
        "EmployeeUsername2": "",
        "CommissionType": 2,
        "CommissionRate": 10.22,
        "CommissionSPIF": 10.21,
        "CommissionFixedCost": 10.22,
        "CommissionFloatingCost": 10.22,
        "Comments": "",
        "Suspend": false,
        "HasBeenReversed": false,
        "EmployeeName3": "iQmetrix Employee",
        "EmployeeUsername3": "iQmetrix.Employee",
        "ContractNumber": "",
        "Reconciled": false,
        "ReconciledDate": "1900-01-01T00:00:00",
        "CBReconciledDate": "1900-01-01T00:00:00",
        "JournalName": "",
        "CBJournalName": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "LedgerEntryID": 183842,
            "CustomerName": "",
            "StoreName": "84 West",
            "SaleInvoiceID": 134582,
            "FullChargeBackID": "87129c26-e07f-cb10-a7a9-3fd0112f77ad",
            "DateCreated": "2017-04-03T00:00:00",
            "InvoiceIDByStore": "84WEAIN17784",
            "Quantity": 1,
            "TransactionType": 1,
            "UnitCommission": 15.33,
            "TotalCommission": 15.33,
            "ProductIdentifier": "ASBCJA000115",
            "ProductName": "500 mAh li ion battery",
            "SerialNumber": "",
            "Split": false,
            "SplitRate1": 100,
            "SplitRate2": 0,
            "EmployeeName1": "iQmetrix Employee",
            "EmployeeUsername1": "iQmetrix.Employee",
            "SpecialIdentifier": "912345987654321",
            "EmployeeName2": "",
            "EmployeeUsername2": "",
            "CommissionType": 2,
            "CommissionRate": 10.22,
            "CommissionSPIF": 10.21,
            "CommissionFixedCost": 10.22,
            "CommissionFloatingCost": 10.22,
            "Comments": "",
            "Suspend": false,
            "HasBeenReversed": false,
            "EmployeeName3": "iQmetrix Employee",
            "EmployeeUsername3": "iQmetrix.Employee",
            "ContractNumber": "",
            "Reconciled": false,
            "ReconciledDate": "1900-01-01T00:00:00",
            "CBReconciledDate": "1900-01-01T00:00:00",
            "JournalName": "",
            "CBJournalName": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <LedgerEntryID>183842</LedgerEntryID>
    <CustomerName></CustomerName>
    <StoreName>84 West</StoreName>
    <SaleInvoiceID>134582</SaleInvoiceID>
    <FullChargeBackID>87129c26-e07f-cb10-a7a9-3fd0112f77ad</FullChargeBackID>
    <DateCreated>2017-04-03T00:00:00</DateCreated>
    <InvoiceIDByStore>84WEAIN17784</InvoiceIDByStore>
    <Quantity>1</Quantity>
    <TransactionType>1</TransactionType>
    <UnitCommission>15.33</UnitCommission>
    <TotalCommission>15.33</TotalCommission>
    <ProductIdentifier>ASBCJA000115</ProductIdentifier>
    <ProductName>500 mAh li ion battery</ProductName>
    <SerialNumber></SerialNumber>
    <Split>false</Split>
    <SplitRate1>100</SplitRate1>
    <SplitRate2>0</SplitRate2>
    <EmployeeName1>iQmetrix Employee</EmployeeName1>
    <EmployeeUsername1>iQmetrix.Employee</EmployeeUsername1>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
    <EmployeeName2></EmployeeName2>
    <EmployeeUsername2></EmployeeUsername2>
    <CommissionType>2</CommissionType>
    <CommissionRate>10.22</CommissionRate>
    <CommissionSPIF>10.21</CommissionSPIF>
    <CommissionFixedCost>10.22</CommissionFixedCost>
    <CommissionFloatingCost>10.22</CommissionFloatingCost>
    <Comments></Comments>
    <Suspend>false</Suspend>
    <HasBeenReversed>false</HasBeenReversed>
    <EmployeeName3>iQmetrix Employee</EmployeeName3>
    <EmployeeUsername3>iQmetrix.Employee</EmployeeUsername3>
    <ContractNumber></ContractNumber>
    <Reconciled>false</Reconciled>
    <ReconciledDate>1900-01-01T00:00:00</ReconciledDate>
    <CBReconciledDate>1900-01-01T00:00:00</CBReconciledDate>
    <JournalName></JournalName>
    <CBJournalName></CBJournalName>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
LedgerEntryID,CustomerName,StoreName,SaleInvoiceID,FullChargeBackID,DateCreated,InvoiceIDByStore,Quantity,TransactionType,UnitCommission,TotalCommission,ProductIdentifier,ProductName,SerialNumber,Split,SplitRate1,SplitRate2,EmployeeName1,EmployeeUsername1,SpecialIdentifier,EmployeeName2,EmployeeUsername2,CommissionType,CommissionRate,CommissionSPIF,CommissionFixedCost,CommissionFloatingCost,Comments,Suspend,HasBeenReversed,EmployeeName3,EmployeeUsername3,ContractNumber,Reconciled,ReconciledDate,CBReconciledDate,JournalName,CBJournalName
183842,,84 West,134582,87129c26-e07f-cb10-a7a9-3fd0112f77ad,2017-04-03T00:00:00,84WEAIN17784,1,1,15.33,15.33,ASBCJA000115,500 mAh li ion battery,,false,100,0,iQmetrix Employee,iQmetrix.Employee,912345987654321,,,2,10.22,10.21,10.22,10.22,,false,false,iQmetrix Employee,iQmetrix.Employee,,false,1900-01-01T00:00:00,1900-01-01T00:00:00,,

Example Response (Excel)

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

GET the Commission Summary Report

For more information, see Commission Summary Report.

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/CommissionSummaryReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheCommissionSummaryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/CommissionSummaryReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

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

public static CloseableHttpResponse GettingTheCommissionSummaryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/CommissionSummaryReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/CommissionSummaryReport?LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[CommissionSummaryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "EmployeeName": "iQmetrix Employee",
        "EmployeeUsername": "iQmetrix.Employee",
        "EmployeeRole": "Corporate Account Executive",
        "EmployeeSpecialIdentifier": "",
        "StoreName": "84 West",
        "TotalCommission": 79.3
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "EmployeeName": "iQmetrix Employee",
            "EmployeeUsername": "iQmetrix.Employee",
            "EmployeeRole": "Corporate Account Executive",
            "EmployeeSpecialIdentifier": "",
            "StoreName": "84 West",
            "TotalCommission": 79.3
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <EmployeeUsername>iQmetrix.Employee</EmployeeUsername>
    <EmployeeRole>Corporate Account Executive</EmployeeRole>
    <EmployeeSpecialIdentifier></EmployeeSpecialIdentifier>
    <StoreName>84 West</StoreName>
    <TotalCommission>79.3</TotalCommission>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
EmployeeName,EmployeeUsername,EmployeeRole,EmployeeSpecialIdentifier,StoreName,TotalCommission
iQmetrix Employee,iQmetrix.Employee,Corporate Account Executive,,84 West,79.3

Example Response (Excel)

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

GET the Employee Commission Status Report

For more information, see Employee Commission Status Report.

Definition

GET /reports/EmployeeCommissionStatusReport?ForWho={ForWho}&ForWhoID={ForWhoID}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&Auth={Auth}&Response={Response}

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/EmployeeCommissionStatusReport?ForWho=4&ForWhoID=1&LocationType=Store&LocationTypeIDs=1,2&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheEmployeeCommissionStatusReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/EmployeeCommissionStatusReport?ForWho=4&ForWhoID=1&LocationType=Store&LocationTypeIDs=1,2&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

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

public static CloseableHttpResponse GettingTheEmployeeCommissionStatusReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/EmployeeCommissionStatusReport?ForWho=4&ForWhoID=1&LocationType=Store&LocationTypeIDs=1,2&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/EmployeeCommissionStatusReport?ForWho=4&ForWhoID=1&LocationType=Store&LocationTypeIDs=1,2&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[EmployeeCommissionStatusReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "EmployeeID": 216,
        "FirstName": "iQmetrix",
        "LastName": "Employee",
        "EmployeeName": "iQmetrix Employee",
        "Username": "iQmetrix.Employee",
        "SpecialIdentifier": "912345987654321",
        "RGPCommission": 5.72,
        "NSPCommission": 0,
        "VRPCommission": 0,
        "Coupon": 0,
        "VRPReconciledCommission": 0,
        "PartialCB": 0,
        "VRPRefunded": 0,
        "ChargeBack": 0,
        "ManualAdjustment": 0,
        "MilestoneRewardCommission": 0,
        "SuspendedCommission": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "EmployeeID": 216,
            "FirstName": "iQmetrix",
            "LastName": "Employee",
            "EmployeeName": "iQmetrix Employee",
            "Username": "iQmetrix.Employee",
            "SpecialIdentifier": "912345987654321",
            "RGPCommission": 5.72,
            "NSPCommission": 0,
            "VRPCommission": 0,
            "Coupon": 0,
            "VRPReconciledCommission": 0,
            "PartialCB": 0,
            "VRPRefunded": 0,
            "ChargeBack": 0,
            "ManualAdjustment": 0,
            "MilestoneRewardCommission": 0,
            "SuspendedCommission": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <EmployeeID>216</EmployeeID>
    <FirstName>iQmetrix</FirstName>
    <LastName>Employee</LastName>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <Username>iQmetrix.Employee</Username>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
    <RGPCommission>5.72</RGPCommission>
    <NSPCommission>0</NSPCommission>
    <VRPCommission>0</VRPCommission>
    <Coupon>0</Coupon>
    <VRPReconciledCommission>0</VRPReconciledCommission>
    <PartialCB>0</PartialCB>
    <VRPRefunded>0</VRPRefunded>
    <ChargeBack>0</ChargeBack>
    <ManualAdjustment>0</ManualAdjustment>
    <MilestoneRewardCommission>0</MilestoneRewardCommission>
    <SuspendedCommission>0</SuspendedCommission>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
EmployeeID,FirstName,LastName,EmployeeName,Username,SpecialIdentifier,RGPCommission,NSPCommission,VRPCommission,Coupon,VRPReconciledCommission,PartialCB,VRPRefunded,ChargeBack,ManualAdjustment,MilestoneRewardCommission,SuspendedCommission
216,iQmetrix,Employee,iQmetrix Employee,iQmetrix.Employee,912345987654321,5.72,0,0,0,0,0,0,0,0,0,0

Example Response (Excel)

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

GET the Partial Charge Back History Report

For more information, see Partial Charge Back History Report.

Definition

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

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/partialchargebackhistoryreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingThePartialChargeBackHistoryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/partialchargebackhistoryreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

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

public static CloseableHttpResponse GettingThePartialChargeBackHistoryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/partialchargebackhistoryreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/reports/partialchargebackhistoryreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PartialChargeBackHistoryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CarrierPrice": 0,
        "ChargeBack": -1,
        "ChargeBackID": 25,
        "ChargeBackIDByStore": "REDSTCB10",
        "DateAdjusted": "2016-05-10T00:00:00",
        "DateCreated": "2016-05-10T08:18:57.377",
        "EmployeeName": "iQmetrix User",
        "InvoiceDate": "2016-03-16T00:00:00",
        "InvoiceIDByStore": "REDSTIN916",
        "ProductIdentifier": "ASBORB000098",
        "ProductName": "Apple iPhone 6 Plus 16GB Space Gray - AT&T",
        "Quantity": 1,
        "SaleInvoiceID": 127354,
        "SerialNumber": "123",
        "TotalPrice": 699,
        "UnitPrice": 700,
        "VendorName": "",
        "VendorSKU": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CarrierPrice": 0,
            "ChargeBack": -1,
            "ChargeBackID": 25,
            "ChargeBackIDByStore": "REDSTCB10",
            "DateAdjusted": "2016-05-10T00:00:00",
            "DateCreated": "2016-05-10T08:18:57.377",
            "EmployeeName": "iQmetrix User",
            "InvoiceDate": "2016-03-16T00:00:00",
            "InvoiceIDByStore": "REDSTIN916",
            "ProductIdentifier": "ASBORB000098",
            "ProductName": "Apple iPhone 6 Plus 16GB Space Gray - AT&T",
            "Quantity": 1,
            "SaleInvoiceID": 127354,
            "SerialNumber": "123",
            "TotalPrice": 699,
            "UnitPrice": 700,
            "VendorName": "",
            "VendorSKU": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CarrierPrice>0</CarrierPrice>
    <ChargeBack>-1</ChargeBack>
    <ChargeBackID>25</ChargeBackID>
    <ChargeBackIDByStore>REDSTCB10</ChargeBackIDByStore>
    <DateAdjusted>2016-05-10T00:00:00</DateAdjusted>
    <DateCreated>2016-05-10T08:18:57.377</DateCreated>
    <EmployeeName>iQmetrix User</EmployeeName>
    <InvoiceDate>2016-03-16T00:00:00</InvoiceDate>
    <InvoiceIDByStore>REDSTIN916</InvoiceIDByStore>
    <ProductIdentifier>ASBORB000098</ProductIdentifier>
    <ProductName>Apple iPhone 6 Plus 16GB Space Gray - AT&T</ProductName>
    <Quantity>1</Quantity>
    <SaleInvoiceID>127354</SaleInvoiceID>
    <SerialNumber>123</SerialNumber>
    <TotalPrice>699</TotalPrice>
    <UnitPrice>700</UnitPrice>
    <VendorName></VendorName>
    <VendorSKU></VendorSKU>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CarrierPrice,ChargeBack,ChargeBackID,ChargeBackIDByStore,DateAdjusted,DateCreated,EmployeeName,InvoiceDate,InvoiceIDByStore,ProductIdentifier,ProductName,Quantity,SaleInvoiceID,SerialNumber,TotalPrice,UnitPrice,VendorName,VendorSKU
0,-1,25,REDSTCB10,2016-05-10T00:00:00,2016-05-10T08:18:57.377,iQmetrix User,2016-03-16T00:00:00,REDSTIN916,ASBORB000098,Apple iPhone 6 Plus 16GB Space Gray - AT&T,1,127354,123,699,700,,

Example Response (Excel)

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

GET the Vendor Rebate History Report

For more information, see Vendor Rebate History Report.

Definition

GET /reports/vendorrebatehistoryreport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&SearchMethod={SearchMethod}&ApplyShowOnInvoice={ApplyShowOnInvoice}&ReconciledStatus={ReconciledStatus}&EmployeeIDOfReconcilers={EmployeeIDOfReconcilers}&VendorAccountID={VendorAccountID}&CategoryNumber={CategoryNumber}&ProductIdentifier={ProductIdentifier}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&SerialNumber={SerialNumber}&JournalNumber={JournalNumber}&Auth={Auth}&Response={Response}

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/vendorrebatehistoryreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=true&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&ProductIdentifier=ASCLMO000001&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheVendorRebateHistoryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/vendorrebatehistoryreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=true&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&ProductIdentifier=ASCLMO000001&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

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

public static CloseableHttpResponse GettingTheVendorRebateHistoryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/vendorrebatehistoryreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=true&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&ProductIdentifier=ASCLMO000001&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


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

puts response

URI Parameters

Response Parameters

Array[VendorRebateHistoryReportData]

Example Response (Default)

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

Example Response (JsonDataTable)

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

Example Response (XmlDataTable)

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

Example Response (CSV)

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

Example Response (Excel)

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

GET the Vendor Rebate History Report By Category and Store

For more information, see Vendor Rebate History Report.

Definition

GET /reports/vendorrebatehistoryreport_bycategoryandstore?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&SearchMethod={SearchMethod}&ApplyShowOnInvoice={ApplyShowOnInvoice}&ReconciledStatus={ReconciledStatus}&EmployeeIDOfReconcilers={EmployeeIDOfReconcilers}&VendorAccountID={VendorAccountID}&CategoryNumber={CategoryNumber}&ProductIdentifier={ProductIdentifier}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&SerialNumber={SerialNumber}&JournalNumber={JournalNumber}&Auth={Auth}&Response={Response}

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/vendorrebatehistoryreport_bycategoryandstore?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&ProductIdentifier=ASCLMO000001&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheVendorRebateHistoryReportByCategoryAndStore()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/vendorrebatehistoryreport_bycategoryandstore?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&ProductIdentifier=ASCLMO000001&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

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

public static CloseableHttpResponse GettingTheVendorRebateHistoryReportByCategoryAndStore() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/vendorrebatehistoryreport_bycategoryandstore?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&ProductIdentifier=ASCLMO000001&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


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

puts response

URI Parameters

Response Parameters

Array[VendorRebateHistoryReportData]

Example Response (Default)

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

Example Response (JsonDataTable)

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

Example Response (XmlDataTable)

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

Example Response (CSV)

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

Example Response (Excel)

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

GET the Vendor Rebate History Report By Category and Employees

For more information, see Vendor Rebate History Report.

Definition

GET /reports/vendorrebatehistoryreport_bycategoryandemployees?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&SearchMethod={SearchMethod}&ApplyShowOnInvoice={ApplyShowOnInvoice}&ReconciledStatus={ReconciledStatus}&EmployeeIDOfReconcilers={EmployeeIDOfReconcilers}&VendorAccountID={VendorAccountID}&CategoryNumber={CategoryNumber}&ProductIdentifier={ProductIdentifier}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&SerialNumber={SerialNumber}&JournalNumber={JournalNumber}&Auth={Auth}&Response={Response}

Headers

Example Request

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

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/vendorrebatehistoryreport_bycategoryandemployees?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&ProductIdentifier=ASCLMO000001&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheVendorRebateHistoryReportByCategoryAndEmployees()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/vendorrebatehistoryreport_bycategoryandemployees?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&ProductIdentifier=ASCLMO000001&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

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

public static CloseableHttpResponse GettingTheVendorRebateHistoryReportByCategoryAndEmployees() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/vendorrebatehistoryreport_bycategoryandemployees?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&SearchMethod=4&ApplyShowOnInvoice=0&ReconciledStatus=2&EmployeeIDOfReconcilers=-1&VendorAccountID=1&CategoryNumber=10&ProductIdentifier=ASCLMO000001&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us&SerialNumber=990003427999221&JournalNumber=Feb 2015 Spiff");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


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

puts response

URI Parameters

Response Parameters

Array[VendorRebateHistoryReportData]

Example Response (Default)

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

Example Response (JsonDataTable)

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

Example Response (XmlDataTable)

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

Example Response (CSV)

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

Example Response (Excel)

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

ERRORS

HTTP Status Code Description How to Resolve
HTTP 400 Bad Request Ensure request body is formatted properly
HTTP 401 Token is invalid Ensure Access Token is valid and has not expired
HTTP 403 Unauthorized Ensure Access Token is valid and user has appropriate security
HTTP 404 Not Found Ensure URI is valid
HTTP 500 Unexpected Error See Message in response for more information
HTTP 503 Maintenance The requested data is currently undergoing scheduled maintenance, please try again after 12:00PM UTC
Was this page helpful?