Contacts

Endpoints for retrieving information about Contacts.

APIDescription
GET v1/Contacts/{id}

Get a Contact.

GET v1/Contacts?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Contacts.

POST v1/Contacts

Create a list of Contacts.

PUT v1/Contacts

Update a list of Contacts.

DELETE v1/Contacts/{id}

Delete a Contact.

Branches

Endpoints for retrieving information about Branches.

APIDescription
GET v1/Branches/{id}

Get a Branch.

GET v1/Branches?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Branches.

POST v1/Branches

Create a list of Branches.

PUT v1/Branches

Update a list of Branches.

ProductCategories

Endpoints for retrieving information about Products Categories.

APIDescription
GET v1/ProductCategories/{id}

Get a Product Category

GET v1/ProductCategories?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Product Categories

Products

Endpoints for retrieving information about products.

APIDescription
GET v1/Products/{id}

Get a Product.

GET v1/Products?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Products.

ProductOptions

Endpoints for retrieving information about product options.

APIDescription
GET v1/ProductOptions/{id}

Get a Product Option.

GET v1/ProductOptions?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Product Options.

SerialNumbers

Endpoints for retrieving information about Serial Numbers.

APIDescription
GET v1/SerialNumbers/{id}

Get a Serial Number.

GET v1/SerialNumbers?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Serial Numbers.

SalesOrders

Endpoints for retrieving information about sales orders

APIDescription
GET v1/SalesOrders/{id}

Get a Sales Order.

GET v1/SalesOrders?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Sales Orders.

POST v1/SalesOrders?loadboms={loadboms}

Create a list of Sales Orders.

PUT v1/SalesOrders?loadboms={loadboms}

Update a list of Sales Orders.

Payments

Endpoints for retrieving information about payments.

APIDescription
GET v1/Payments/{id}

Get a Payment.

GET v1/Payments?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Payments

POST v1/Payments

Create a list of Payments.

PUT v1/Payments

Update a Payments.

DELETE v1/Payments/{id}

Delete a Payment.

Quotes

Endpoints for retrieving information about quotes

APIDescription
GET v1/Quotes/{id}

Get a Quote

GET v1/Quotes?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Quotes

POST v1/Quotes?loadboms={loadboms}

Create a list of Quotes

PUT v1/Quotes?loadboms={loadboms}

Update a list of Quotes

PurchaseOrders

Endpoints for retrieving information about purchase orders.

APIDescription
GET v1/PurchaseOrders/{id}

Get a Purchase Order.

GET v1/PurchaseOrders?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Purchase Orders.

POST v1/PurchaseOrders?loadboms={loadboms}

Create a list of Purchase Orders.

PUT v1/PurchaseOrders?loadboms={loadboms}

Update a list of Purchase Orders.

Stock

Endpoints for retrieving information about stock.

APIDescription
GET v1/Stock?barcode={barcode}

Get a Stock Unit.

GET v1/Stock?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Stock Units.

BranchTransfers

APIDescription
GET v1/BranchTransfers/{id}

Get a Branch Transfer

GET v1/BranchTransfers?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Branch Transfers.

POST v1/BranchTransfers

Create a list of Branch Transfers.

PUT v1/BranchTransfers

Update a list of Branch Transfers.

Adjustments

APIDescription
GET v1/Adjustments/{id}

Get an Adjustment.

GET v1/Adjustments?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Adjustments.

Voucher

Endpoints for retrieving information about vouchers.

APIDescription
GET v1/Voucher?code={code}

Get a Voucher.

GET v1/Voucher?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Vouchers

CreditNotes

Endpoints for retrieving information about Credit Notes.

APIDescription
GET v1/CreditNotes/{id}

Get a Credit Note.

GET v1/CreditNotes?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Credit Notes.

POST v1/CreditNotes

Create a list of Credit Notes.

PUT v1/CreditNotes

Update a list of Credit Notes.

BomMastersV2

APIDescription
GET v2/BomMasters/{id}

Get a Bom Master.

GET v2/BomMasters?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of BOM Masters.

BomMasters

Endpoints for retrieving information about BOM Masters.

APIDescription
GET v1/BomMasters/{id}

Get a Bom Master.

GET v1/BomMasters?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of BOM Masters.

ProductionJobs

Endpoints for retrieving information about Production Jobs.

APIDescription
GET v1/ProductionJobs/{id}

Get a Production Job.

GET v1/ProductionJobs?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Production Jobs.

POST v1/ProductionJobs

Create a list of Production Jobs.

PUT v1/ProductionJobs

Update a list of Production Jobs.

Users

Endpoints for retrieving information about users. Users may take up to 2 hours to appear in the API.

APIDescription
GET v1/Users/{id}

Get a User.

GET v1/Users

Get a list of Users.

Cartons

APIDescription
GET v1/Cartons/{id}

Get the Carton details for a Sales Order.

PUT v1/Cartons/{id}

Replace the list of Cartons for a Sales Order.

SalesOrdersWithCartons

APIDescription
GET v1/SalesOrdersWithCartons/{id}

Get a Sales Order with it's Carton details.

GET v1/SalesOrdersWithCartons?fields={fields}&where={where}&order={order}&page={page}&rows={rows}

Get a list of Sales Orders with their Carton details.