Documentation Powered by ReDoc

DataConnect Deltas (1.3.1.42)

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 authentication 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.

Authentication

bearerAuth

Bearer token. See Obtaining an Access Token

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

Customers

Customers

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"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": ""
}
]

Customers / Accounts

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"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"
}
]

Customers / Activities

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"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"
}
]

Customers / Activities / Discussions

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"DiscussionID": 1,
"RootDiscussionID": 25,
"DiscussionText": "",
"EmployeeID": 58001,
"RowThumbprint": "94172388-523d-40d6-9813-659832cc3ec8",
"RowInserted": "2019-06-03T17:17:59.677Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Customers / Activities / Followups

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"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"
}
]

Customers / Protection

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"LastName": "Test",
"FirstName": "John",
"ProtectionCustomerID": "8f9ebc84-ddb9-4757-b41e-940ccf81f5ca",
"RowThumbprint": "5f29abd7-f6a1-45b2-ba45-23e823971d2b",
"RowInserted": "2019-11-06T21:24:17.080Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Employees

Employees

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"EmployeeID": 58001,
"LegacyEmployeeID": 1,
"FirstName": "Steve",
"LastName": "Test",
"Email": "test@test.com",
"PersonalEmail": "",
"Address": "205 Main st",
"Address2": "",
"City": "Minneapolis",
"Region": "MN",
"ZipPostal": 91210,
"Country": "USA",
"HomePhoneNumber": 5555555555,
"WorkPhoneNumber": 5555555555,
"CellPhone": 5555555555,
"Pager": "",
"Title": "Title!",
"Account_Disabled": false,
"Comments": "",
"RoleName": "Administrator",
"CommissionGroupID": 6,
"Gender": 1,
"SpecialIdentifier": 51235123523623,
"SupervisorEmployeeID": 46,
"BirthDate": "1899-12-30T00:00:00.000Z",
"StartDate": "2019-06-17T14:39:52.967Z",
"Website": "",
"DefaultLocationID": 157568,
"TimeOffCodeVacation": "",
"TimeOffCodeSickDay": "",
"TimeOffCodePersonalDay": "",
"TerminationDate": "",
"TerminationNotes": "",
"ScheduledTerminationDate": "",
"ScheduledTerminationNotes": "",
"IsPartTime": false,
"VacationDaysAvailable": 22,
"SickDaysAvailable": 113,
"PersonalDaysAvailable": 4,
"Username": "Steve.Test",
"LastChangedByEmployeeID": 199718,
"FingerprintEnrolled": false,
"RowThumbprint": "9e0fa94d-99f7-4cd9-80f7-8940a200d5ea",
"RowInserted": "2019-06-17T14:39:52.967Z",
"RowUpdated": "2019-10-01T19:44:50.637Z",
"RowEvent": "Added"
}
]

Employees / Groups

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"GroupID": 1,
"GroupName": "Sales Representative",
"EmployeeID": 58001,
"RowThumbprint": "9114420c-1009-4925-a8a2-b200a4f3552a",
"RowInserted": "2019-08-30T02:50:43.960Z",
"RowUpdated": "",
"RowEvent": "Inserted"
}
]

Employees / PunchClock

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"PunchID": 1,
"EmployeeID": 58001,
"LocationID": 33484,
"TimeIn": "2019-01-18T10:47:32.367Z",
"TimeOut": "2019-01-18T10:47:42.167Z",
"Status": 0,
"ManagerVerified": false,
"EmployeeVerified": false,
"PunchInComments": "test",
"PunchOutComments": "test",
"IsPartTime": false,
"RowThumbprint": "263d9721-7cbf-40c7-84e3-77c4e64f46e8",
"RowInserted": "2019-01-18T10:47:32.367Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Employees / PunchClock / Revisions

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"RevisionID": 1,
"PunchID": 30,
"RevisedTimeIn": "2019-02-01T12:22:00.000Z",
"RevisedTimeOut": "2019-02-01T19:00:00.000Z",
"RevisedOnDate": "2019-02-02T15:36:19.467Z",
"RevisedByEmployeeID": 46749,
"RevisionType": "Edit",
"Comments": "Spotlight on Business",
"PreviousTimeIn": "2019-02-01T12:22:47.470Z",
"PreviousTimeOut": "2019-02-02T08:38:09.290Z",
"RowInserted": "2019-02-02T15:36:19.467Z",
"RowUpdated": "",
"RowThumbprint": "0df303c0-0761-4c93-8cc3-d92c066bae05",
"RowEvent": "Added"
}
]

Employees / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"LocationID": 33484,
"EmployeeID": 58001,
"RowThumbprint": "4416bf14-9d34-42a3-8dc7-76570f29ab2c",
"RowInserted": "2019-06-17T14:39:52.967Z",
"RowUpdated": "2019-07-14T21:11:59.367Z",
"RowEvent": "Added"
}
]

Employees / Organization

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"EmployeeID": 58001,
"OrganizationRoleName": "Operations Manager",
"Description": "",
"Color": 193193193,
"SalaryRange": "",
"ForcePunchIn": false,
"InactivityTimeoutLength": 9,
"RowThumbprint": "5c5a6d35-0106-42d2-b368-f16c080a65dd",
"RowInserted": "2019-07-10T21:08:19.540Z",
"RowUpdated": "2019-07-10T21:08:19.540Z",
"RowEvent": "Added"
}
]

Employees / WorkHistory

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"EmployeesAndWorkHistoryID": 1092,
"EmployeeID": 58001,
"ChangedByEmployeeID": 24,
"Type": "Security role changes",
"Value": 3,
"Rate": 39,
"frequency": 31,
"EffectiveDate": "",
"CreatedDate": "",
"RowThumbprint": "efc52331-532b-4719-81bb-91c28589c945",
"RowInserted": "2019-06-17T00:00:00.000Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance

Finance / CashIn

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"CashInID": 1,
"CashInIDByAbbr": "84WEACIND1",
"Amount": 1,
"LocationID": 33484,
"TerminalID": 0,
"TimeOfCashIn": "2019-01-25T15:26:03.663Z",
"PrimaryEmployeeID": 58001,
"SecondaryEmployeeID": 58001,
"Comments": "",
"PaymentTypeID": 1,
"RowThumbprint": "008fd572-c9f8-4f48-835b-2b4fc746d7b5",
"RowInserted": "2019-01-25T15:26:03.663Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / CashOuts

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CashOutID": 1,
"CashOutIDByStore": "TOTLICA5",
"DepositAmount": 60,
"FloatRetained": 100,
"LocationID": 33484,
"LastUpdatedEmployeeID": 199718,
"Reconciled": true,
"DepositNumber": "ertyu",
"TerminalID": 0,
"StartDate": "2019-01-25T15:26:03.663Z",
"StopDate": "2015-04-10T08:13:31.09",
"PrimaryEmployeeID": 58001,
"SecondaryEmployeeID": 58001,
"Comments": "",
"CashDetailsID": 23992,
"RowThumbprint": "008fd572-c9f8-4f48-835b-2b4fc746d7b5",
"RowInserted": "2019-01-25T15:26:03.663Z",
"RowUpdated": "",
"RowEvent": "Added",
"ReconciliationComments": ""
}
]

Finance / CashOuts / Terminals

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"TerminalID": 0,
"CashOutID": 177,
"CashIn": 167,
"TillTransactions": 2067,
"RowThumbprint": "82606b66-13e4-463c-a6a3-d215dc9945e5",
"RowInserted": "2019-02-14T21:32:05.940Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / CashOuts / Totals

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CashOutID": 1,
"PaymentTypeID": 1,
"ActualTotal": 1,
"SystemTotal": 1,
"Reconciled": false,
"Skim": 0,
"Float": 1,
"TransactionQuantity": 21,
"RowThumbprint": "c56f5b0d-98dd-47e7-9a9d-56d480dea6f3",
"RowInserted": "2019-01-25T15:30:42.000Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / CashSkim

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CashSkimID": 1,
"CashSkimIDByAbbr": "CRAWFSKIMD1",
"LocationID": 33484,
"PrimaryEmployeeID": 112638,
"SecondaryEmployeeID": 112638,
"Amount": 125.37,
"TerminalID": 0,
"TimeOfCashSkim": "2019-02-13T13:26:38.600Z",
"Comments": "",
"PaymentTypeID": 1,
"RowThumbprint": "a63014ef-31e4-4483-ad48-65d09137ed82",
"RowInserted": "2019-02-13T13:26:38.600Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / CloseOuts

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CloseID": 9337,
"CloseIDByStore": "TOTLICA9337",
"LocationID": 33484,
"PrimaryEmployeeID": 58001,
"SecondaryEmployeeID": 46733,
"StopDate": "2019-01-25T15:30:42.000Z",
"TerminalID": 0,
"RowThumbprint": "401a1466-82de-431d-b818-02fcf88d2a9c",
"RowInserted": "2019-01-25T15:30:42.000Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / CloseOuts / Terminals

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"TerminalID": 0,
"CloseID": 1,
"RowThumbprint": "c51041c7-5a6a-424a-8096-87404702050c",
"RowInserted": "2019-02-15T18:13:20.000Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / CloseOuts / Totals

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CloseID": 9297,
"PaymentTypeID": 202,
"ActualTotal": 0,
"SystemTotal": -3113.31,
"RowThumbprint": "f4949248-2aee-47ed-97a6-a201d77aae61",
"RowInserted": "2019-08-03T17:17:48.830Z",
"RowUpdated": "2019-08-03T17:17:48.830Z",
"RowEvent": "Added"
}
]

Finance / Drawer

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"AuditID": 4,
"AuditIDByAbbr": "TALLAT0A4",
"AmountEntered": 299.8,
"AmountExpected": 407.8,
"LocationID": 33484,
"TerminalID": 0,
"TimeOfAudit": "2019-02-15T12:03:36.660Z",
"PrimaryEmployeeID": 46737,
"SecondaryEmployeeID": 3,
"RowThumbprint": "097fa8ee-ab53-407d-a6fd-497612c5a1d7",
"RowInserted": "2019-02-15T12:03:36.660Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / GeneralLedger

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"TransactionID": 2,
"GLAccountID": 4,
"LocationID": 33484,
"Debit": 0,
"Credit": 1.4,
"SourceType": "Invoice",
"SourceID": 1,
"SourceIDByStore": "TARGEIN1",
"Comments": "",
"Exported": false,
"TerminalID": 0,
"InvoiceEditedDate": "",
"ExtraData": "",
"TaxID": 3,
"TaxTableType": "",
"RowThumbprint": "2d79e2ee-6b87-4dbb-a70a-73846b077f76",
"RowInserted": "2019-07-03T11:07:19.590Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / GeneralLedger / Accounts

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"GLAccountID": 1,
"GLAccountNumber": 1200,
"GLAccountName": "Inventory On Hand",
"CategoryNumber": 1010,
"EmployeeID": 58001,
"Enabled": true,
"RelatedAccount": "",
"Comments": "",
"Consolidate": 0,
"GreatPlainsExportStyle": "Detail",
"QuickBooksTaxVendorID": 3,
"RowThumbprint": "e124b7a3-6b01-490c-826d-d98be532ca2a",
"RowInserted": "2019-03-30T10:28:15.530Z",
"RowUpdated": "2019-09-09T21:58:00.547Z",
"RowEvent": "Added"
}
]

