This is information about the API endpoint exposed at http://localhost:8093 to provide access to our ERP system from Intact Software, Intact iQ This is a REST api with a variety of services and is secured using an API key that you should request from us Currently the API gives access to the following services...
| Service Name | Description |
|---|---|
| Customers | This service provides access to customer account information. The customer has two collections for contacts. The Contacts list is typically used for CRM activity and the Delivery Contacts used to populate delivery contact information on sales orders. |
| Currencies | Used to retrieve the list of currencies available for use when creating transactions. |
| SalesReps | Used to retireve the list of valid sales reps |
| Countries | Used to retrieve a list of the countries that can be used in posting transactions. |
| TaxRates | Used to retreive a valid list of tax rates |
| Products | Used to retrieve product information |
| KitSetup | |
| ProductCategories | Used to get lists of product categories. Categories belong to groups and groups belong to classes. Each one has its own service to retrieve valid lists. |
| ProductGroups | Used to get lists of product groups the contain product categories. |
| ProductClass | Used to get list of valida product classes to which product groups belong. |
| Barcodes | Product Barcodes |
| UnitsOfMeasure | Used to retrieve lists of units of measure that can be used in properties like product selling units. |
| ProductWorkflowStates | Used to get lists of valid product workflow states |
| DeliveryAgents | Used to get a list of the valid delivery agents and their associated services |
| SalesOrderTypes | Used to get a list of the valid sales order types |
| SalesPickingNotes | Sales Picking Note |
| Supplier | This service provides access to Supplier account information. The customer has two collections for contacts. The Contacts list is typically used for CRM activity and the Delivery Contacts used to populate delivery contact information on sales orders. |
| StockBins | Used to get a list of valid stock bins |
| ProductStockLevels | Product Stock Bin Stock Levels |
| ShippingLists | Purchase Shipping Lists |
| PurchaseOrders | Used to create, update and list purchase orders. |
| PurchaseRequisitions | Used to create, update and list purchase requisitions. |
| Documents | This service allows you to retrieve the printed version of objects from the system e.g. copy order or invoice printouts. |
| Branches | Used to get lists of valid branches for use in posting transactions. |
| SalesInvoice | Used to create, update and list sales invoice. When creating sales invoice that have been paid you can populate the receipts collection with payment information. |
| SalesOrderWorkflowStates | Used to get a list of valid workflow states for sales orders |
| ReceiptTypes | Used to get a list of valid receipt types. |
| CashCustomers | Cash customer accounts are used when a single account is used to process orders for cash sales but you need to record details about the account without setting up a new customer for each transaction. This service is used to list and create cash customer accounts for used on orders. |
| SalesPickingNoteResponse | Import Sales Picking Notes to Deliver Picking notes |
| ShippingListResponse | Importing Shipping List Response to Delivery existing Shipping lists |
| StockAdjustment | Service used to perform stock adjustments in IQ |
| StockAdjReason | List of Stock Adjustment reasons |
| IBTRequestResponse | Progresses IBT request to the delivery note |
| PurchaseDeliveryNote | Used to Book in POs |
| PurchaseCreditRequest | Purchase Credit Request |
| PDNONLY | Used to Book in goods with no Purchase Order |
| IBTDeliveryNote | |
| ProductBinLocation | HQWMS Bin Location |
The following commands are optionally available on each service...
| Command | Purpose |
|---|---|
| GET | Fetch one or more objects |
| POST | Create one or more new objects |
| PUT | Update an existing object |
| DELETE | Delete an existing object |
| SEARCH (POST) | While not a command in its own right the serach function allows you to POST a complex query to our system in order to return a list of objects. This is used when the simpler query string based filters do not suffice |