Security

APIDescription
api/Security/Login (POST)

Authenticates the supplied Expandable login credentials.
HTTP Method: POST
Returns an Authentication Token.
The returned Authentication Token must be supplied to the other features of the API.

api/Security/Logout (POST)

Retires the supplied Authentication Token and releases server resources associated with it.
HTTP Method: POST
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).

Customer

APIDescription
api/Customer/Create (POST)

Creates a new Customer using the supplied creation data.
HTTP Method: POST
Required Fields: CUSTOMER_ID, CUSTOMER_NAME
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Customer.

api/Customer/Update (POST)

Updates an existing Customer using the supplied update data.
HTTP Method: POST
Required Fields: CUSTOMER_ID to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Customer.

api/Customer/Delete (POST)

Deletes an existing Customer using the supplied keys.
HTTP Method: POST
Required Fields: CUSTOMER_ID to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/Customer/Query (POST)

Queries existing Customers using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Customers.

SalesOrder

APIDescription
api/SalesOrder/Create (POST)

Creates a new Sales Order using the supplied creation data.
HTTP Method: POST
Required Fields:
- SalesOrder: SO_ID*, CUSTOMER_ID
- SalesOrderLine: SO_LINE_NO, PART_ID or SO_DESC
- SalesOrderComment: SO_LINE_NO, PRINT_INVOICE, COMMENT_TEXT
- SalesOrderExtendedUser: SO_LINE_NO
* If Auto SO ID is enabled then SO_ID is not required in SalesOrder.
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Sales Order.

api/SalesOrder/Update (POST)

Updates an existing Sales Order using the supplied update data.
HTTP Method: POST
Required Fields:
- SalesOrder: SO_ID to locate the record
- SalesOrderLine: SO_LINE_NO to locate the record and at least one other field to update
- SalesOrderComment: SO_LINE_NO, PRINT_INVOICE to locate the record and at least one other field to update
- SalesOrderExtendedUser: SO_LINE_NO to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Sales Order.

api/SalesOrder/Delete (POST)

Deletes an existing Sales Order using the supplied keys.
HTTP Method: POST
Required Fields: SO_ID to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/SalesOrder/Query (POST)

Queries existing Sales Orders using the provided query data.
HTTP Method: POST
Required Fields: At least one field in SalesOrder or SalesOrderLine as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Sales Orders.

CustomerPart

APIDescription
api/CustomerPart/Create (POST)

Creates a new Customer Part using the supplied creation data.
HTTP Method: POST
Required Fields: PART_ID, CUSTOMER_ID, CUST_PART_ID
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Customer Part.

api/CustomerPart/Update (POST)

Updates an existing Customer Part using the supplied update data.
HTTP Method: POST
Required Fields: PART_ID, CUSTOMER_ID, CUST_PART_ID to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Customer Part.

api/CustomerPart/Delete (POST)

Deletes an existing Customer Part using the supplied keys.
HTTP Method: POST
Required Fields: PART_ID, CUSTOMER_ID, CUST_PART_ID to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/CustomerPart/Query (POST)

Queries existing Customers Parts using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Customer Parts.

CustomerContact

APIDescription
api/CustomerContact/Create (POST)

Creates a new Customer Contact using the supplied creation data.
HTTP Method: POST
Required Fields: CUSTOMER_ID, CUST_CONTACT
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Customer Contact.

api/CustomerContact/Update (POST)

Updates an existing Customer Contact using the supplied update data.
HTTP Method: POST
Required Fields: CUSTOMER_ID, CUST_CONTACT to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Customer Contact.

api/CustomerContact/Delete (POST)

Deletes an existing Customer Contact using the supplied keys.
HTTP Method: POST
Required Fields: CUSTOMER_ID, CUST_CONTACT to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/CustomerContact/Query (POST)

Queries existing Customers Contacts using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Customer Contacts.

ShipmentsEntry

APIDescription
api/ShipmentsEntry/Create (POST)

Creates a new Shipments Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields:
ShipmentsEntry: SO_ID
ShipmentsEntryDetail: SO_LINE_NO
ShipmentsEntryFreight: AMOUNT
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Shipments Entry Transaction.