Finance / PaymentTypes

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"PaymentTypeID": 2,
"PaymentName": "Visa",
"Enabled": true,
"EmployeeID": 58001,
"GetSignatureOnInvoice": true,
"GLAccountName": "Bank Account",
"RequireGatewayAuthorization": true,
"ForceReferenceNumber": true,
"Hidden": false,
"SortOrder": 9,
"RequirePinVerification": false,
"AllowPositiveTransactions": true,
"AllowNegativeTransactions": true,
"MaxNegativeValue": 36,
"RequireCheckVerification": false,
"CreditCardPaymentType": "",
"ReferenceNumberLength": 33,
"MinReferenceNumberLength": 27,
"IsUnifiedGatewayPayment": false,
"BehavesLikeCash": false,
"PennyRoundingEnabled": false,
"GLAccountIDForPennyRounding": 15,
"AllowFullAmountSameDayRefund": false,
"IntegrationProviderID": "",
"IsDefaultPaymentType": true,
"GetSignatureOnRefund": false,
"LastCangedByEmployeeID": 1795340,
"RequireCustomAgreement": false,
"CustomAgreement": "",
"RequireGiftCardAuthorization": false,
"RequireOverrideToBypassSignatureCapture": false,
"RowThumbprint": "aa12167e-f1af-4195-8cb5-316689a84a6f",
"RowInserted": "2019-03-30T10:28:16.610Z",
"RowUpdated": "2019-07-27T16:33:21.113Z",
"RowEvent": "Added"
}
]

Finance / Payouts

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"PayOutID": 1,
"PayOutIDByStore": "TTL10PY1",
"OriginalPayOutID": 24,
"LocationID": 33484,
"Amount": -500,
"PaymentTypeID": 1,
"EmployeeID": 58001,
"Reconciled": false,
"DateReconciled": "",
"ReconcilerEmployeeID": 13,
"Comments": "",
"GLAccountID1": 9,
"TerminalID": 0,
"RowThumbprint": "4db03a53-4265-4a75-81d7-db0769c8fa67",
"RowInserted": "2019-10-28T13:57:55.537Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / RecurringInvoices

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"RecurringInvoiceID": 1,
"RecurringInvoiceIDByStore": "REDSTRI1",
"LocationID": 33484,
"AccountsReceivableID": 13,
"PrimaryCustomerID": "c9928cef-ac66-4d3a-8f9f-d0562c279528",
"ShipToCustomerID": "",
"CustomerPONumber": "",
"PrimaryEmployeeID": 58039,
"SecondaryEmployeeID": 1,
"LoggedInEmployeeID": 44664,
"SplitRate1": 100,
"SplitRate2": 0,
"Comments": "",
"SendInvoiceBy": "Mail",
"RecurType": "Weekly",
"RecurFrequency": 1,
"WeeklyDays": 512,
"MonthlyFirstDay": 36,
"MonthlySecondDay": 4,
"YearlyMonth": 41,
"YearlyDay": 21,
"StartDate": "2019-09-24T00:00:00.000Z",
"StopDate": "",
"DateLastBilled": "2019-01-17T10:58:02.300Z",
"NumberOfTimesBilled": 2,
"Enabled": true,
"CommissionStopDate": "",
"PaymentTypeID": 5,
"RowThumbprint": "f85287f1-f0cb-4944-87d2-a0ee904d02d2",
"RowInserted": "2019-09-24T17:33:08.470Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / RecurringInvoices / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"RecurringInvoiceID": 123,
"GlobalProductID": 5002,
"Priority": 1,
"Quantity": 1,
"UnitPrice": 100,
"RowThumbprint": "fa4f99b9-79ec-4d50-9ff8-4f0ce897222e",
"RowInserted": "2019-09-21T15:34:09.350Z",
"RowUpdated": "2019-09-21T15:34:09.350Z",
"RowEvent": "Added"
}
]

Finance / Taxes

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
LanguageCode	string Default: "en-us" Example: LanguageCode=en-us Language code

Responses

Response samples

200

Content type

application/json

[{"TaxID": 4,
"TaxGuid": "23ba32a6-68b4-47f2-880a-3319e290ac36",
"TaxLibraryID": 25,
"TaxName": "Florida",
"EmployeeID": 58001,
"TaxRate": 6.5,
"ClientGLAccountID": 4,
"VendorGLAccountID": 5,
"TaxablePrice": "UnitPrice",
"FlatTax": 7,
"Enabled": true,
"AllowPartialExemption": false,
"PartialTaxRate": 0,
"ForceExemptionReasonCodeEntry": false,
"ForceExemptionNumberEntry": false,
"DateEffectiveUTC": "2019-06-17T19:39:50.460Z",
"DateExpireUTC": "",
"ShowCostOnPrintout": false,
"Pending": false,
"SystemDeleteFlag": false,
"UseCostThreshold": false,
"CostThreshold": 100,
"TaxableCost": 100,
"TaxType": "",
"TaxAuthority": "",
"RowThumbprint": "8cb0f256-40c7-4b5d-a054-68976c58c547",
"RowInserted": "2019-06-17T14:39:50.460Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / Taxes / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"LocationID": 33484,
"TaxID": 340,
"RowThumbprint": "6b3c488d-beae-47cb-a498-34117502501c",
"RowInserted": "2019-03-07T07:06:45.270Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / Vendors

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"VendorID": 1,
"VendorName": "A.C.P",
"EmployeeID": 58001,
"City": "Regina",
"Address": "45 Test St",
"Address2": "",
"Region": "",
"ZipPostal": "",
"Country": "USA",
"PrimaryPhone": 5555555555,
"SecondaryPhone": "",
"RepName": "Leslie",
"RepEmail1": "",
"RepEmail2": "",
"WebAddress": "",
"FaxNumber": "           ",
"OnlineOrderingWebAddress": "",
"OnlineOrderingCustomerID": "",
"Comments": "",
"GLAccountID1": 1001,
"Terms": "",
"AccountNumber": "",
"POAttachmentFormat": 0,
"DisableTrackingNumberImportTools": false,
"MinCostRequiredForPO": false,
"MaxCostRequiredForPO": true,
"MinCostForPO": 0,
"MaxCostForPO": 1000,
"Enabled": 1,
"GeneratePOsFromSalesOrders": true,
"GeneratePOsFromSalesOrdersForSerializedInventoryOnly": false,
"GeneratePOsAsCommittedFromSalesOrders": true,
"UpdateSerialNumbersOnSalesOrders": true,
"ForceReferenceNumberWhenGeneratingPOFromSalesOrder": true,
"PopulateVendorInvoiceNumberWithTheReferenceNumberWhenReceiving": true,
"RowThumbprint": "b1bf39a1-5ff1-46c6-9792-4efbc020d414",
"RowInserted": "2019-06-17T15:32:55.403Z",
"RowUpdated": "2019-04-26T14:18:20.683Z",
"RowEvent": "Added"
}
]

Finance / Vendors / Accounts

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"VendorAccountID": 1,
"VendorID": 18,
"EmployeeID": 58001,
"LocationID": 33484,
"AccountName": "Verizon",
"Comments": "",
"GLAccountID": 1004,
"RequireSOCCode": 0,
"ForcedSOCCodeLength": 0,
"ForceSOCCodeLength": 0,
"RequireExtraField": true,
"ForcedExtraFieldLength": 3,
"ForceExtraFieldLength": false,
"UseExtraFieldAllowedValuesList": false,
"UseAdvancedCarrierPriceSheet": true,
"UseAdvancedSPIFFTracking": false,
"EnableVendorSKU": false,
"CarrierName": "Bell",
"IsMasterAgentAccount": false,
"UseCustomGLForVenRebAccPayment": false,
"CustomGLAccountIDForVenRebAccPayment": 27,
"UseLowestPrice": false,
"UseForBuyOnlinePricesheet": false,
"RowThumbprint": "304e838b-dda7-43ea-b64b-0d0e642b510d",
"RowInserted": "2019-08-02T17:25:00.810Z",
"RowUpdated": "2019-08-02T17:25:00.810Z",
"RowEvent": "Added"
}
]

Finance / Vendors / Accounts / Transactions

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"TransactionID": 141,
"VendorAccountID": 28,
"TransactionNumber": 2,
"Description": "Test",
"TotalExpected": 50,
"Active": true,
"EmployeeID": 58001,
"TransactionType": "VendorRebateChargebackReconciliation",
"LocationID": 33484,
"RowThumbprint": "304e838b-dda7-43ea-b64b-0d0e642b510d",
"RowInserted": "2019-08-02T17:25:00.810Z",
"RowUpdated": "2019-08-02T17:25:00.810Z",
"RowEvent": "Added"
}
]

Finance / Vendors / Rebates / Adjustments

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"AdjustmentID": 1,
"AdjustmentIDByStore": "84WEAVA1",
"LocationID": 33484,
"EmployeeID": 58001,
"RowInserted": "2019-03-09T12:29:18.540Z",
"RowUpdated": "",
"RowThumbprint": "ca3bea8d-82eb-45df-996c-d3a55c569e21",
"RowEvent": "Added"
}
]

