API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

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

To get started, see Data Connect Guide.

Note

For requests 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

GLAccountActivityReportData

[
    {
        "AccountID": 2002,
        "StoreID": 1,
        "TrueAccountNumber": "4000",
        "FalseAccountNumber": "400084WEA",
        "AccountName": "Sale Revenue",
        "Consolidate": 0,
        "Debit": 169.2,
        "Credit": 12151063.04
    }
]
Name Description
AccountID (INT) Internal identifier for an Account in RQ
StoreID (INT) Internal identifier for a store in RQ
TrueAccountNumber (VARCHAR(50)) Full account identifier
FalseAccountNumber (VARCHAR(150)) Account # - account number created by RQ when the account was initially created
AccountName (VARCHAR(100)) Account name
Consolidate (INT) A flag to indicate if the Consolidate toggle was selected
Debit (MONEY) Debit - Debit amount of the G/L transaction
Credit (MONEY) Credit - Credit amount of the G/L transaction

CompanyDetailData

[
    {
        "TransactionID": 1258989,
        "StoreID": 1,
        "StoreName": "84 West",
        "TrueAccountNumber": "4000",
        "FalseAccountNumber": "400084WEA",
        "AccountID": 8,
        "Debit": 169.2,
        "Credit": 12151063.04,
        "DateCreatedAtMidnight": "2016-01-05T00:00:00",
        "SourceID": 126533,
        "SourceGUID": "e0a765a5-08b4-114f-0c57-1c25394b27f8",
        "SourceIDByStore": "84WEAIN11546",
        "SourceType": 2,
        "MemberNumber": "123412341234",
        "EmployeeUsername": "iQmetrix.Employee",
        "SpecialIdentifier": "912345987654321"
    }
]
Name Description
TransactionID (BIGINT) Internal identifier for a transaction in RQ
StoreID (INT) Internal identifier for a store in RQ
StoreName (NVARCHAR(MAX)) Location Affected - location that either tendered the invoice or receives credit for a payment
TrueAccountNumber (VARCHAR(50)) Full account identifier
FalseAccountNumber (VARCHAR(150)) Account # - account number created by RQ when the account was initially created
AccountID (INT) Internal identifier for an account in RQ
Debit (MONEY) Debit - Debit amount of the G/L transaction
Credit (MONEY) Credit - Credit amount of the G/L transaction
DateCreatedAtMidnight (DateTime) Created On - date and time that the new invoice, refund or payment was posted to the account
SourceID (INT) Internal value in RQ
SourceGUID (UNIQUEIDENTIFIER) Internal value in RQ
SourceIDByStore (VARCHAR(14)) Invoice # - invoice number assigned by RQ
SourceType (TINYINT) See SourceType for list of acceptable values
MemberNumber (VARCHAR(30)) Member number
EmployeeUsername (VARCHAR(51)) Employee user name
SpecialIdentifier (VARCHAR(25)) Employee ID number assigned when hired

GreatPlainData

[
    {
        "ExportStyle": 1,
        "Reference": "84WEAIN11546",
        "Account": "400084WEA",
        "Amount": -2.25,
        "Date": "2016-01-05T00:00:00",
        "DistributionReference": "84WEAIN11546"
    }
]
Name Description
ExportStyle (INT) Internal value in RQ
Reference (VARCHAR(30)) Reference # - any reference number added to the invoice at the time of transaction
Account (VARCHAR(150)) Account # - account number created by RQ when the account was initially created
Amount (MONEY) Amount
Date (DateTime) Created On - date and time that the new invoice, refund or payment was posted to the account
DistributionReference (VARCHAR(30)) Invoice # - invoice number assigned by RQ

QuickbookData

[
    {
        "Date": "2016-01-05T00:00:00",
        "Account": "400084WEA",
        "Class": "",
        "Amount": -2.25,
        "Memo": 2,
        "DocNum": "HJKIIIN2",
        "Name": ""
    }
]
Name Description
Date (DateTime) Created On - date and time that the new invoice, refund or payment was posted to the account
Account (VARCHAR(50)) Account # - account number created by RQ when the account was initially created
Class (VARCHAR(100)) Internal value in RQ
Amount (MONEY) Amount
Memo (TINYINT) Memo
DocNum (VARCHAR(20)) Invoice #
Name (VARCHAR(50)) Name

ENUMERATIONS

SourceType