api/ShipmentsEntry/Query (POST)

Queries existing Shipments using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Shipments.

ProductPrice

APIDescription
api/ProductPrice/Create (POST)

Creates a new Product Price using the supplied creation data.
HTTP Method: POST
Required Fields: PART_ID, PRICE_CODE
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Product Price.

api/ProductPrice/Update (POST)

Updates an existing Product Price using the supplied update data.
HTTP Method: POST
Required Fields: PART_ID, PRICE_CODE, EFFECTIVE_DATE, ORDER_QTY to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Product Price.

api/ProductPrice/Delete (POST)

Deletes an existing Product Price using the supplied keys.
HTTP Method: POST
Required Fields: PART_ID, PRICE_CODE, EFFECTIVE_DATE, ORDER_QTY to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/ProductPrice/Query (POST)

Queries existing Product Prices using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Product Prices.

SerialNumber

APIDescription
api/SerialNumber/Create (POST)

Creates a new Serial Number using the supplied creation data.
HTTP Method: POST
Required Fields: PART_ID, SERIAL_NUMBER
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Serial Number.

api/SerialNumber/Update (POST)

Updates an existing Serial Number using the supplied update data.
HTTP Method: POST
Required Fields: PART_ID, SERIAL_NUMBER to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Serial Number.

api/SerialNumber/Delete (POST)

Deletes an existing Serial Number using the supplied keys.
HTTP Method: POST
Required Fields: PART_ID, SERIAL_NUMBER to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/SerialNumber/Query (POST)

Queries existing Serial Numbers using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Serial Numbers.

Lot

APIDescription
api/Lot/Create (POST)

Creates a new Lot using the supplied creation data.
HTTP Method: POST
Required Fields: PART_ID, LOT_ID
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Lot.

api/Lot/Update (POST)

Updates an existing Lot using the supplied update data.
HTTP Method: POST
Required Fields: PART_ID, LOT_ID to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Lot.

api/Lot/Delete (POST)

Deletes an existing Lot using the supplied keys.
HTTP Method: POST
Required Fields: PART_ID, LOT_ID to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/Lot/Query (POST)

Queries existing Lots using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Lots.

Vendor

APIDescription
api/Vendor/Create (POST)

Creates a new Vendor using the supplied creation data.
HTTP Method: POST
Required Fields: VENDOR_ID, VENDOR_NAME
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Vendor.

api/Vendor/Update (POST)

Updates an existing Vendor using the supplied update data.
HTTP Method: POST
Required Fields: VENDOR_ID to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Vendor.

api/Vendor/Delete (POST)

Deletes an existing Vendor using the supplied keys.
HTTP Method: POST
Required Fields: VENDOR_ID to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/Vendor/Query (POST)

Queries existing Vendors using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Vendors.

PurchaseOrder

APIDescription
api/PurchaseOrder/Create (POST)

Creates a new Purchase Order using the supplied creation data.
HTTP Method: POST
Required Fields:
- PurchaseOrder: PO_ID*, VENDOR_ID
- PurchaseOrderLine: LINE_NUMBER, PART_ID or PO_DESC
- PurchaseOrderComment: PO_LINE_NO, PRINT_PO, COMMENT_TEXT
- PurchaseOrderExtendedUser: LINE_NUMBER
* If Auto PO ID is enabled then PO_ID is not required in PurchaseOrder.
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Purchase Order.

api/PurchaseOrder/Update (POST)

Updates an existing Purchase Order using the supplied update data.
HTTP Method: POST
Required Fields:
- PurchaseOrder: PO_ID to locate the record
- PurchaseOrderLine: LINE_NUMBER to locate the record and at least one other field to update
- PurchaseOrderComment: PO_LINE_NO, PRINT_PO to locate the record and at least one other field to update
- PurchaseOrderExtendedUser: LINE_NUMBER to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Purchase Order.

api/PurchaseOrder/Delete (POST)

Deletes an existing Purchase Order using the supplied keys.
HTTP Method: POST
Required Fields: PO_ID to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/PurchaseOrder/Query (POST)