Finance / Vendors / Rebates / Adjustments / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"AdjustmentID": 1,
"SaleInvoiceID": 2954,
"GlobalProductID": 981,
"SerialNumber": 2053404696,
"LineItem": 4,
"UnitPrice": 220,
"DateAdjusted": "2019-02-28T00:00:00.000Z",
"Quantity": 1,
"RowThumbprint": "0415ffa7-7313-4c37-b4a9-15136aa63bb9",
"RowInserted": "2019-03-09T12:29:18.650Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / Vendors / Rebates / Reconcile

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"SaleInvoiceID": 31,
"GlobalProductID": 982,
"SerialNumber": 8502282983,
"LineItem": 4,
"Quantity": 1,
"UnitPrice": 200,
"Reconciled": true,
"Comments": "",
"Flagged": false,
"Active": false,
"EmployeeID": 58001,
"DateReconciled": "2019-03-09T12:22:30.783Z",
"TransactionID": 2,
"ChargeBackEmployeeID": 8,
"ChargeBackReconciledDate": "",
"ChargeBackTransactionID": 43,
"FullChargeBackEmployeeID": 1,
"FullChargeBackReconciledDate": "",
"FullChargeBackTransactionID": 39,
"Comments2": "",
"Collected": 0,
"PartialChargebackReversalID": 8,
"RowThumbprint": "9c09cb9d-b215-4a60-ae10-784dcdbab2d8",
"RowInserted": "2019-03-09T12:22:30.783Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Finance / Vendors / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"VendorID": 1,
"LocationID": 33484,
"VendorNumber": 745,
"RowThumbprint": "5e56351a-459d-4274-a7fc-f520444c1b65",
"RowInserted": "2019-06-17T15:32:55.403Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory

Inventory / Adjustments

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"InventoryAdjustmentID": 1,
"InventoryAdjustmentIDByStore": "84WEAIA1",
"LocationID": 33484,
"EmployeeID": 58001,
"Comments": "",
"AdjustmentType": "Quantity",
"RelatedIDByStore": "",
"RowThumbprint": "3abd35a1-6f42-4eef-9216-39055a02c889",
"RowInserted": "2019-01-20T17:27:31.930Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Adjustments / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"InventoryAdjustmentID": 23371,
"LocationID": 33484,
"GlobalProductID": 10458,
"SerialNumber": 990003427600011,
"Quantity": -1,
"UnitCost": 0,
"Comments": "",
"AdjustmentReasonCodeID": 2,
"NonSellable": false,
"StatusID": 0,
"CountSheetID": 0,
"RowThumbprint": "491d7207-50a0-43a7-92ad-096b59190c2b",
"RowInserted": "2019-03-21T19:13:59.103Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Adjustments / ReasonCodes

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"AdjustmentReasonCodeID": 2,
"Enabled": true,
"Priority": 2,
"GLAccountID": 10,
"GLAccountName": "",
"Description": "Point Of Sale Error",
"RowThumbprint": "de97bcf8-29e7-48c9-b505-7aa2a2b677e9",
"RowInserted": "2019-11-06T21:04:47.020Z",
"RowUpdated": "2019-03-09T20:50:30.860Z",
"RowEvent": "Added"
}
]

Inventory / Categories

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
LanguageCode	string Default: "en-us" Example: LanguageCode=en-us Language code

Responses

Response samples

200

Content type

application/json

[{"CategoryNumber": 10,
"EmployeeID": 58001,
"Abbreviation": "IQ",
"DefaultMargin": 0,
"Enabled": true,
"CategoryName": "Inventory Tree",
"CategoryPath": "",
"CentrallyManagedID": "",
"DefaultPricingType": 1,
"DefaultNoSale": false,
"DefaultDiscountable": false,
"DefaultShowOnInvoice": true,
"DefaultRefundable": true,
"DefaultRefundPeriodLength": 10,
"DefaultRefundToUsed": false,
"DefaultTaxApplicationType": 0,
"DefaultGLAccountID1": 1,
"DefaultGLAccountID2": 48,
"DefaultGLAccountID3": 23,
"DefaultGLAccountID4": 49,
"DefaultAllowPriceIncrease": true,
"DefaultCompanyLevelRestricted": false,
"RowThumbprint": "0d6d5996-2e0f-4ac4-b194-c2512e2871a5",
"RowInserted": "2019-03-30T10:28:16.797Z",
"RowUpdated": "2019-07-25T19:02:10.527Z",
"RowEvent": "Added"
}
]

Inventory / CountSheets

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CountSheetID": 1,
"CountSheetIDByStore": "84WEACS1",
"DateStarted": "2019-01-20T17:25:00.000Z",
"DateCommitted": "",
"DateCompleted": "",
"PrimaryEmployeeID": 58001,
"SecondaryEmployeeID": 58001,
"LocationID": 33484,
"OriginalCountSheetID": 13,
"Comments": "",
"SearchLoanType": 0,
"RowThumbprint": "e65eb0cf-9cb2-4eeb-8179-ab1b9a9fb098",
"RowInserted": "2019-01-20T17:25:34.603Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / CountSheets / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CountSheetID": 1,
"GlobalProductID": 1,
"Status": 1,
"SerialNumber": "",
"NonSellable": false,
"RowInserted": "2019-01-20T17:25:34.603Z",
"RowUpdated": "",
"RowThumbprint": "43690570-b768-4dd2-af05-fbba70ff4114",
"RowEvent": "Added"
}
]

Inventory / CountSheets / Products / Categories

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CountSheetID": 1,
"CategoryNumber": 10101123,
"RowThumbprint": "46bc4131-aff1-40e1-aa2b-e19e3dc04d62",
"RowInserted": "2019-01-20T17:25:34.603Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / CountSheets / Products / Orphaned

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CountSheetProductID": 1,
"CountSheetID": 11,
"SearchString": "A0000008930173",
"Comments": "",
"ProductSKU": "",
"RowThumbprint": "ec6510b8-680a-4c3f-9735-a6f81c4615ba",
"RowInserted": "2019-02-21T18:52:03.440Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / BatchImports

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"BatchImportID": "eab42b38-8b5a-4d2a-8c9f-3ebe324bd622",
"ParentType": 1,
"ParentID": 546,
"ParentIDByStore": "TALLACS31",
"DeviceParentName": "",
"LocationID": 33484,
"RowThumbprint": "ebc23308-440a-4a27-8c07-8a160d0fe7a4",
"RowInserted": "2019-12-15T09:01:37.567Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / BatchImports / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"BatchImportItemID": "ee5e27a7-3709-4ce2-8275-f7888f8b0c5b",
"BatchImportID": "eab42b38-8b5a-4d2a-8c9f-3ebe324bd622",
"Sequence": 1,
"GlobalProductID": 1777,
"Found": true,
"DeviceProductKey": "ACVZCB000244",
"DeviceSerialNumber": 1234567890002,
"RowThumbprint": "5bd778a7-c776-4876-a580-60b991f86fb2",
"RowInserted": "2019-12-15T09:01:37.567Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Import

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
LanguageCode	string Default: "en-us" Example: LanguageCode=en-us Language code

Responses

Response samples

200

Content type

application/json