Id Name
0 OpeningBalance
1 ReceivePO
2 Invoice
3 SalesOrder
4 PayOut
5 AccountPayment
6 VendorDeposit
7 Transfer
8 StockBalance
9 Loan
10 InventoryAdjustment
11 Cashout
12 VendorRebateAdjustment
13 ChargeBack
14 StartingInventoryCounts
15 GiftCardMaintenance
16 BillPayment
17 FullChargeBack

REQUESTS

GET the GL Account Activity Report

For more information see G/L Account Activity Report.

Definition

GET /Finance/GLAccountActivityReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}

Headers

Example Request

GET /Finance/GLAccountActivityReport?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/Finance/GLAccountActivityReport?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 GettingTheGlAccountActivityReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/Finance/GLAccountActivityReport?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 GettingTheGlAccountActivityReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/Finance/GLAccountActivityReport?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/Finance/GLAccountActivityReport?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[GLAccountActivityReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "AccountID": 2002,
        "StoreID": 1,
        "TrueAccountNumber": "4000",
        "FalseAccountNumber": "400084WEA",
        "AccountName": "Sale Revenue",
        "Consolidate": 0,
        "Debit": 169.2,
        "Credit": 12151063.04
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "AccountID": 2002,
            "StoreID": 1,
            "TrueAccountNumber": "4000",
            "FalseAccountNumber": "400084WEA",
            "AccountName": "Sale Revenue",
            "Consolidate": 0,
            "Debit": 169.2,
            "Credit": 12151063.04
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <AccountID>2002</AccountID>
    <StoreID>1</StoreID>
    <TrueAccountNumber>4000</TrueAccountNumber>
    <FalseAccountNumber>400084WEA</FalseAccountNumber>
    <AccountName>Sale Revenue</AccountName>
    <Consolidate>0</Consolidate>
    <Debit>169.2</Debit>
    <Credit>12151063.04</Credit>
  </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
AccountID,StoreID,TrueAccountNumber,FalseAccountNumber,AccountName,Consolidate,Debit,Credit
2002,1,4000,400084WEA,Sale Revenue,0,169.2,12151063.04

Example Response (Excel)

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

GET the GL Account Activity Report for Company Details

For more information see G/L Account Activity Report.

Definition

GET /Finance/GLAccountActivityReport/CompanyDetail?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&AccountID={AccountID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}

Headers

Example Request

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

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

puts response

URI Parameters

Response Parameters

Array[CompanyDetailData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "TransactionID": 1258989,
        "StoreID": 1,
        "StoreName": "84 West",
        "TrueAccountNumber": "4000",
        "FalseAccountNumber": "400084WEA",
        "AccountID": 8,
        "Debit": 169.2,
        "Credit": 12151063.04,
        "DateCreatedAtMidnight": "2016-01-05T00:00:00",
        "SourceID": 126533,
        "SourceGUID": "e0a765a5-08b4-114f-0c57-1c25394b27f8",
        "SourceIDByStore": "84WEAIN11546",
        "SourceType": 2,
        "MemberNumber": "123412341234",
        "EmployeeUsername": "iQmetrix.Employee",
        "SpecialIdentifier": "912345987654321"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "TransactionID": 1258989,
            "StoreID": 1,
            "StoreName": "84 West",
            "TrueAccountNumber": "4000",
            "FalseAccountNumber": "400084WEA",
            "AccountID": 8,
            "Debit": 169.2,
            "Credit": 12151063.04,
            "DateCreatedAtMidnight": "2016-01-05T00:00:00",
            "SourceID": 126533,
            "SourceGUID": "e0a765a5-08b4-114f-0c57-1c25394b27f8",
            "SourceIDByStore": "84WEAIN11546",
            "SourceType": 2,
            "MemberNumber": "123412341234",
            "EmployeeUsername": "iQmetrix.Employee",
            "SpecialIdentifier": "912345987654321"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <TransactionID>1258989</TransactionID>
    <StoreID>1</StoreID>
    <StoreName>84 West</StoreName>
    <TrueAccountNumber>4000</TrueAccountNumber>
    <FalseAccountNumber>400084WEA</FalseAccountNumber>
    <AccountID>8</AccountID>
    <Debit>169.2</Debit>
    <Credit>12151063.04</Credit>
    <DateCreatedAtMidnight>2016-01-05T00:00:00</DateCreatedAtMidnight>
    <SourceID>126533</SourceID>
    <SourceGUID>e0a765a5-08b4-114f-0c57-1c25394b27f8</SourceGUID>
    <SourceIDByStore>84WEAIN11546</SourceIDByStore>
    <SourceType>2</SourceType>
    <MemberNumber>123412341234</MemberNumber>
    <EmployeeUsername>iQmetrix.Employee</EmployeeUsername>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
TransactionID,StoreID,StoreName,TrueAccountNumber,FalseAccountNumber,AccountID,Debit,Credit,DateCreatedAtMidnight,SourceID,SourceGUID,SourceIDByStore,SourceType,MemberNumber,EmployeeUsername,SpecialIdentifier
1258989,1,84 West,4000,400084WEA,8,169.2,12151063.04,2016-01-05T00:00:00,126533,e0a765a5-08b4-114f-0c57-1c25394b27f8,84WEAIN11546,2,123412341234,iQmetrix.Employee,912345987654321

Example Response (Excel)

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

GET the GL Account Activity Report for Great Plains

For more information see G/L Account Activity Report.

Definition

GET /Finance/GLAccountActivityReport/GreatPlains?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}

Headers

Example Request

GET /Finance/GLAccountActivityReport/GreatPlains?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/Finance/GLAccountActivityReport/GreatPlains?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 GettingTheGlAccountActivityReportForGreatPlains()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/Finance/GLAccountActivityReport/GreatPlains?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 GettingTheGlAccountActivityReportForGreatPlains() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/Finance/GLAccountActivityReport/GreatPlains?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/Finance/GLAccountActivityReport/GreatPlains?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[GreatPlainData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ExportStyle": 1,
        "Reference": "84WEAIN11546",
        "Account": "400084WEA",
        "Amount": -2.25,
        "Date": "2016-01-05T00:00:00",
        "DistributionReference": "84WEAIN11546"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ExportStyle": 1,
            "Reference": "84WEAIN11546",
            "Account": "400084WEA",
            "Amount": -2.25,
            "Date": "2016-01-05T00:00:00",
            "DistributionReference": "84WEAIN11546"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ExportStyle>1</ExportStyle>
    <Reference>84WEAIN11546</Reference>
    <Account>400084WEA</Account>
    <Amount>-2.25</Amount>
    <Date>2016-01-05T00:00:00</Date>
    <DistributionReference>84WEAIN11546</DistributionReference>
  </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
ExportStyle,Reference,Account,Amount,Date,DistributionReference
1,84WEAIN11546,400084WEA,-2.25,2016-01-05T00:00:00,84WEAIN11546

Example Response (Excel)

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

GET the GL Account Activity Report for Quickbooks

For more information see G/L Account Activity Report.

Definition

GET /Finance/GLAccountActivityReport/Quickbooks?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&ExcludeTransfers={ExcludeTransfers}&PONumType={PONumType}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}

Headers

Example Request

GET /Finance/GLAccountActivityReport/Quickbooks?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&ExcludeTransfers=false&PONumType=0&ForWho=1&ForWhoIDs=-1&LocationType=Store&LocationTypeIDs=1,2
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[QuickbookData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Date": "2016-01-05T00:00:00",
        "Account": "400084WEA",
        "Class": "",
        "Amount": -2.25,
        "Memo": 2,
        "DocNum": "HJKIIIN2",
        "Name": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Date": "2016-01-05T00:00:00",
            "Account": "400084WEA",
            "Class": "",
            "Amount": -2.25,
            "Memo": 2,
            "DocNum": "HJKIIIN2",
            "Name": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Date>2016-01-05T00:00:00</Date>
    <Account>400084WEA</Account>
    <Class></Class>
    <Amount>-2.25</Amount>
    <Memo>2</Memo>
    <DocNum>HJKIIIN2</DocNum>
    <Name></Name>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
Date,Account,Class,Amount,Memo,DocNum,Name
2016-01-05T00:00:00,400084WEA,,-2.25,2,HJKIIIN2,

Example Response (Excel)

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

ERRORS

HTTP Status Code Description How to Resolve
HTTP 400 Bad Request Ensure request body is formatted properly
HTTP 401 Tokan is invalid Ensure Access Token is valid and has not expired
HTTP 403 Unauthorized Ensure Access Token is valid and user has appropriate security
HTTP 404 Not Found Ensure URI is valid
HTTP 500 Unexpected Error See Message in response for more information
Was this page helpful?