DataConnect is a web-based connector service you can use to extract data from iQmetrix by making simple HTTP requests. It provides endpoints for common data requirements, various auth mechanisms and other utility endpoints.
Found a Mistake?
We appreciate your patience as we work to improve the documentation for DataConnect. If you have noticed a mistake or have a qustion, please let us know at apisupport [at] iqmetrix [dot] com, subject "Documentation Issue".
Common Parameters
For a complete list of parameters that are accessible to all DataConnect endpoints, see Session endpoint.
Security Protocols
We recommend that users use TLS 1.2 when connecting to DataConnect.
Error Messages
DataConnect returns standard HTTP status codes (400, 401, 403, 404, 500, 503) and readable error messages. For an example of these messages see Session endpoint.
Sign Up
To signup, contact your account manager for pricing and onboarding with DataConnect Deltas.
Bearer token. See Obtaining an Access Token
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | bearer |
StartDate required | string Example: StartDate=2019-10-01T18:00:00.000 Initial date and time of the search period, defaults to the beginning of SQL time |
StopDate required | string Example: StopDate=2019-10-01T18:15:00.000 End date and time of the search period, defaults to now |
LocationType | string Example: LocationType=Company When provided, will filter based on the Location Tree |
LocationTypeIDs | string Default: "-1" Example: LocationTypeIDs=-1 Will filter based on the ID(s) within the Company Tree level indicated in LocationType. |
Successful Response
Release Candidate (RC)
Production
[- {
- "CustomerID": "659c2a38-d083-4421-9330-46d779702f85",
- "LegacyCustomerID": 7,
- "FirstName": "",
- "LastName": "",
- "Address": "",
- "Address2": "",
- "City": "",
- "Region": "",
- "ZipPostal": "",
- "URL": "",
- "SalesPersonEmployeeID": 41,
- "Title": "",
- "Country": "",
- "Notes": "",
- "VIP_customer": 41,
- "DefaultPhone": "",
- "WorkPhoneNumber": "",
- "HomePhoneNumber": "",
- "FaxNumber": "",
- "OtherPhone": "",
- "Email": "",
- "EmailCRMID": "",
- "EmailCRMTypeID": 40,
- "MainPhone": "",
- "Pager": "",
- "CellPhone": "",
- "CustomerType": "",
- "AssignedToEmployeeID": 48,
- "DoNotEmail": "",
- "DeclineToProvideEmail": "",
- "DoNotPostOfficeMail": "",
- "DoNotCall": "",
- "DateOfLastMarketingCampaign": "",
- "ContactType": "",
- "IndustryType": "",
- "PositionType": "",
- "SpecialIdentifier": "",
- "CompanySize": "",
- "MultiLevelPrice": "",
- "AcceptCheques": "",
- "EmailSetDate": "",
- "EmailSetEmployeeID": 30,
- "MemberNumber": "",
- "StoreLocationID": 34,
- "EmailSetStoreLocationID": 21,
- "DisplayNotesOnCustomerProfileStartUp": "",
- "CompanyContact": "",
- "AppleDEP": "",
- "RowThumbprint": "aa60b3b5-d0dd-47aa-84d8-05bd6d9e7326",
- "RowInserted": "2019-04-25T06:19:12.343Z",
- "RowUpdated": "",
- "RowEvent": "Added",
- "Customer_Name": ""
}
]
StartDate required | string Example: StartDate=2019-10-01T18:00:00.000 Initial date and time of the search period, defaults to the beginning of SQL time |
StopDate required | string Example: StopDate=2019-10-01T18:15:00.000 End date and time of the search period, defaults to now |
LocationType | string Example: LocationType=Company When provided, will filter based on the Location Tree |
LocationTypeIDs | string Default: "-1" Example: LocationTypeIDs=-1 Will filter based on the ID(s) within the Company Tree level indicated in LocationType. |
Successful Response
Release Candidate (RC)
Production
[- {
- "AccountsReceivableID": 1,
- "AccountsReceivableIDByStore": "TALLAAR1",
- "EmployeeID": 58001,
- "CustomerID": "ab55bf26-7b51-4d27-896a-52d850909685",
- "LocationID": 33484,
- "BillingCompany": "Kentel",
- "BillingName": "",
- "BillingAddress": "N/A",
- "BillingCity": "N/A",
- "BillingProvinceOrState": "N/A",
- "BillingCountry": "USA",
- "BillingPostalOrZipCode": 0,
- "CreditLimit": 10000,
- "PORequired": false,
- "Balance": 0,
- "Comments": "",
- "GLAccountID": 3,
- "Enabled": true,
- "DisplayCommentsOnStatement": false,
- "DoNotMail": false,
- "BillingPhoneNumber": "",
- "RowThumbprint": "128fe227-b14d-4bd5-9704-f2389650b2f7",
- "RowInserted": "2019-06-17T15:33:55.793Z",
- "RowUpdated": "",
- "RowEvent": "Added"
}
]
StartDate required | string Example: StartDate=2019-10-01T18:00:00.000 Initial date and time of the search period, defaults to the beginning of SQL time |
StopDate required | string Example: StopDate=2019-10-01T18:15:00.000 End date and time of the search period, defaults to now |
LocationType | string Example: LocationType=Company When provided, will filter based on the Location Tree |
LocationTypeIDs | string Default: "-1" Example: LocationTypeIDs=-1 Will filter based on the ID(s) within the Company Tree level indicated in LocationType. |
LanguageCode | string Default: "en-us" Example: LanguageCode=en-us Language code |
Successful Response
Release Candidate (RC)
Production
[- {
- "ActivityID": 1,
- "ActivityType": "Sale Invoice",
- "LocationID": 33484,
- "EmployeeID": 58001,
- "AssignedToEmployeeID": 46737,
- "ContactName": "John Test",
- "ContactNumber": 5555555555,
- "Description": "Invoice # 90956406623",
- "DescriptionID": -1,
- "Details": "Date: 6/17/2008 9:47:31 AM",
- "Priority": "Low",
- "DateCreated": "2019-06-17T09:47:31.000Z",
- "DateClosed": "2019-06-17T15:42:45.880Z",
- "Status": "Completed",
- "CustomerID": "ff40c64c-ceb4-474b-8834-de403f05da72",
- "KeepUpdatedOnActivityList": false,
- "PickedUpByCustomerID": "ff40c64c-ceb4-474b-8834-de403f05da72",
- "DiscussionID": 8,
- "RowThumbprint": "a0d895ab-5060-4a84-8070-052d59e96d0b",
- "RowInserted": "2019-06-17T09:47:31.000Z",
- "RowUpdated": "",
- "RowEvent": "Added"
}
]
StartDate required | string Example: StartDate=2019-10-01T18:00:00.000 Initial date and time of the search period, defaults to the beginning of SQL time |
StopDate required | string Example: StopDate=2019-10-01T18:15:00.000 End date and time of the search period, defaults to now |
Successful Response
Release Candidate (RC)
Production
[- {
- "DiscussionID": 1,
- "RootDiscussionID": 25,
- "DiscussionText": "",
- "EmployeeID": 58001,
- "RowThumbprint": "94172388-523d-40d6-9813-659832cc3ec8",
- "RowInserted": "2019-06-03T17:17:59.677Z",
- "RowUpdated": "",
- "RowEvent": "Added"
}
]
StartDate required | string Example: StartDate=2019-10-01T18:00:00.000 Initial date and time of the search period, defaults to the beginning of SQL time |
StopDate required | string Example: StopDate=2019-10-01T18:15:00.000 End date and time of the search period, defaults to now |
LocationType | string Example: LocationType=Company When provided, will filter based on the Location Tree |
LocationTypeIDs | string Default: "-1" Example: LocationTypeIDs=-1 Will filter based on the ID(s) within the Company Tree level indicated in LocationType. |
Successful Response
Release Candidate (RC)
Production
[- {
- "FollowUpID": 8,
- "AssignedToID": 46882,
- "LocationID": 33484,
- "DateFollowUp": "2019-05-20T15:00:00.000Z",
- "Abstract": "",
- "FollowUpDescription": "",
- "Completed": true,
- "Archived": false,
- "RowThumbprint": "2104042d-5ddf-49f5-a530-2678074c65f7",
- "RowInserted": "2019-05-18T14:44:35.843Z",
- "RowUpdated": "",
- "RowEvent": "Added"
}
]
StartDate required | string Example: StartDate=2019-10-01T18:00:00.000 Initial date and time of the search period, defaults to the beginning of SQL time |
StopDate required | string Example: StopDate=2019-10-01T18:15:00.000 End date and time of the search period, defaults to now |