[{"InventoryImportID": 3,
"InventoryImportIDByStore": "84WEAII0",
"LocationID": 33484,
"EmployeeID": 58001,
"Comments": "Sale Invoice Migration",
"DateCreated": "2019-02-01T00:16:37.020Z",
"RowThumbprint": "4c4ed04a-6164-416d-add4-962a17881f29",
"RowInserted": "2019-02-01T00:16:37.020Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Import / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
LanguageCode	string Default: "en-us" Example: LanguageCode=en-us Language code

Responses

Response samples

200

Content type

application/json

[{"InventoryImportID": 16,
"LocationID": 1,
"GlobalProductID": 11168,
"SerialNumber": 866988333292854,
"Quantity": 1,
"UnitCost": 660,
"RowThumbprint": "c5c525d8-e33f-414d-8d24-f78f3726deea",
"RowInserted": "2019-02-01T00:16:37.020Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Coupons

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
LanguageCode	string Default: "en-us" Example: LanguageCode=en-us Language code

Responses

Response samples

200

Content type

application/json

[{"CouponID": 1019,
"CouponName": "Take Rate Percent of Prod",
"CouponLabel": "Take Rate Percent of Prod",
"ProductSKU": "COUPON001019",
"DiscountAmount": 10,
"Availability": 0,
"StartDate": "2019-10-24T14:29:24.843Z",
"EndDate": "2019-10-24T14:29:24.847Z",
"DiscountMethod": "ProductPercentage",
"GLAccountID": 6,
"Enabled": true,
"MinimumValueRequired": false,
"MinimumValue": 43,
"OnlyCoupon": false,
"AllowMultiple": true,
"IncludeAllLocations": false,
"Group1Count": 1,
"Group2Count": 0,
"Group3Count": 0,
"Serialized": false,
"LimitMultiple": false,
"LoyaltyOnly": false,
"IntegrationProviderID": "",
"TaxAppliedMethod": "BeforeTax",
"AutoApplyToEligibleProducts": false,
"RowThumbprint": "4f75eec9-46ce-42bb-93f9-4ce8350c1da6",
"RowInserted": "2019-10-24T14:29:24.843Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Coupons / Serialized

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
LanguageCode	string Default: "en-us" Example: LanguageCode=en-us Language code

Responses

Response samples

200

Content type

application/json

[{"SerializedCouponsID": 1,
"CouponID": 8,
"SerialNumber": 1111111111,
"Valid": true,
"ExpiryDate": "",
"CustomerID": "",
"IssuedDate": "2019-10-16T11:27:25.093Z",
"RowThumbprint": "35c04e44-7d59-44f5-bab8-08b0eeb9c8eb",
"RowInserted": "2019-10-16T11:27:25.093Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Coupons / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"CouponID": 2246,
"LocationID": 33484,
"LocationType": 4,
"RowThumbprint": "148aaf8f-e8bd-4b48-a6b9-f7fb3a4e9373",
"RowInserted": "2019-06-26T15:46:10.543Z",
"RowUpdated": "2019-06-26T15:46:10.543Z",
"RowEvent": "Added"
}
]

Inventory / GiftCards

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 12542,
"ManufacturerID": 25,
"ManufacturerPartNumber": "",
"Serialized": false,
"DaysUntilStockBalance": 0,
"RMANumberRequired": false,
"ApplyMaintenanceFee": false,
"MonthsUntilMaintenance": 0,
"Rate": 0,
"AutoDepreciate": true,
"WarehouseLocation": "",
"RevenueGLAccountID": 4,
"MaintenanceTypeID": -1,
"AmountType": 1,
"IsGiftCard": true,
"IsNonStocked": false,
"DefaultCost": 23,
"DefaultSpecialOrder": "",
"DefaultDoNotOrder": "",
"DefaultDateEOL": "",
"DefaultDiscontinuedDate": "",
"DefaultWriteOff": "",
"PAWFloorPrice": 40,
"AverageCOS": 0,
"IntegratedPaymentTypeID": 6,
"InvoiceSerialMask": "DoNotPrint",
"RowThumbprint": "759b1520-7f2b-4019-b447-11e9e69713ad",
"RowInserted": "2019-04-05T17:28:57.840Z",
"RowUpdated": "2019-04-05T17:28:58.053Z",
"RowEvent": "Added"
}
]

Inventory / GiftCards / Active

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 1608,
"SerialNumber": 123456789,
"Amount": 0,
"SaleInvoiceID": 120164,
"IntegratedGiftCard": false,
"RowThumbprint": "68245e3a-1278-4042-ad3d-e17967cdee47",
"RowInserted": "2019-10-16T13:06:48.387Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / GiftCards / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 1609,
"LocationID": 33484,
"Quantity": 0,
"RetailPrice": 0,
"Margin": 0,
"SaleBeginDate": "",
"SaleEndDate": "",
"SalePrice": 0,
"MinQty": 0,
"MaxQty": 0,
"FloorPrice": 1,
"MaxPrice": 100,
"SerializedCOS": 34,
"LockMinMax": false,
"NoSale": false,
"StoreInStorePrice": 37,
"CarrierPrice": 13,
"Cost": 2,
"Discountable": false,
"ShowOnInvoice": true,
"Refundable": false,
"RefundPeriodLength": 4,
"StoreProductWAC": 0,
"StoreProductMRCost": 0,
"StoreProductMRDate": "2019-07-22T14:01:22.030Z",
"PAWFloorPrice": 46,
"InvoiceCommentsVersion": 2,
"TaxApplicationType": 0,
"AllowPriceIncrease": true,
"RowThumbprint": "40e34f66-e68f-493d-9c89-2f4cf1f427d6",
"RowInserted": "2019-07-22T14:01:22.030Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Loans

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"LoanInvoiceID": 1,
"LoanInvoiceIDByStore": "KLSSSLI1",
"LocationID": 33484,
"EmployeeID": 58001,
"Comments": "",
"BorrowerCustomerID": "3cef28ee-3c1e-4abb-9654-ad5be030bac7",
"BorrowerEmployeeID": 11,
"LoanType": 1,
"LoanCommitted": true,
"DateCommitted": "2019-09-24T13:48:13.700Z",
"LoanCompleted": false,
"RowThumbprint": "ab583cd7-7590-4eed-9739-1e9d8adfb1a2",
"RowInserted": "2019-09-24T13:48:13.700Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Loans / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"LoanInvoiceID": 1,
"GlobalProductID": 1420,
"SerialNumber": 56328569256812,
"Quantity": 1,
"UnitCost": 100,
"ReturnedToLocationID": 3,
"ReturnedToEmployeeID": 25,
"DateDue": "2019-09-24T00:00:00.000Z",
"DateReturned": "",
"AdjustedUnitCost": 7,
"IsUsed": false,
"RowThumbprint": "3c005647-34bb-4865-8877-a8c267c4fb30",
"RowInserted": "2019-09-24T13:48:13.700Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Manufacturers

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"ManufacturerID": 1,
"ManufacturerName": "KentelManufacturer",
"EmployeeID": 58001,
"Abbreviation": "AU",
"City": "",
"Region": "",
"Address": "",
"Address2": "",
"ZipPostal": "",
"PrimaryPhone": "",
"SecondaryPhone": "",
"ContactName1": "",
"ContactName2": "",
"Email1": "",
"Email2": "",
"WebAddress": "",
"FaxNumber": "",
"Comments": "",
"Country": "",
"RowThumbprint": "ee8e55a2-7be1-4a44-a057-1eeca85ba04c",
"RowInserted": "2019-06-17T15:32:54.387Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / NonSellableAdjustments

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"NonSellableAdjustmentID": "ef01fb3c-b9a7-4b69-9024-a3a6b23c65d8",
"NonSellableAdjustmentIDByStore": "REDSTNA1",
"LocationID": 33484,
"EmployeeID": 58001,
"AdjustmentType": "Quantity",
"RowThumbprint": "767df220-e769-4b68-bbe5-af72767869b0",
"RowInserted": "2019-04-14T16:01:19.557Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / NonSellableAdjustments / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"NonSellableAdjustmentID": "ef01fb3c-b9a7-4b69-9024-a3a6b23c65d8",
"LocationID": 33484,
"GlobalProductID": 1342,
"SerialNumber": "A100000ABF0C6E",
"Quantity": 1,
"UnitCost": 283,
"UnitCostInStock": 283,
"UsedAdjustmentType": 0,
"NonSellableReasonCode": "",
"NonSellableComments": "",
"RowThumbprint": "e9fa6895-e17f-4fb6-99be-f0e1447d2778",
"RowInserted": "2019-04-14T16:01:19.557Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / PriceSheets

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"PriceSheetID": 1,
"VendorAccountID": 1,
"Availability": "Unavailable",
"StartDate": "2019-01-01T00:00:00.000Z",
"StopDate": "2019-08-21T00:00:00.000Z",
"RowInserted": "2019-06-30T07:45:09.820Z",
"RowUpdated": "",
"RowThumbprint": "062749cb-99a7-43f0-add3-4ea6d3018d5a",
"RowEvent": "Added"
}
]

Inventory / PriceSheets / Promotions

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"PromotionID": 1,
"PriceSheetID": 1,
"PromotionName": "Verizon VAB",
"VendorAccountID": 1,
"GlobalProductID": 823,
"UnitPrice": 0,
"DiscountAmount": 50,
"Availability": 1,
"StartDate": "2019-06-20T00:00:00.000Z",
"StopDate": "2019-06-20T00:00:00.000Z",
"EmployeeID": 58001,
"IncludeAllLocations": false,
"Quantity": 1,
"AddOnQuantity": 0,
"RowThumbprint": "bf91f54e-4a0e-4eda-8dd1-5a6918f93408",
"RowInserted": "2019-06-30T07:45:09.710Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / PriceSheets / Promotions / Terms

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"PromotionID": 267,
"TermID": 305,
"RowThumbprint": "7cf994fe-bd47-4ecd-a1d0-8d343f625deb",
"RowInserted": "2019-10-25T16:44:28.470Z",
"RowUpdated": "2019-10-25T16:44:28.470Z",
"RowEvent": "Added"
}
]

Inventory / PriceSheets / Promotions / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"PromotionID": 268,
"LocationID": 33484,
"LocationType": 4,
"RowThumbprint": "f5421fd3-52a6-414f-a427-76a07aacb178",
"RowInserted": "2019-09-03T01:41:19.637Z",
"RowUpdated": "2019-09-03T01:41:19.637Z",
"RowEvent": "Added"
}
]

Inventory / PriceSheets / Terms

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"PriceSheetTermID": 10,
"PriceSheetTermName": "2 Year",
"VendorAccountID": 2,
"EmployeeID": 58001,
"TermLength": 2,
"RowThumbprint": "86ca3f7e-1c38-4142-a901-fb91a5060a57",
"RowInserted": "2019-06-30T07:48:25.290Z",
"RowUpdated": "2019-08-08T18:57:11.020Z",
"RowEvent": "Added"
}
]

Inventory / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 1,
"ProductIdentifier": "ASCLMO000001",
"ProductName": "Clear Case Protector",
"ProductLabel": "1Build",
"CategoryNumber": 1010112310,
"ProductType": "Regular Global Product",
"EmployeeID": 58001,
"Enabled": true,
"Discountable": true,
"PricingType": "RetailPrice",
"DefaultMargin": 0,
"DefaultRetailPrice": 89.99,
"EcommerceItem": false,
"GLAccountID1": 1001,
"GLAccountID2": 2007,
"GLAccountID3": 2,
"GLAccountID4": 2021,
"CommissionDetailsLocked": false,
"ShowOnInvoice": true,
"Refundable": true,
"TriggerServiceRequestOnSale": false,
"SerivceType": "",
"FloorPrice": 0.05,
"MaxPrice": 8,
"SerialNumberLength": 41,
"NoSale": true,
"CreateServiceManagerOnSale": false,
"ServiceManagerServiceType": 20,
"ServiceManagerServiceExpireAfter": 8,
"MasterProductID": "",
"StoreInStoreProductIdentifier": "",
"StoreInStorePrice": 5,
"WarrantyDescription": "",
"CentrallyManagedID": "",
"RefundPeriodLength": 100,
"SerialNumberPrompt": "",
"CarrierPrice": 7,
"MultiLevelPriceDetailsLocked": false,
"LastChangedByEmployeeID": 24,
"DefaultSalePrice": 0,
"DefaultMinQty": 0,
"DefaultMaxQty": 0,
"LockMinMax": false,
"DefaultVendorID": 5,
"NoAutoTaxes": false,
"InvoiceCommentsVersion": 34,
"TaxApplicationType": 0,
"AllowPriceIncrease": false,
"ServiceAndRepairTemplateId": "",
"TriggerServiceAndRepairOnSale": false,
"CompanyLevelRestricted": false,
"ProductLibraryID": "M1322-V2",
"ProductLibraryName": "Motorola Moto X 16GB - Black",
"RetailerCatalogID": "f7d50349-8de1-4f3b-bd29-d93dcd5b9583",
"RowThumbprint": "dca96e2d-ed47-4767-8f2d-a27698031b83",
"RowInserted": "2019-06-17T15:32:57.497Z",
"RowUpdated": "2019-10-09T16:53:09.223Z",
"RowEvent": "Added"
}
]

Inventory / Products / BarCodes

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"BarCode": 111111,
"GlobalProductID": 14703,
"RowThumbprint": "0d502019-cc7d-484b-9f7c-c817454cf748",
"RowInserted": "2019-07-25T21:21:15.643Z",
"RowUpdated": "2019-07-25T21:21:15.643Z",
"RowEvent": "Added"
}
]