Queries existing Purchase Orders using the provided query data.
HTTP Method: POST
Required Fields: At least one field in PurchaseOrder or PurchaseOrderLine as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Purchase Orders.

VendorContact

APIDescription
api/VendorContact/Create (POST)

Creates a new Vendor Contact using the supplied creation data.
HTTP Method: POST
Required Fields: VENDOR_ID, VENDOR_CONTACT
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Vendor Contact.

api/VendorContact/Update (POST)

Updates an existing Vendor Contact using the supplied update data.
HTTP Method: POST
Required Fields: VENDOR_ID, VENDOR_CONTACT to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Vendor Contact.

api/VendorContact/Delete (POST)

Deletes an existing Vendor Contact using the supplied keys.
HTTP Method: POST
Required Fields: VENDOR_ID, VENDOR_CONTACT to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/VendorContact/Query (POST)

Queries existing Vendors Contacts using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Vendor Contacts.

POReceiptsEntry

APIDescription
api/POReceiptsEntry/Create (POST)

Creates a new PO Receipts Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields: PO_ID
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created PO Receipts Entry Transaction.

api/POReceiptsEntry/Query (POST)

Queries existing PO Receipts using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found PO Receipts.

APInvoiceEntry

APIDescription
api/APInvoiceEntry/Create (POST)

Creates a new AP Invoice Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields: INVOICE_TYPE, INVOICE_ID, INVOICE_AMT
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created AP Invoice Entry Transaction.

api/APInvoiceEntry/Query (POST)

Queries existing AP Invoices using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found AP Invoices.

APCheckUpdate

APIDescription
api/APCheckUpdate/Run (POST)

Runs AP Check Update using the supplied run data.
HTTP Method: POST
Required Fields: (None)
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the Updated AP Checks.

ARInvoiceEntry

APIDescription
api/ARInvoiceEntry/Create (POST)

Creates a new AR Invoice Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields:
ARInvoiceEntry: INVOICE_TYPE
ARInvoiceEntryDetail: INV_LINE_TYPE
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created AR Invoice Entry Transaction.

api/ARInvoiceEntry/InvoiceAll (POST)

Creates multiple AR Invoice Entry Transactions using the supplied Auto Invoice criteria.
HTTP Method: POST
Required Fields:
ARInvoiceEntry: INVOICE_TYPE
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created AR Invoice Entry Transactions.

api/ARInvoiceEntry/Query (POST)

Queries existing AR Invoices using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found AR Invoices.

ARRemittanceEntry

APIDescription
api/ARRemittanceEntry/Create (POST)

Creates a new AR Remittance Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields:
ARRemittanceEntry: CHECK_CUST, CHECK_ID
ARRemittanceEntryPayment: INVOICE_NUMBER, AMOUNT_PAID
ARRemittanceEntryCreditMemo: INVOICE_NUMBER, INVOICE_LN_AMT
ARRemittanceEntryDebitMemo: INVOICE_NUMBER, INVOICE_LN_AMT
ARRemittanceEntryMiscCash: DEPARTMENT, ACCOUNT, AMOUNT
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created AR Remittance Entry Transaction.

IssuesEntry

APIDescription
api/IssuesEntry/Create (POST)

Creates a new Issues Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields: PART_ID, DEPARTMENT, ACCOUNT, QUANTITY
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Issues Entry Transaction.

AdjustmentsEntry

APIDescription
api/AdjustmentsEntry/Create (POST)

Creates a new Adjustments Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields: PART_ID, STORES_CODE, QUANTITY
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Adjustments Entry Transaction.

PhysicalCountEntry

APIDescription
api/PhysicalCountEntry/Create (POST)

Creates Physical Count Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields:
PhysicalCountEntry: WORKSHEET_DATE, STORES_CODE
PhysicalCountEntryDetail: PART_ID, STOCK_LOCATION, PHYSICAL_QTY
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the Physical Count Entry Transaction.

StoresTransfer

APIDescription
api/StoresTransfer/Create (POST)

