Activity

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/Activity/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/Activity/RetrieveDetails?filter={filter}

Get all or filtered the Activity details.

Import POST api/Activity/Import

Send the data to import in JSON format as per the provided schema.

BOM

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/BOM/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/BOM/RetrieveDetails?filter={filter}

Get all or filtered the Bill of Ordered Material details.

Import POST api/BOM/Import

Send the data to import in JSON format as per the provided schema.

Configurator

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/Configurator/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/Configurator/RetrieveDetails?filter={filter}

Get all or filtered the Configuration details.

Import POST api/Configurator/Import

Send the data to import in JSON format as per the provided schema.

Contact

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/Contact/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/Contact/RetrieveDetails?filter={filter}

Get all or filtered the Contact details.

Import POST api/Contact/Import

Send the data to import in JSON format as per the provided schema.

Customer

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/Customer/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/Customer/RetrieveDetails?filter={filter}

Get all or filtered the Customer details.

Import POST api/Customer/Import

Send the data to import in JSON format as per the provided schema.

CustomerCommission

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/CustomerCommission/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/CustomerCommission/RetrieveDetails?filter={filter}

Get all or filtered the Customer Commission details.

Import POST api/CustomerCommission/Import

Send the data to import in JSON format as per the provided schema.

CustomerDiscount

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/CustomerDiscount/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/CustomerDiscount/RetrieveDetails?filter={filter}

Get all or filtered the Customer Discount details.

Import POST api/CustomerDiscount/Import

Send the data to import in JSON format as per the provided schema.

Epicor

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveEpicorOrderDetail GET api/Epicor/RetrieveEpicorOrderDetail?orderNumber={orderNumber}

RetrieveEpicorOrderDetail

InventoryItems

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/InventoryItems/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/InventoryItems/RetrieveDetails?filter={filter}

Get all or filtered the Inventory Item details.

Import POST api/InventoryItems/Import

Send the data to import in JSON format as per the provided schema.

ItemMaster

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/ItemMaster/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/ItemMaster/RetrieveDetails?filter={filter}

Get all or filtered the Parts Item details.

Import POST api/ItemMaster/Import

Send the data to import in JSON format as per the provided schema.

Lead

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/Lead/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/Lead/RetrieveDetails?filter={filter}

Get all or filtered the Lead details.

Import POST api/Lead/Import

Send the data to import in JSON format as per the provided schema.

OAuth

Handles requests for the authorization and token.

ActionAPIDescription
AuthorizeKey GET api/OAuth/AuthorizeKey?ApiKey={ApiKey}

Checks if user has permission to this App using Api key

Authorize GET api/OAuth/Authorize?clientId={clientId}&clientSecret={clientSecret}

Checks if user has permission to this App.

RetrieveTokenInfo GET api/OAuth/RetrieveTokenInfo?clientId={clientId}&clientSecret={clientSecret}&accessToken={accessToken}

Get the App info, Token info for an access token.

GenerateToken GET api/OAuth/GenerateToken?clientId={clientId}&clientSecret={clientSecret}

Use the code after a user authorizes your app to get an access token and refresh token. The access token will be used to authenticate requests that your app makes. Access tokens expire after seven hours, so you can use the refresh token to get a new access token when the first access token expires.

RefreshToken GET api/OAuth/RefreshToken?clientId={clientId}&clientSecret={clientSecret}&refreshToken={refreshToken}

Use a previously obtained refresh token to extend expiration by 7 hours. Store the refresh token when initiating your OAuth integration.

DeleteToken GET api/OAuth/DeleteToken?clientId={clientId}&clientSecret={clientSecret}&refreshToken={refreshToken}

Delete a refresh token. You can use this to delete your refresh token if a user uninstalls your app.

ValidateToken GET api/OAuth/ValidateToken?accessToken={accessToken}

No documentation available.

OrderDetail

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/OrderDetail/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/OrderDetail/RetrieveDetails?filter={filter}

Get all or filtered the Quote Header details.

Import POST api/OrderDetail/Import

Send the data to import in JSON format as per the provided schema.

OrderHeader

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/OrderHeader/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/OrderHeader/RetrieveDetails?filter={filter}

Get all or filtered the Order Header details.

Import POST api/OrderHeader/Import

Send the data to import in JSON format as per the provided schema.

OrderStatus

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
Import POST api/OrderStatus/Import

Send the data to import in JSON format as per the provided schema.

Project

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/Project/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/Project/RetrieveDetails?filter={filter}

Get all or filtered the Project details.

Import POST api/Project/Import

Send the data to import in JSON format as per the provided schema.

QuoteHeader

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/QuoteHeader/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/QuoteHeader/RetrieveDetails?filter={filter}

Get all or filtered the Quote Header details.

Import POST api/QuoteHeader/Import

Send the data to import in JSON format as per the provided schema.

Schedule

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveDetailForProject GET api/Schedule/RetrieveDetailForProject?projectID={projectID}

Get all or filtered the Lead details.

ShipTo

Handles requests for the retrieving schema, import/export of the data.

ActionAPIDescription
RetrieveSchema GET api/ShipTo/RetrieveSchema

Get the table schema required to prepare import JSON.

RetrieveDetails GET api/ShipTo/RetrieveDetails?filter={filter}

Get all or filtered the Ship To Address details.

Import POST api/ShipTo/Import

Send the data to import in JSON format as per the provided schema.