Inventory / Products / Deleted

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 814,
"ProductType": "VendorRebate",
"ProductIdentifier": "ACVZRB000003",
"DateDeleted": "2019-07-01T14:01:07.357Z",
"EmployeeID": 58001,
"ProductName": "1 YR Act",
"RowThumbprint": "104a67c3-de25-4da6-b5f6-8e768620e70a",
"RowInserted": "2019-07-01T14:01:07.357Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Products / NonSellable / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 1245,
"LocationID": 33484,
"SerialNumber": "",
"Serialized": false,
"Quantity": 1,
"UnitCost": 11.097,
"IsUsed": false,
"NonSellableReason": "",
"NonSellableComments": "",
"TransactionType": "NonSet",
"EmployeeID": 58001,
"RowThumbprint": "7867bb46-44e8-4c4d-a96c-c02816d67172",
"RowInserted": "2019-03-12T13:10:55.233Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Products / NonStocked

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 8816,
"VendorID": 25,
"VendorPartNumber": "",
"DefaultCost": 0,
"Serialized": false,
"MultiLevelPriceDetailsLocked": false,
"SerialNumberLength": 26,
"CarrierPrice": 0,
"PAWFloorPrice": 19,
"RowThumbprint": "b6e1e2ea-5fc0-4eaa-980f-1d8c7ce5ac04",
"RowInserted": "2019-11-06T21:15:19.217Z",
"RowUpdated": "2019-07-04T20:12:23.910Z",
"RowEvent": "Added"
}
]

Inventory / Products / NonStocked / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 8816,
"LocationID": 33484,
"Cost": 0,
"RetailPrice": 0,
"Margin": 0,
"SaleBeginDate": "",
"SaleEndDate": "",
"SalePrice": 0,
"FloorPrice": 0,
"CarrierPrice": 0,
"NoSale": false,
"StoreInStorePrice": 13,
"Discountable": false,
"ShowOnInvoice": true,
"Refundable": true,
"RefundPeriodLength": 44,
"PAWFloorPrice": 22,
"TaxApplicationType": 0,
"AllowPriceIncrease": true,
"RowThumbprint": "2d5c0e28-024f-4630-b12e-118cd4ebd0bc",
"RowInserted": "2019-10-10T05:22:42.743Z",
"RowUpdated": "2019-07-04T20:12:24.253Z",
"RowEvent": "Added"
}
]

Inventory / Products / Physical

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 1,
"ManufacturerID": 9,
"ManufacturerPartNumber": "262/265/815/710",
"Serialized": false,
"DaysUntilStockBalance": 6666,
"WarrantyWebLink": "testing",
"WarrantyDescription": "",
"RMANumberRequired": false,
"WarrantyLengthTerm": "Days",
"WarrantyLength": 365,
"WarehouseLocation": "",
"MultiLevelPriceDetailsLocked": false,
"PAWFloorPrice": 44,
"SerialNumberLength": 43,
"TradeInProductID": 42,
"BackOrderDate": "",
"BackOrderDateChangedDate": "",
"BackOrderDateEmployeeID": 45,
"RefundToUsed": false,
"DefaultCost": 0,
"DefaultSpecialOrder": false,
"DefaultDoNotOrder": true,
"DefaultDateEOL": "",
"DefaultDiscontinuedDate": "2019-02-13T00:00:00.000Z",
"DefaultWriteOff": false,
"NoPositiveQuantityAdjustment": false,
"NoNegativeQuantityAdjustment": false,
"AverageCOS": 10.8397,
"RowThumbprint": "5f7cb916-a980-440e-881e-fd976355e858",
"RowInserted": "2019-06-17T15:32:57.497Z",
"RowUpdated": "2019-10-09T16:53:09.253Z",
"SetCostToRefundPrice": false,
"AutoGenerateSerialNumbers": false,
"RowEvent": "Added"
}
]

Inventory / Products / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 48,
"LocationID": 33484,
"Quantity": 0,
"RetailPrice": 99.99,
"Margin": 0,
"SaleBeginDate": "",
"SaleEndDate": "",
"SalePrice": 0,
"MinQty": 0,
"MaxQty": 0,
"FloorPrice": 0,
"MaxPrice": 12,
"PAWFloorPrice": 10,
"LockMinMax": false,
"NoSale": false,
"StoreInStorePrice": 28,
"Discountable": true,
"ShowOnInvoice": true,
"Refundable": true,
"RefundPeriodLength": 14,
"RefundToUsed": false,
"StoreProductWAC": 66,
"StoreProductMRCost": 66,
"StoreProductMRDate": "2019-02-01T00:16:37.020Z",
"InvoiceCommentsVersion": 1,
"TaxApplicationType": 0,
"SetCostToRefundPrice": "",
"AllowPriceIncrease": true,
"RowThumbprint": "df591f52-e6b9-4044-be96-334e128bd924",
"RowInserted": "2019-02-01T00:16:37.020Z",
"RowUpdated": "2019-07-18T06:45:26.697Z",
"RowEvent": "Added"
}
]

Inventory / Products / Serialized / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 1284,
"LocationID": 33484,
"SerialNumber": "A000003040E5B5",
"SerializedCOS": 20,
"IsUsed": false,
"RowThumbprint": "41661a7a-3158-4733-9ff9-f4a6a5b8d743",
"RowInserted": "2019-02-01T00:16:44.960Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Products / VendorRebates

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 9298,
"VendorID": 1,
"VendorAccountID": 10,
"VendorPartNumber": "",
"Serialized": true,
"DefaultCost": 0,
"ResidualTrackingRequired": false,
"SerialNumberLength": 46,
"CarrierPrice": 0,
"CarrierDimension": "",
"ProductDimension": "",
"PAWFloorPrice": 1,
"RowThumbprint": "cef5b641-ce81-4794-bc0a-32a72ddd96e0",
"RowInserted": "2019-06-17T15:32:55.403Z",
"RowUpdated": "2019-10-11T16:05:19.350Z",
"RowEvent": "Added"
}
]

Inventory / Products / VendorRebates / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 823,
"LocationID": 33484,
"Cost": 0,
"RebateAmount": 0,
"SaleBeginDate": "",
"SaleEndDate": "",
"SalePrice": 0,
"Margin": 0,
"CarrierPrice": 0,
"NoSale": true,
"StoreInStorePrice": 34,
"Discountable": false,
"ShowOnInvoice": true,
"Refundable": true,
"RefundPeriodLength": 24,
"PAWFloorPrice": 2,
"InvoiceCommentsVersion": 13,
"TaxApplicationType": 0,
"AllowPriceIncrease": false,
"RowThumbprint": "226874cd-2bc3-48cf-a8bc-e47c78dbd02b",
"RowInserted": "2019-07-18T18:12:01.100Z",
"RowUpdated": "2019-07-18T18:12:01.100Z",
"RowEvent": "Added"
}
]

Inventory / Products / Vendors

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 2,
"VendorID": 1,
"VendorPartNumber": 4326123,
"Priority": 4,
"Cost": 100,
"Comments": "",
"DoNotOrder": false,
"SpecialOrder": false,
"WriteOff": false,
"DateEOL": "",
"DiscontinuedDate": "2019-04-29T00:00:00.000Z",
"DiscontinuedEmployeeID": 42367,
"RowThumbprint": "81bfc3ea-e30f-4525-96ac-2d9550d17b8c",
"RowInserted": "2019-06-17T15:32:55.403Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Products / Vendors / Serialized

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GlobalProductID": 9514,
"SerialNumber": 81465456461456450,
"ReceivingID": 30,
"VendorID": 19,
"VendorPartNumber": "",
"RowThumbprint": "edb66685-f739-4f47-b15d-2536908b8c79",
"RowInserted": "2019-06-28T17:12:34.343Z",
"RowUpdated": "2019-06-28T17:12:34.343Z",
"RowEvent": "Added"
}
]

Inventory / Products / Vendors / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"LocationID": 33484,
"GlobalProductID": 2037,
"VendorID": 21,
"Priority": 23,
"Cost": 15,
"Comments": "",
"DoNotOrder": "",
"SpecialOrder": "",
"WriteOff": "",
"DateEOL": "",
"DiscontinuedDate": "",
"DiscontinuedEmployeeID": 45,
"IsDeletedRow": false,
"EOLOverride": false,
"DiscontinuedOverride": false,
"RowThumbprint": "952de7fa-bada-4ae0-8fbd-6fab1850fbfd",
"RowInserted": "2019-07-25T00:36:47.977Z",
"RowUpdated": "2019-07-25T00:36:47.977Z",
"RowEvent": "Added"
}
]

Inventory / Receiving

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"ReceivingID": 5,
"ReceivingIDByStore": "84WEARE1",
"PurchaseOrderID": 11,
"EmployeeID": 58001,
"ReceiverStoreID": 1,
"VendorInvoiceNumber": 151515,
"ExtraCosts": 2.47,
"Comments": "",
"Tax1Amount": 0,
"Tax2Amount": 0,
"Posted": true,
"Paid": true,
"Flagged": false,
"ReconciliationComments": "",
"Tax1ID": 5,
"Tax2ID": 8,
"RowThumbprint": "c037746f-48fb-4526-98ce-1034af42476f",
"RowInserted": "2019-02-01T13:27:00.373Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Receiving And Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"ReceivingID": 18770,
"GlobalProductID": 3,
"SerialNumber": "",
"UnitCost": 320,
"Quantity": 1,
"Reconciled": false,
"DateCreated": "2019-02-11T17:09:49.800Z",
"Correction": false,
"ReasonCode": 0,
"ReconciledDate": "",
"ReasonCodeType": 1,
"CorrectedByID": 21,
"RowThumbprint": "e155c7c8-e54c-4635-b2c0-a873f5b7b5bf",
"RowInserted": "2019-02-11T23:09:51.443Z",
"RowUpdated": "",
"RowEvent": "Added",
"LocationID": 33484
}
]

Inventory / Stock Balances

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"StockBalanceID": 63,
"StockBalanceIDByStore": "WETUMSB1",
"StoreID": 9,
"VendorID": 25,
"EmployeeID": 58001,
"CustomerID": 39,
"RMANumber": "N/A",
"WayBillNumber": "",
"CreditInvoiceNumber": "",
"ShippingMethod": "Regular",
"ShippingCost": 0,
"SBCommitted": true,
"DateCommitted": "2019-06-08T14:06:03.520Z",
"SBShippedAway": true,
"SBCompleted": false,
"Comments": "Damaged",
"ReceivingComments": "",
"DateCreated": "2019-06-08T14:06:03.520Z",
"RowTimeStamp": "AAAAAACJqcw=",
"RowThumbprint": "a3715ecc-693b-4f9d-932f-904983e462d7",
"RowInserted": "2019-06-08T14:06:03.520Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Stock Balances And Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"StockBalanceID": 1362,
"GlobalProductID": 10803,
"SerialNumberRemoved": 1234567890,
"SerialNumberAdded": "",
"VendorInvoiceNumber": "",
"Quantity": 1,
"UnitCost": 99.99,
"EmployeeID2": 14,
"DateReceived": "",
"ActionTaken": 1,
"EmployeeID1": 36,
"DateShipped": "",
"UnitCostCredited": 40,
"NonSellableQuantity": 0,
"AdjustedUnitCost": 18,
"NonSellableUnitCost": 0,
"IsUsed": false,
"RowThumbprint": "27b2b2c6-a99f-4bb5-8e20-71857cf5f6f1",
"RowInserted": "2019-08-15T19:03:35.950Z",
"RowUpdated": "2019-08-15T19:03:36.073Z",
"RowEvent": "Added",
"LocationID": 33484
}
]

