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:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Customers / Accounts

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Customers / Activities

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Customers / Activities / Discussions

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Customers / Activities / Followups

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Customers / Protection

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees

Employees

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees / Groups

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees / PunchClock

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees / PunchClock / Revisions

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees / Organization

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employees / WorkHistory

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance

Finance / CashIn

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / CashOuts

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / CashOuts / Terminals

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / CashOuts / Totals

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / CashSkim

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / CloseOuts

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / CloseOuts / Terminals

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / CloseOuts / Totals

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Drawer

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / GeneralLedger

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / GeneralLedger / Accounts

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / PaymentTypes

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Payouts

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / RecurringInvoices

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / RecurringInvoices / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Taxes

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Taxes / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Vendors

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Vendors / Accounts

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Vendors / Accounts / Transactions

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Vendors / Rebates / Adjustments

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Vendors / Rebates / Adjustments / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Vendors / Rebates / Reconcile

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finance / Vendors / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory

Inventory / Adjustments

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Adjustments / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Adjustments / ReasonCodes

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Categories

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / CountSheets

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / CountSheets / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / CountSheets / Products / Categories

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / CountSheets / Products / Orphaned

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / BatchImports

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / BatchImports / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Import

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Import / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Coupons

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Coupons / Serialized

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Coupons / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / GiftCards

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / GiftCards / Active

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / GiftCards / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Loans

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Loans / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Manufacturers

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / NonSellableAdjustments

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / NonSellableAdjustments / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / PriceSheets

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / PriceSheets / Promotions

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / PriceSheets / Promotions / Terms

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / PriceSheets / Promotions / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / PriceSheets / Terms

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / BarCodes

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / Deleted

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / NonSellable / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / NonStocked

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / NonStocked / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / Physical

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / Serialized / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / VendorRebates

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / VendorRebates / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / Vendors

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / Vendors / Serialized

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Products / Vendors / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Receiving

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Receiving And Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Stock Balances

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Stock Balances And Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Stock Balances And Products Tracking

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Transfers

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Transfers And Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory / Warranty Loaner Ledger GP

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Locations

Locations / Districts

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Locations / Channels

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Locations / Regions

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Locations / Stores

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Locations / Stores / Types

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Orders

Orders

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Orders / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Orders / Purchases

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Orders / Purchases / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Performance

Performance Groups

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Groups / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Groups / Categories

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales

Sales

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Activations

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / ChargeBacks / Full

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / ChargeBacks / Full / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / ChargeBacks / Partial

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / ChargeBacks / Partial / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Coupons

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Coupons / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Opportunities / Stages

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Overrides

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Payments

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Products

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Products / Adjustments

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Products / NonSellable

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sales / Products / Taxes

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Misc

Other / ReasonCodes

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

Language code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Other / SecurityOverrides

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service Requests

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tasks

Authorizations:
bearerAuth
query Parameters
StartDate
required
string
Example: StartDate=2019-10-01T18:00:00.000

Initial date and time of the search period, defaults to the beginning of SQL time

StopDate
required
string
Example: StopDate=2019-10-01T18:15:00.000

End date and time of the search period, defaults to now

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=-1

Will filter based on the ID(s) within the Company Tree level indicated in LocationType.

Responses

Response samples

Content type
application/json
[
  • {
    }
]