This is information about the API endpoint exposed at http://localhost:8096/ to provide access to our ERP system from GenetiQ Software, GenetiQ 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 |
|---|---|
| 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 |
| 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. |
| 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 |
| SalesOrderWorkflowStates | Used to get a list of valid workflow states for sales orders |
| SalesOrders | Used to create, update and list sales orders. When creating sales orders that have been paid you can populate the receipts collection with payment information. |
| 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. |
| Branches | Used to get lists of valid branches for use in posting transactions. |
| SalesOrderTypes | Used to get a list of the valid sales order types |
| DeliveryAgents | Used to get a list of the valid delivery agents and their associated services |
| CostCentres | Used to get lists of valid general ledger cost centres |
| StockBins | Used to get a list of valid stock bins |
| SalesQuotationWorkflowStates | Used to get a list of valid workflow states for sales quotations |
| SalesQuotations | Used to create, update and list sales quotations. |
| SalesLedgerEntries | Used to get lists of sales ledger entries for a customer account. The makeup of a customer account statement. |
| SalesDeliveryNotes | Used to view lists of sales delivery notes. |
| SalesInvoices | Used to view lists of sales invoices. |
| SalesCreditNotes | Used to view lists of sales credit notes. |
| CustomerPricing | This service allows you to retrieve customer specific pricing for products. |
| Documents | This service allows you to retrieve the printed version of objects from the system e.g. copy order or invoice printouts. |
| OneOffBuild | Used to create, update and list Christmas One Off Product Builds. This object will increase the Package Quantity in Stock, Reduce the component stock, take the costs of the components and total them to the Package cost. This package cost will then be associated with the relevant sales order line based on the one off Product code |
| FinishedProduct | Used to retrieve product information |
| Suppliers | Supplier read access (GET only) for Eagle vendor-master mapping comparison — added by CLC 2026-07-07 |
| TrussDesigner | This is a custom table that has been created to allow the drop down list of designers. GenetiQ should be the owner and then pull into forge |
| Customers | Used to retrieve customer information |
| IBTRequests | Forge: inter-branch stock transfer request (Harriman 10 -> Truss 30) on pick-list completion. Added by CLC 2026-09-08 (Tee) for the Forge picking integration. |
| IBTDeliveryNotes | Forge: despatch/receipt leg of the Harriman -> Truss lumber transfer (reads back what GenetiQ delivered and received per IBT request). Added by CLC 2026-09-08 (Tee). |
| SpecialProducts | Special-order (ZZ) products minted from the SO-* templates for the Forge special-order push. GenetiQ auto-codes; callers never send Code. |
| IBTDirectDeliveryNotes | Forge: Harriman (10) to Truss (30) one-step stock transfer per picked lumber pick list. Spec 2026-09-13. |
| PurchaseOrders | Purchase orders for Forge: match acknowledgements to POs and create POs from them (read, search, create; update later) |
| ExternalDocumentLinks | Document links (URL pointers) attached to transactions, e.g. Forge vendor documents on Purchase Orders. Read, search, create. Added 2026-09-16. |
| PurchaseDeliveryNotes | Goods received notes (purchase delivery notes). Read and search only, for Forge to show receipts against special-order purchase orders. Added 2026-09-16. |
| PurchaseOrderWorkflowStates | Purchase order workflow states (Code, Description). Read and search only. Added 2026-09-16. |
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 |