Inventory / Stock Balances And Products Tracking

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"StockBalanceID": 1329,
"GlobalProductID": 14366,
"SerialNumberRemoved": "",
"TrackingID": 585,
"QuantityReceived": 1,
"DateReceived": "2019-03-22T13:11:58.110Z",
"ReceivingEmployeeID": 3522,
"UnitCostCredited": 0,
"ActionTaken": 2,
"UnitCost": 2,
"WentToNonSellable": false,
"RowThumbprint": "0a897e1d-3623-48cc-a18c-df970773c0c8",
"RowInserted": "2019-03-22T13:11:58.110Z",
"RowUpdated": "",
"RowEvent": "Added",
"LocationID": 33484
}
]

Inventory / Transfers

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"TransferID": 3920,
"TransferIDByStore": "REDSTTR453",
"StoreIDFrom": 11,
"StoreIDTo": 13,
"TransferCommitted": true,
"DateCommitted": "2019-07-25T10:52:13.447Z",
"ShippingMethod": "Regular",
"ShippingCost": 0,
"StoreIDToBillShippingTo": 28,
"RequestingComments": "",
"ShippingComments": "",
"ReceivingComments": "",
"DateRequested": "2019-07-25T10:52:13.447Z",
"EmployeeID": 58001,
"TransferCompleted": false,
"EstimatedArrivalDate": "2019-07-26T00:00:00.000Z",
"RowTimeStamp": "AAAAAAApS7A=",
"WaybillNumber": "",
"CancelledByID": 10,
"CancelledDate": "",
"RowThumbprint": "fb4ff698-40a2-45f6-8cea-5ba9c3daa2c6",
"RowInserted": "2019-07-25T10:52:13.447Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Inventory / Transfers And Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"TransferID": 4314,
"GlobalProductID": 2189,
"SerialNumber": "",
"Quantity": 1,
"UnitCost": 27,
"EmployeeIDShippedBy": 221,
"DateShipped": "2019-04-05T08:43:40.070Z",
"EmployeeIDReceivedBy": 20,
"DateReceived": "",
"NonSellableQuantity": 0,
"AdjustedUnitCost": 10,
"NonSellableUnitCost": 0,
"QuantityShipped": 1,
"NonSellableQuantityShipped": 0,
"TotalQuantityReceived": 0,
"TotalNonSellableQuantityReceived": 0,
"IsUsed": false,
"DateAddedToNonSellable": "",
"RowThumbprint": "c5c525d8-e33f-414d-8d24-f78f3726deea",
"RowInserted": "2019-04-05T08:43:40.070Z",
"RowUpdated": "2019-08-16T20:07:27.950Z",
"RowEvent": "Added",
"LocationID": 33484
}
]

Inventory / Warranty Loaner Ledger GP

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"LedgerID": 1,
"ServiceRequestID": 7,
"GlobalProductID": 3859,
"SerialNumber": "",
"UnitCost": 0,
"DateSignedOut": "2019-10-24T11:16:55.080Z",
"EmployeeID1": 250,
"StoreID1": 1,
"DateReturned": "",
"EmployeeID2": 0,
"StoreID2": 0,
"ReturnedComments": "",
"IsUsed": false,
"ServiceAndRepairID": "09989fe0-a87f-4a99-ae21-8a727f44c714",
"RowThumbprint": "fe80574c-c92d-45d1-9243-da8c4e3302d7",
"RowInserted": "2019-11-06T21:23:09.023Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Locations

Locations / Districts

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"DistrictLocationID": 138,
"RegionLocationID": 25,
"PrimaryEmployeeID": 1795340,
"PrimaryEmployeeCommissionable": false,
"DistrictName": "2-District",
"DistrictCode": "",
"RowThumbprint": "e4068370-5d6b-4fd3-971e-bf3fdeaa5855",
"RowInserted": "2019-07-25T06:16:47.607Z",
"RowUpdated": "2019-04-10T18:24:22.197Z",
"RowEvent": "Added"
}
]

Locations / Channels

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
LanguageCode	string Default: "en-us" Example: LanguageCode=en-us Language code

Responses

Response samples

200

Content type

application/json

[{"PrimaryEmployeeID": 1795340,
"PrimaryEmployeeCommissionable": false,
"RowThumbprint": "e4068370-5d6b-4fd3-971e-bf3fdeaa5855",
"RowInserted": "2019-07-25T06:16:47.607Z",
"RowUpdated": "2019-04-10T18:24:22.197Z",
"RowEvent": "Added",
"ChannelLocationID": 4,
"ChannelName": "",
"ChannelCode": ""
}
]

Locations / Regions

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"RegionLocationID": 33436,
"ChannelLocationID": 33426,
"PrimaryEmployeeID": 44305,
"PrimaryEmployeeCommissionable": true,
"RegionName": "Test Region",
"RegionCode": "TTR",
"RowThumbprint": "9fccac40-f456-4efe-8cd0-adba6d91306e",
"RowInserted": "2019-05-05T06:19:14.643Z",
"RowUpdated": "2019-10-23T09:08:25.973Z",
"RowEvent": "Added"
}
]

Locations / Stores

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"StoreLocationID": 33484,
"LocationCode": "84WEA39169",
"Abbreviation": "84WEA",
"GLCode": "84WEA",
"StoreName": "Kiosk",
"Address": "3850 Main Street",
"City": "Regina",
"Region": "SK",
"Country": "Canada",
"ZipPostal": "H0H 0H0",
"PhoneNumber": 2222222221,
"FaxNumber": 5555555555,
"PrimaryContactEmployeeID": 46734,
"TimeZoneName": "(GMT-06:00) Saskatchewan",
"DSTEnabled": false,
"StoreType": "Convenience Store",
"Enabled": true,
"DistrictLocationID": 33457,
"PrimaryContactCommissionableEmployeeID": 1830127,
"SquareFootage": 2002,
"MultipleCashout": true,
"MultipleCashoutDate": "2019-08-31T14:15:52.700Z",
"Comments": "Kiosk",
"HideCustomerAddress": false,
"StoreEmail": "test@gmail.com",
"InvoiceMiscellaneousComment": "Kiosk",
"ShowStoreInStoreAdditions": false,
"ForceSerialNumberEntryOnSalesOrders": false,
"LaunchPAWOnSalesOrders": false,
"ShowCommentsOnSalesOrders": false,
"ActiveDonation": "Even Newer Donation",
"StaffLevel": 5,
"BankDetails": "detail",
"LeaseStartDate": "2019-09-02T00:00:00.000Z",
"LeaseEndDate": "",
"RelocationDate": "",
"RentAmount": 2000,
"RentTaxes": 0,
"InsuranceAmount": 0,
"OtherCharges": 0,
"DepositTaken": 0,
"LeaseNotes": "NOTES!",
"LandlordNotes": "",
"LandlordName": "",
"InsuranceCompany": "",
"MaxCashDrawer": 99999999,
"UseLocationEmail": true,
"EmailDisplayName": "michael",
"DateLastStatusChanged": "2019-01-09T15:00:00.187Z",
"ForcePhoneNumberEntryOnSalesOrders": false,
"ShowInvoiceCommentsOnInvoices": true,
"CreatedByEmployeeID": 58034,
"UpdatedByEmployeeID": 112673,
"AllowShipToStoreForDropshipSales": false,
"AllowDropshipOrdersToBeShippedToThisStore": false,
"UseTaxServiceForTaxCalculation": false,
"ShowDuplicateProductsOnUncommittedCountSheets": false,
"ForcePasswordPlusFingerprintAuthenticationForPunchClock": false,
"ForceStatusValidationOnAppleDeviceForReturn": false,
"LaunchCarrierIntegrationWhenInvoicingSalesOrder": true,
"RowThumbprint": "879acb36-1653-4a9b-acc6-d3f87720b2d9",
"RowInserted": "2019-03-30T10:28:15.983Z",
"RowUpdated": "2019-10-11T22:00:24.590Z",
"RowEvent": "Added"
}
]

Locations / Stores / Types

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
LanguageCode	string Default: "en-us" Example: LanguageCode=en-us Language code

Responses

Response samples

200

Content type

application/json

[{"StoreTypeID": 1,
"StoreTypeName": "Retail Store",
"RowThumbprint": "5270971c-858a-4dd0-93c1-5751013a72b8",
"RowInserted": "2019-05-05T06:19:10.677Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Orders

Orders

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"OrderEntryID": 2,
"OrderEntryIDByStore": "WIREGOE1",
"LocationID": 33484,
"CustomerID1": "f741d9b9-8928-43da-8118-cf2cc096dfe2",
"CustomerID2": "",
"CustomerPONumber": "",
"EmployeeID1": 46745,
"EmployeeID2": 41,
"EmployeeID3": 46745,
"SplitRate1": 100,
"SplitRate2": 0,
"Comments": "",
"ExpiryDate": "",
"EstimatedArrivalDate": "2019-01-20T00:00:00.000Z",
"OrderEntryType": "Sales Order",
"AllowMultipleInvoices": false,
"Completed": false,
"TotalDeposit": 30.51,
"SignatureCaptured": false,
"IsPaidInFull": "",
"MerchantNumber": "",
"StoreInStoreFlowWasEnabled": false,
"DiscountReason": "",
"RefundCodeID": "",
"LogWorkstationName": "",
"LogLocationID": 8,
"SystemDeleteFlag": false,
"DealerShareInvoiceID": 4,
"UserChoseToNotOrderProductsWhenPromptedToGeneratePO": false,
"InvoiceSource": "RQ",
"RowThumbprint": "494fd6a4-2e44-4fef-8af6-5165732bec02",
"RowInserted": "2019-01-13T19:11:58.350Z",
"RowUpdated": "2019-12-04T19:18:30.643Z",
"RowEvent": "Added"
}
]

