This is information about the API endpoint exposed at http://localhost:8097/ 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 |
|---|---|
| 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. |
| SalesReps | Used to retireve the list of valid sales reps |
| 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. |
| 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 |
| 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. |
| Supplier | Supplier Details |
| PurchaseOrder | |
| PurchaseOrderWorkflowStatus | |
| PurchaseInvoices | |
| PurchaseCreditNotes | |
| PurchaseDeliveryNotes |
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 |