Creates a new Stores Transfer Transaction using the supplied creation data.
HTTP Method: POST
Required Fields: PART_ID, FROM_STORES, TO_STORES, QUANTITY
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Stores Transfer Transaction.

StockStatus

APIDescription
api/StockStatus/Create (POST)

Creates a new Stock Status using the supplied creation data.
HTTP Method: POST
Required Fields: STORES_CODE, PART_ID, STOCK_LOCATION
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Stock Status.

api/StockStatus/Update (POST)

Updates an existing Stock Status using the supplied update data.
HTTP Method: POST
Required Fields: STORES_CODE, PART_ID to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Stock Status.

api/StockStatus/Delete (POST)

Deletes an existing Stock Status using the supplied keys.
HTTP Method: POST
Required Fields: STORES_CODE, PART_ID to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/StockStatus/Query (POST)

Queries existing Stock Statuses using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Stock Statuses.

MultipleLocation

APIDescription
api/MultipleLocation/Create (POST)

Creates a new Multiple Location using the supplied creation data.
HTTP Method: POST
Required Fields: STORES_CODE, PART_ID, STOCK_LOCATION
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Multiple Location.

api/MultipleLocation/Update (POST)

Updates an existing Multiple Location using the supplied update data.
HTTP Method: POST
Required Fields: STORES_CODE, PART_ID, STOCK_LOCATION to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Multiple Location.

api/MultipleLocation/Delete (POST)

Deletes an existing Multiple Location using the supplied keys.
HTTP Method: POST
Required Fields: STORES_CODE, PART_ID, STOCK_LOCATION to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/MultipleLocation/Query (POST)

Queries existing Multiple Locations using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Multiple Locations.

WIPCompletionsEntry

APIDescription
api/WIPCompletionsEntry/Create (POST)

Creates a new WIP Completions Entry Transaction using the supplied creation data.
HTTP Method: POST
Required Fields: JOB_ID
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created WIP Completions Entry Transaction.

api/WIPCompletionsEntry/CreateAndBackflush (POST)

Creates a new WIP Completions Entry Transaction and Kit Issue Backflush Transaction using the supplied creation data.
HTTP Method: POST
Required Fields: JOB_ID
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created WIP Completions Entry Transaction and any transacted Kit Issue Backflush Components.

This API call can automatically perform a Kit Issue Backflush transaction in conjunction with a WIP Completions transaction. To do this the WIP Completions transaction must refer to a Task where a Kit Issue Backflush is possible.

It is not strictly necessary to include the WIPCompletionsEntryBackflushComponent array in the request JSON. However, this array should be used if it is necessary to specify a LOT_ID, STOCK_LOCATION or SERIAL_NUMBER for any of the Backflush Components. It is only necessary to list the Backflush Components for which you need to specify any of these items. All eligible Components will be included in the Kit Issue Backflush transaction automatically.

This API call uses the Kit/Shortage Issue program (ICTKI) to perform the Kit Issue Backflush. Therefore, the API user must have Run Permission for ICTKI in order to perform a Kit Issue Backflush in conjunction with this API call.

If there is any error in the WIP Completions transaction or the Kit Issue Backflush transaction, then neither transaction will be committed to the database. There is no error if the Task referred to in the WIP Completions transaction is not capable of a Kit Issue Backflush.

All transacted Kit Issue Backflush Components are listed in the WIPCompletionsEntryBackflushComponent array in the response JSON.

BackflushKitIssue

APIDescription
api/BackflushKitIssue/Create (POST)

Creates a new Backflush Kit Issue Transaction using the supplied creation data.
HTTP Method: POST
Required Fields: ASSEMBLY_ID, DEPARTMENT, ACCOUNT
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Backflush Kit Issue Transaction.

It is not strictly necessary to include the BackflushKitIssueComponent array in the request JSON. However, this array should be used if it is necessary to specify a LOT_ID, STOCK_LOCATION or SERIAL_NUMBER for any of the Components. It is only necessary to list the Components for which you need to specify any of these items. All eligible Components will be included in the transaction automatically.

All transacted Components are listed in the BackflushKitIssueComponent array in the response JSON.

Part