Orders / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"OrderEntryID": 2,
"GlobalProductID": 255,
"LineItem": 1,
"Quantity": 1,
"QuantityInvoiced": 0,
"UnitPrice": 27.99,
"ListPrice": 27.99,
"LocationID": 33484,
"AssociationNumber": 0,
"SerialNumber": "",
"SerialIsFromInventory": false,
"ActivatedThroughPAW": "",
"StoreInStorePrice": 2,
"StoreInStoreProductIdentifier": "",
"StoreInStoreListPrice": 27,
"UnitCost": 0,
"StoreInStoreInvoicePrice": 46,
"CarrierIntegrationHandsetID": "",
"MagSwipeData": "",
"ContractNumber": "",
"SOCCode": "",
"SOCCode2": "",
"ActivationAssociationNumber": 27,
"ProductReturnedForABundle": false,
"YourPriceAffectedByManualChange": false,
"IsUsed": false,
"PAWProductType": 39,
"PAWUnitPrice": 0,
"SystemDeleteFlag": false,
"ParentAssociationNumber": 10,
"BundleSKU": "",
"CanEditSerialNumber": false,
"IntegratedTaxProductId": "",
"UseLowestPrice": "",
"LowestPrice": 14,
"BundleId": 43,
"BundlePriority": 18,
"TaxApplicationType": 5,
"IsOrderServiceDropShipProduct": "",
"IsOrderServiceShippingProduct": "",
"RetailerCatalogID": "",
"OrderServiceOrderID": "",
"OrderServiceProductID": "",
"PhoneNumber": "",
"PurchaseOrderID": 7,
"PurchaseOrderQty": 5,
"RowThumbprint": "445ca7ed-7cc9-4bb8-b72b-e75efafaa6e2",
"RowInserted": "2019-01-13T19:11:58.350Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Orders / Purchases

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"PurchaseOrderID": 1,
"PurchaseOrderIDByStore": "MILLHPO1",
"VendorID": 14,
"OrderedLocationID": 33484,
"ReceivedLocationID": 33493,
"EmployeeID": 58001,
"POCommitted": true,
"DateCommitted": "2019-02-01T08:44:16.830Z",
"POCompleted": true,
"Comments": "",
"ShippingMethod": "Fed Ex",
"EstimatedArrivalDate": "2019-02-06T00:00:00.000Z",
"CustomerID": "",
"BillToLocationID": 33484,
"ReferenceNumber": 2211381,
"VendorNumber": "",
"ShippingCost": 0,
"ModifiedByEmployeeID": 26,
"RowThumbprint": "94e8fc8b-fae2-4c8f-88d3-7a1bf42a2e42",
"RowInserted": "2019-02-01T08:44:16.830Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Orders / Purchases / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"PurchaseOrderID": 1,
"GlobalProductID": 1,
"UnitCost": 453,
"VendorPartNumber": "",
"ReceiverStoreName": "Kiosk",
"VendorName": "Vendor",
"ProductIdentifier": "ACFGRD000060",
"ProductName": "Clear Sparkle Case",
"Category": "Misc",
"QuantityOrdered": 1,
"QuantityReceived": 1,
"TotalQuantityReceived": 1,
"TotalCostReceived": 453,
"EmployeeName": "Jane Doe",
"PartiallyReceived": "No",
"FullyReceived": 1,
"ReceivingComments": "",
"OrderEntryID": 16,
"OrderEntryIDByStore": "",
"VendorTerms": "",
"COGSAccountNumber": 10,
"RowThumbprint": "e69bbbe8-999d-42f3-a60c-2b49039590ae",
"RowInserted": "2019-02-01T08:44:16.830Z",
"RowUpdated": "2019-10-09T15:43:34.850Z",
"RowEvent": "Added"
}
]

Performance

Performance Groups

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GroupID": 1,
"GroupName": "New Activations",
"TargetLevel": 4,
"Priority": 13,
"GroupDefinitionID": 0,
"Status": 1,
"RowThumbprint": "aa60b3b5-d0dd-47aa-84d8-05bd6d9e7326",
"RowInserted": "2019-04-25T06:19:12.343Z",
"RowUpdated": "2019-11-23T20:53:05.763Z",
"RowEvent": "Added"
}
]

Groups / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GroupID": 7,
"GlobalProductID": 1698,
"RowThumbprint": "f6a6d229-d347-46e2-8a9b-575093d33566",
"RowInserted": "2019-05-05T06:19:12.403Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Groups / Categories

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.

Responses

Response samples

200

Content type

application/json

[{"GroupID": 4,
"CategoryNumber": 101010111212,
"RowInserted": "2019-05-05T06:19:12.390Z",
"RowUpdated": "",
"RowThumbprint": "cb83c399-f11b-4720-91ad-ae0f9a912f9e",
"RowEvent": "Added"
}
]

Sales

Sales

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"SaleInvoiceID": 1,
"InvoiceIDByStore": "TARGEIN1",
"LocationID": 33484,
"CreditedLocationID": 33486,
"OriginalSaleInvoiceID": 25,
"OrderEntryID": 11,
"AccountsReceivableID": 34,
"CustomerID": "e7f5efa7-a541-4e0e-bbc4-a9631beedb83",
"AccountsReceivableCustomerID": "",
"CustomerPONumber": "",
"PrimaryEmployeeID": 46738,
"SecondaryEmployeeID": 49,
"LoggedInEmployeeID": 46738,
"StoreManagerEmployeeID": 58034,
"DistrictManagerEmployeeID": 42,
"RegionManagerEmployeeID": 23,
"ChannelManagerEmployeeID": 37,
"LastUpdatedEmployeeID": 13,
"SplitRate1": 100,
"SplitRate2": 0,
"Comments": "",
"ChangeAmount": 0,
"TerminalID": 0,
"MarketingTypeName": "",
"RefundReasonCodeID": "",
"DiscountReasonCodeID": -1,
"SignatureCaptured": false,
"MerchantNumber": "",
"RecurringInvoiceID": 19,
"LoyaltyProgramID": "",
"LoyaltyProgramID2": "",
"IsHardwareCollection": false,
"CustomerConsentHardwareCollection": false,
"InvoiceEmailID": 40,
"IsHardwareCollectionChargeback": false,
"TaxableAddress": "",
"InvoiceSource": "RQ",
"RowThumbprint": "d7c4b218-5650-4f7a-97d0-1b707cdfc047",
"RowInserted": "2019-07-03T17:07:19.590Z",
"RowUpdated": "",
"OriginalInvoiceSaleDate": "",
"InvoiceEditedDate": "",
"RowEvent": "Added"
}
]

Sales / Activations

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"TransactionID": 1,
"SaleInvoiceID": 920,
"AssociationNumber": 1,
"PriceSheetTermID": 38,
"VendorAccountID": 1,
"GlobalProductID": 1419,
"LineItem": 1,
"RatePlanGlobalProductID": 1104,
"RatePlanLineItem": 3,
"RatePlanGlobalProductID2": 44,
"RatePlanLineItem2": 1,
"ManualOverrideImport": false,
"ManualOverrideImportComments": "",
"ManualOverrideImportReason": "",
"SocCode1": 0,
"SocDescription1": "",
"SocCode2": 0,
"SocDescription2": "",
"DealerCode": "",
"CarrierImportNotUsedReason": "",
"CarrierImportNotUsedComments": "",
"ActivationAssociationNumber": 1,
"PawPrice": 50,
"PriceSheetID": 38,
"PhoneNumber": "",
"HardwareRebateGlobalProductID": 17,
"HardwareRebateLineItem": 19,
"RatePlanRebateGlobalProductID": 45,
"RatePlanRebateLineItem": 6,
"RatePlan2RebateGlobalProductID": 31,
"RatePlan2RebateLineItem": 1,
"HardwareSpiffRebateID": 40,
"HardwareSpiffRebatePLineItem": 17,
"AdvancedSpiffRebateGlobalProductID": 28,
"AdvancedSpiffRebateLineItem": 15,
"AdvancedSpiffRebate2GlobalProductID": 48,
"AdvancedSpiffRebate2LineItem": 13,
"IncludePortedNumber": "",
"PortNumber": "",
"BuyOnlinePriceSheet": false,
"RowThumbprint": "9b575f67-6bb4-4284-b565-11036cb2d615",
"RowInserted": "2019-02-08T15:23:01.690Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Sales / ChargeBacks / Full

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"FullChargeBackID": "4fa93984-1755-4334-8492-25f5783d66e7",
"FullChargeBackIDByStore": "PERRYFC1",
"SaleInvoiceID": 83914,
"Comments": "Comment",
"ChargedBackByEmployeeID": 58037,
"ChargedBackAtLocationID": 247690,
"IsReversal": false,
"VendorAccountTransactionID": 68,
"RowThumbprint": "87e978fc-9bcb-4874-b1d8-d32e2229b67b",
"RowInserted": "2019-09-26T13:33:43.003Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Sales / ChargeBacks / Full / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"FullChargeBackID": "4fa93984-1755-4334-8492-25f5783d66e7",
"GlobalProductID": 2120,
"SerialNumber": 8506728399,
"LineItem": 5,
"ChargedBackAmount": -190,
"RowThumbprint": "4cef7a38-4433-450c-b7d3-aa0718747089",
"RowInserted": "2019-09-26T13:33:43.003Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Sales / ChargeBacks / Partial

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"ChargebackID": 1,
"ChargebackIDByStore": "REDSTCB1",
"EmployeeID": 58001,
"RowInserted": "2019-04-21T10:10:55.073Z",
"RowUpdated": "2019-05-05T06:20:39.117Z",
"RowThumbprint": "f4e04905-97df-4f9a-b79f-3ee228939fd8",
"RowEvent": "Added"
}
]

Sales / ChargeBacks / Partial / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"ChargebackID": 1,
"SaleInvoiceID": 1281,
"GlobalProductID": 994,
"SerialNumber": 6626887826,
"LineItem": 4,
"Return": -230.01,
"DateAdjusted": "2019-03-31T00:00:00.000Z",
"Quantity": 1,
"IsReversal": false,
"VendorAccountTransactionID": 47,
"PreviousTotalReturn": 21,
"RowThumbprint": "1ce3f1dd-fe98-4863-b97f-ee8c5844eaa9",
"RowInserted": "2019-04-21T10:10:55.137Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Sales / Coupons

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"SaleInvoiceAndCouponID": "2268cc93-3a23-4449-b93b-06e64f509665",
"SaleType": "Refund",
"SaleInvoiceID": 136474,
"CouponID": 2409,
"Amount": 30,
"LoyaltyProgramID": "",
"SerialNumber": "",
"GLAccountID": 2009,
"OriginalSaleInvoiceAndCouponID": 0,
"Returned": true,
"IntegrationProviderID": "",
"SaleInvoiceAndProductCouponGroupID": "",
"IntegratedTaxCouponId": "",
"RowThumbprint": "4dbe826e-ac18-45a2-99fb-a2919b7749a1",
"RowInserted": "2019-06-29T20:12:19.687Z",
"RowUpdated": "2019-07-04T16:23:48.407Z",
"RowEvent": "Added",
"StoreID": 6910,
"CouponUsedDate": "2019-06-29T10:12:18.857Z",
"InvoiceNumber": "12212IN108",
"CouponSKU": "COUPON002409",
"CouponName": "410527($30)",
"ProductIdentifier": "N/A"
}
]

Sales / Coupons / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"RowID": 1,
"SaleInvoiceID": 120170,
"CouponID": 6,
"Priority": 2,
"GlobalProductID": 1277,
"SaleInvoiceAndCouponID": "b6e69b73-14dd-4074-b80d-ad82b790456a",
"RowEvent": "Added"
}
]

Sales / Opportunities / Stages

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
LanguageCode	string Default: "en-us" Example: LanguageCode=en-us Language code

Responses

Response samples

200

Content type

application/json

[{"StageID": 1,
"DaysToSale": 30,
"StageName": "No contact with Customer",
"RowThumbprint": "f635e1b4-cd37-43f7-98f1-73bb4997578b",
"RowInserted": "2019-11-06T21:22:49.900Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Sales / Overrides

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"SecurityCode": "",
"SecurityOverrideID": "193ff62a-bda5-4d87-a3c7-214e81fe977c",
"SaleInvoiceID": 24410,
"SecurityOverridesAndInvoicesID": 1,
"SecurityOverrideType": "",
"ReferenceID": 0,
"RowThumbprint": "b4525009-5a3f-4568-85df-ed1a71581292",
"RowInserted": "2019-07-13T20:20:10.010Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Sales / Payments

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"SaleInvoiceID": 1,
"PaymentType": "MasterCard",
"PaymentSequence": 0,
"Amount": 38.14,
"ExpiryDate": "",
"HLReferenceNumber": "",
"ReferenceNumber": "",
"LastFourDigits": "",
"CardType": "",
"CardholderName": "",
"NonRefundedAmount": 38.14,
"RoutingNumber": "",
"CheckingAccountNumber": "",
"CheckSerialNumber": "",
"ServiceFee": "",
"CustomerReceipt": "",
"MerchantReceipt": "",
"CardEntryType": "Not Set",
"TraceNumber": "",
"HardwareCollectionTokenID": 31,
"VendorAccountID": 49,
"IsPennyRoundingEntry": false,
"Balance": "",
"DeviceID": "",
"IsNewHardwareCollection": "",
"OrderEntryDepositPaymentID": "",
"AJBReceipt": "",
"RowThumbprint": "58851a92-ae33-48d1-8fd8-2fdc89453de4",
"RowInserted": "2019-07-03T17:07:19.590Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Sales / Products

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"SaleInvoiceID": 159737,
"GlobalProductID": 1374,
"SerialNumber": "",
"LineItem": 1,
"Quantity": 1,
"UnitPrice": 17,
"UnitCost": 7.89,
"ListPrice": 19.99,
"ContractNumber": "",
"PinCode": "The decrypted pin code for epins.",
"PinExpiryDate": "",
"QuantityRefunded": 0,
"AssociationNumber": 1,
"MLPCalculatedPrice": 0,
"SOCCode": "",
"NonSellableQuantity": 0,
"TradeIn": false,
"OriginalUnitPrice": 19.99,
"AdjustedUnitCost": 0,
"UpdatedWACAfterReturn": 0,
"Activation": false,
"IsOldest": false,
"ReceivedDate": "",
"DaysOnHand": 0,
"QtyInStock": 0,
"OlderQty": 0,
"ServiceManagerCreatedOnSale": false,
"ExtraField": "string",
"PortNumber": "",
"SOCCode2": "",
"VendorPartNumber": "",
"OriginalPriority": 0,
"MobileNumber": "",
"ActivationAssociationNumber": 0,
"OriginalSerialNumber": "",
"RefundPeriodLength": 0,
"ToUsed": false,
"SoldAsUsed": false,
"OriginalSalesPersonID": 219,
"SwapAssociationNumber": 0,
"AssociatedBillPayGUID": "",
"PAWProductType": 0,
"ProductLibraryID": "M10657",
"OrderServiceOrderID": "",
"OrderServiceProductID": "",
"IsOrderServiceDropShipProduct": false,
"RetailerCatalogID": "8cf7a509-10c0-4961-b443-e7e479e9b14f",
"ActivationTransactionID": 0,
"ParentAssociationNumber": 1,
"BundleSKU": "",
"Refundable": true,
"IsOrderServiceShippingProduct": false,
"LeaseAssociationID": "",
"UnitLeasedAmount": 0,
"UseLowestPrice": false,
"LowestPrice": 0,
"IntegratedTaxProductId": "",
"ClassificationCode": 0,
"BundleId": 0,
"BundlePriority": 0,
"OriginalBundlePriority": 0,
"VendorID": 0,
"DonationId": "",
"RowThumbprint": "14961299-cad0-489a-949a-7ea60510dd2d",
"RowInserted": "2019-01-15T02:27:38.750Z",
"RowUpdated": "",
"RowEvent": "Added",
"LocationID": 33484
}
]

Sales / Products / Adjustments

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"SaleInvoiceID": 1364,
"GlobalProductID": 1225,
"SerialNumber": "A0000022BC5624",
"LineItem": 1,
"AdjustedUnitCost": 150,
"AdjustedDate": "2019-03-17T17:08:36.053Z",
"PreviousUnitCost": 453,
"ChangeInUnitCost": -303,
"RowThumbprint": "2966f07a-ef6f-4b00-bca2-5437c12e4abe",
"RowInserted": "2019-02-11T16:55:41.540Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Sales / Products / NonSellable

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"SaleInvoiceID": 251,
"GlobalProductID": 1225,
"SerialNumber": "A0000022BAF02A",
"Priority": 2,
"Quantity": 1,
"UnitCost": 495.33,
"NonSellableReasonCode": "",
"NonSellableComments": "",
"RowThumbprint": "b9adb062-1797-45b9-89e6-7c30bccb09f1",
"RowInserted": "2019-11-06T21:21:53.767Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Sales / Products / Taxes

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"SaleInvoiceID": 1,
"GlobalProductID": 754,
"SerialNumber": "",
"LineItem": 1,
"TaxID": 1,
"TaxName": "Tax",
"TaxRate": 4,
"TaxableUnitPrice": 1,
"FlatTax": 4,
"Amount": 1.4,
"FullTaxRate": 4,
"ExemptAmount": 25,
"IgnoreLeasedAmount": false,
"RowThumbprint": "f007e0fe-87f4-44e4-a0ac-5b4f2c785546",
"RowInserted": "2019-07-03T17:07:19.590Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Misc

Other / ReasonCodes

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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

Responses

Response samples

200

Content type

application/json

[{"ReasonCodeID": "19b8bbde-c3df-49ac-9af3-352d413b0978",
"Name": "14 Day return",
"Enabled": false,
"Priority": 2,
"RowThumbprint": "d519b5cd-73fb-4257-bb8f-92aa2822f055",
"RowInserted": "2019-05-05T06:16:59.423Z",
"RowUpdated": "2019-01-25T18:28:36.150Z",
"RowEvent": "Updated"
}
]

Other / SecurityOverrides

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"SecurityOverrideID": 593,
"SecurityOverrideName": "Discount",
"LocationID": 33484,
"RequestedByEmployeeID": 1830127,
"GeneratedByEmployeeID": 58001,
"UsedByEmployeeID": 0,
"ExpiryDate": "2019-07-13T00:00:00.000Z",
"AppliedDate": "",
"SecurityCode": "5A0X4U",
"RowThumbprint": "e9aea02f-7ccd-43d1-bc47-0313894890e9",
"RowInserted": "2019-07-12T09:04:44.447Z",
"RowUpdated": "",
"RowEvent": "Added"
}
]

Service Requests

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"CustomerID2": 4,
"CustomerSignature": "",
"CustomerSignatureType": 0,
"EmployeeID2": 0,
"EmployeeID3": 0,
"EmployeeID4": 1,
"ExternalComments": "4123",
"FollowUpAfter": 0,
"InternalComments": "",
"Priority": 2,
"ServiceAndRepairId": "2c5558c6-d30a-4a4c-b591-9688fd7009cb",
"ServiceRequestIDByStore": "CHELSSR2",
"ShippingComments": "",
"ShippingETA": "2019-02-15T00:00:00",
"ShippingMethod": "Regular",
"ShippingStatus": 0,
"WayBillNumber": "",
"ContactName": "Homer Simpson",
"ContactNumber": "",
"CustomerID1": 4,
"DateClosed": "2019-02-15T15:00:18.843",
"DateCreated": "2019-02-15T15:00:18.843",
"DateReceived": "2019-02-15T15:00:18.843",
"DateShipped": "2019-02-15T00:00:00",
"Description": 123,
"DescriptionID": -1,
"EmployeeID1": 1,
"ServiceRequestID": 2,
"ServiceType": 0,
"Status": 0,
"StoreID": 1,
"SubStatus": 0,
"RowThumbprint": "fa6a98a4-40dd-489f-aece-82e155873228",
"RowInserted": "2019-02-01T00:16:37.020Z",
"RowUpdated": "2019-03-20T15:13:28.32",
"RowEvent": "Added"
}
]

Tasks

Authorizations:

query Parameters

StartDate required	string Example: StartDate=2019-10-01T18:00:00.000 The initial date and time of the search period, specified in UTC. Defaults to the beginning of SQL time (1970-01-01T00:00:00.000 UTC).
StopDate required	string Example: StopDate=2019-10-01T18:15:00.000 The end date and time of the search period, specified in UTC. Defaults to the current date and time in UTC.
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.

Responses

Response samples

200

Content type

application/json

[{"TaskID": 33,
"LocationEntityID": 33484,
"StopDate": "2019-12-10T15:12:20.18",
"Description": "Test",
"Importance": 1,
"Completed": "Completed",
"EmployeeID2": 197325,
"RowInserted": "2019-02-01T00:16:37.020Z",
"RowUpdated": "2019-03-20T15:13:28.32",
"RowEvent": "Added"
}
]