APIDescription
api/Part/Create (POST)

Creates a new Part using the supplied creation data.
HTTP Method: POST
Required Fields: PART_ID, PART_DESC
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Part.

api/Part/Update (POST)

Updates an existing Part using the supplied update data.
HTTP Method: POST
Required Fields: PART_ID to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Part.

api/Part/Delete (POST)

Deletes an existing Part using the supplied keys.
HTTP Method: POST
Required Fields: PART_ID to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/Part/Query (POST)

Queries existing Parts using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Parts.

BillOfMaterial

APIDescription
api/BillOfMaterial/Create (POST)

Creates a new Bill of Material Component using the supplied creation data.
HTTP Method: POST
Required Fields: ASSEMBLY_ID, COMPONENT_ID, DWG_ITEM_CODE
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Bill of Material Component.

api/BillOfMaterial/Update (POST)

Updates an existing Bill of Material Component using the supplied update data.
HTTP Method: POST
Required Fields: ASSEMBLY_ID, COMPONENT_ID, DWG_ITEM_CODE to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Bill of Material Component.

api/BillOfMaterial/Delete (POST)

Deletes an existing Bill of Material Component using the supplied keys.
HTTP Method: POST
Required Fields: ASSEMBLY_ID, COMPONENT_ID, DWG_ITEM_CODE to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/BillOfMaterial/Query (POST)

Queries existing Bill of Material Components using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Bill of Material Components.

SerialNumberCrossReference

APIDescription
api/SerialNumberCrossReference/Create (POST)

Creates a new Serial Number Cross Reference using the supplied creation data.
HTTP Method: POST
Required Fields: ASSEMBLY_ID, ASSEMBLY_SN, COMPONENT_ID, COMPONENT_SN
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Serial Number Cross Reference.

api/SerialNumberCrossReference/Update (POST)

Updates an existing Serial Number Cross Reference using the supplied update data.
HTTP Method: POST
Required Fields: ASSEMBLY_ID, ASSEMBLY_SN, COMPONENT_ID, COMPONENT_SN to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Serial Number Cross Reference.

api/SerialNumberCrossReference/Delete (POST)

Deletes an existing Serial Number Cross Reference using the supplied keys.
HTTP Method: POST
Required Fields: ASSEMBLY_ID, ASSEMBLY_SN, COMPONENT_ID, COMPONENT_SN to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/SerialNumberCrossReference/Query (POST)

Queries existing Serial Number Cross Reference using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Serial Number Cross References.

VendorPart

APIDescription
api/VendorPart/Create (POST)

Creates a new Vendor Part using the supplied creation data.
HTTP Method: POST
Required Fields: PART_ID, VENDOR_ID, VENDOR_PART_ID
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created Vendor Part.

api/VendorPart/Update (POST)

Updates an existing Vendor Part using the supplied update data.
HTTP Method: POST
Required Fields: PART_ID, VENDOR_ID, VENDOR_PART_ID to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated Vendor Part.

api/VendorPart/Delete (POST)

Deletes an existing Vendor Part using the supplied keys.
HTTP Method: POST
Required Fields: PART_ID, VENDOR_ID, VENDOR_PART_ID to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/VendorPart/Query (POST)

Queries existing Vendors Parts using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Vendor Parts.

GLAccount

APIDescription
api/GLAccount/Create (POST)

Creates a new GL Account using the supplied creation data.
HTTP Method: POST
Required Fields: COMPANY_ID, DEPARTMENT, ACCOUNT, ACCOUNT_DESC
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created GL Account.

api/GLAccount/Update (POST)

Updates an existing GL Account using the supplied update data.
HTTP Method: POST
Required Fields: COMPANY_ID, DEPARTMENT, ACCOUNT to locate the record and at least one other field to update
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the updated GL Account.

api/GLAccount/Delete (POST)

Deletes an existing GL Account using the supplied keys.
HTTP Method: POST
Required Fields: COMPANY_ID, DEPARTMENT, ACCOUNT to locate the record
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns nothing.

api/GLAccount/Query (POST)

Queries existing GL Accounts using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found GL Accounts.