Web Services APIs
Expandable’s RESTful Web Services APIs support integration to external applications that require creation of system validated records to query the Expandable database records and create ERP system transactions.
Functional areas include:
Expandable’s Web Services are built on the latest industry RESTful standard with the JSON data exchange that is taking hold as a best practices technology for interfacing applications. RESTful service with the universal JSON data structure simplifies development by offering ease of machine/application parsing and support for maximizing application programming language independence.
The APIs are developed for ease of use and flexibility, with dynamic data structures and a solid front end service that allows for separation of the application interface from the back end business logic protecting your investment in applications developed to generate revenue or reduce manual data entry.
Software Development Kit
Expandable Web Services are deployed with a software development kit (SDK) that includes on-line developer documentation, requirements, accepted JSON data parameters, response details, and error codes. A validation test utility for each service allows the testing and validation of installation and serve as a development tool to test JSON data structures complete with return error codes and return data results.
RESTful Web Services allow simple HTTP/HTTPS client/server service requests to underlying Expandable business logic for valid record insertion/update and record query filtering.
Language-Independent JSON
Application Programming Language Independence supports C, C++, C#, Java, JavaScript, Perl, Python and other languages providing a wide set of programming platform options to the application designer.
Standard JSON name/value pair data structures (typical: object constructs, array constructs, etc.) for application data exchanges allow the designer to leverage industry standard off-the-shelf parsers compatible with the designers coding language.
Security
The APIs include Business Logic Security Services for application session login/logout and session controls for secure data exchange to and from the web services while maintaining the administrator’s control over ERP access.
Data Query
Flexible and powerful data query with same filtering capabilities of Expandable’s proprietary core ERP Query by Example (QBE): “IN”, “BETWEEN”, “=”, “<>”, “<”, “>”, “<=”, “>=”, etc. as an integral part of the JSON data value passed as a filter definition.
REQUIREMENTS
SYSTEM REQUIREMENTS
- Expandable ERP Release 9.3.0 and forward with appropriate Web Service BLS Feature Key Licensed
- Microsoft Windows OS 7, 8, 8.1 or Microsoft Windows Server 2008, 2008R2, 2012, 2012R2
- Microsoft IIS 7.0 or later
- Microsoft .NET Framework 4.5
Installation provides full on-line SDK documentation with unit test utilities for each service
SALES and SERVICE APIs
SALES APIs
The SALES APIs provide access to Expandable’s Customer Master, Sales Order, Customer Part, Credit Card, Customer Contact, Shipments Entry and Product Price business logic and records so that the system can accept orders and payments placed through external applications from new customers, existing customers and customers with updated account and/or contact information.
SALES APIs
| CUSTOMER API | |
|---|---|
| api/Customer/Create (POST): | Creates a new Customer using the supplied creation data. |
| api/Customer/Update (POST): | Updates an existing Customer using the supplied update. |
| api/Customer/Query (POST): | Queries existing Customers using the provided query data defining the filtering of returned customer records. |
| SALES ORDER API | |
| api/SalesOrder/Create (POST): | Creates a new Sales Order using the supplied creation data. |
| api/SalesOrder/Update (POST): | Updates an existing Sales Order using the supplied update data. |
| api/SalesOrder/Query (POST): | Queries existing Sales Orders using the provided query data defining the filtering of returned order records. |
| CUSTOMER PART API | |
| api/CustomerPart/Create (POST): | Creates a new Customer Part using the supplied creation data. |
| api/CustomerPart/Update (POST): | Updates an existing Customer Part using the supplied update data. |
| api/CustomerPart/Query (POST): | Queries existing Customers Parts using the provided query data defining the filtering of returned part records. |
| CREDIT CARD API | |
| api/CreditCard/Create (POST): | Creates a new Credit Card using the supplied creation data. |
| api/CreditCard/Update (POST): | Updates an existing Credit Card using the supplied update data. |
| api/CreditCard/Query (POST): | Queries existing Credit Card using the provided query data defining the filtering of returned card records. |
| CUSTOMER CONTACT API | |
| api/CustomerContact/Create (POST): | Creates a new Customer Contact using the supplied creation data. |
| api/CustomerContact/Update (POST): | Updates an existing Customer Contact using the supplied update data. |
| api/CustomerContact/Query (POST): | Queries existing Customer Contact using the provided query data defining the filtering of returned records. |
| SHIPMENTS ENTRY API | |
| api/ShipmentsEntry/Create (POST): | Creates a new Shipments Entry Transaction using the supplied creation data. |
| PRODUCT PRICE API | |
| api/ProductPrice/Create (POST): | Creates a new Product Price using the supplied creation data. |
| api/ProductPrice/Update (POST): | Updates an existing Product Price using the supplied update data. |
| api/ProductPrice/Query (POST): | Queries existing Product Prices using the provided query data. |
| SERIAL NUMBER API | |
| api/SerialNumber/Create (POST): | Creates a new Serial Number using the supplied creation data. |
| api/SerialNumber/Update (POST): | Updates an existing Serial Number using the supplied update data. |
| api/SerialNumber/Query (POST): | Queries existing Serial Numbers using the provided query data. |
OPERATIONS APIs
OPERATIONS APIs
The OPERATIONS APIs provide access to Expandable’s inventory, production, materials, jobs and lot control business logic and transactions so that Expandable users can create transactions from warehouse management, kanban or other external supply chain management applications.
INVENTORY APIs
| ISSUES ENTRY API | |
|---|---|
| api/IssuesEntry/Create (POST): | Creates a new Issues Entry Transaction using the supplied creation data. | ADJUSTMENTS ENTRY API |
| api/AdjustmentsEntry/Create (POST): | Creates a new Adjustments Entry Transaction using the supplied creation data. |
| PHYSICAL COUNT ENTRY API | |
| api/PhysicalCountEntry/Create (POST): | Creates Physical Count Entry Transaction using the supplied creation data. |
| STORES TRANSFER API | |
| api/StoresTransfer/Create (POST): | Creates a new Stores Transfer Transaction using the supplied creation data. |
| STOCK STATUS API | |
| api/StockStatus/Create (POST): | Creates a new Stock Status using the supplied creation data. |
| PART API | |
| api/Part/Create (POST): | Creates a new Stores Transfer Transaction using the supplied creation data. |
| api/Part/Update (POST): | Updates an existing Part using the supplied update data. |
| api/Part/Query (POST): | Queries existing Parts using the provided query data. |
JOB CONTROL APIs
| WIP COMPLETIONS ENTRY API | |
|---|---|
| api/WIPCompletionsEntry/Create (POST): | Creates a new WIP Completions Entry Transaction using the supplied creation data. |
| SERIAL NUMBER CROSS REFERENCE API | |
| api/SerialNumberCrossReference/Create (POST): | Creates a new Serial Number Cross Reference using the supplied creation data. |
| api/SerialNumberCrossReference/Update (POST): | Updates an existing Serial Number Cross Reference using the supplied update data. |
| api/SerialNumberCrossReference/Query (POST): | Queries existing Serial Number Cross Reference using the provided query data. |
LOT CONTROL APIs
| LOT CONTROL API | |
|---|---|
| api/Lot/Create (POST): | Creates a new Lot using the supplied creation data. |
| api/Lot/Update (POST): | Updates an existing Lot using the supplied update data. |
| api/Lot/Query (POST): | Queries existing Lots using the provided query data. |
MULTIPLE LOCATIONS APIs
| MULTIPLE LOCATION ENTRY API | |
|---|---|
| api/MultipleLocation/Create (POST): | Creates a new Multiple Location using the supplied creation data. |
| api/MultipleLocation/Update (POST): | Updates an existing Multiple Location using the supplied update data. |
| api/MultipleLocation/Query (POST): | Queries existing Multiple Locations using the provided query data. |
PRODUCTION DATA APIs
| BILL OF MATERIAL API | |
|---|---|
| api/BillOfMaterial/Create (POST): | Creates a new Bill of Material Component using the supplied creation data. |
| api/BillOfMaterial/Update (POST): | Updates an existing Bill of Material Component using the supplied update data. |
| api/BillOfMaterial/Query (POST): | Queries existing Bill of Material Components using the provided query data defining the filtering of returned BOM records. |
PURCHASE ORDER APIs
| VENDOR API | |
|---|---|
| api/Vendor/Create (POST): | Creates a new Vendor using the supplied creation data. |
| api/Vendor/Update (POST): | Updates an existing Vendor using the supplied update. |
| api/Vendor/Query (POST): | Queries existing Vendor using the provided query data defining the filtering of returned vendor records. |
| VENDOR CONTACT API | |
| api/VendorContact/Create (POST): | Creates a new Vendor Contact using the supplied creation data. |
| api/VendorContact/Update (POST): | Updates an existing Vendor Contact using the supplied update data. |
| api/VendorContact/Query (POST): | Queries existing Vendor Contacts using the provided query data defining the filtering of returned vendor contact records. |
| VENDOR PART API | |
| api/VendorPart/Create (POST): | Creates a new Vendor Part using the supplied creation data. |
| api/VendorPart/Update (POST): | Updates an existing Vendor Part using the supplied update data. |
| api/VendorPart/Query (POST): | Queries existing Vendor Parts using the provided query data defining the filtering of returned part records. |
| PURCHASE ORDER API | |
| api/PurchaseOrder/Create (POST): | Creates a new Purchase Order using the supplied creation data. |
| api/PurchaseOrder/Update (POST): | Updates an existing Purchase Order using the supplied update data. |
| api/PurchaseOrder/Query (POST): | Queries existing Purchase Orders using the provided query data defining the filtering of returned purchase order records. |
| PO RECEIPTS ENTRY API | |
| api/POReceiptsEntry/Create (POST): | Creates a new PO Receipts Entry Transaction using the supplied creation data. |
ACCOUNTING APIs
ACCOUNTING APIs
The ACCOUNTING APIs provide access to Expandable’s AP Vouchering business logic and transaction creation so that Expandable users can interface directly to vendor or expense management applications for non-PO invoicing and AP vouchering to allow the Expandable AP function to make payment of those supplier or employee expenses.
ACCOUNTING APIs
| AP INVOICE ENTRY API | |
|---|---|
| api/APInvoiceEntry/Create (POST): | Creates a new AP Invoice Entry Transaction using the supplied creation data. |
| AP CHECK UPDATE API | |
| api/APCheckUpdate/Run (POST): | Runs AP Check Update using the supplied run data. |
| AR INVOICE ENTRY API | |
| api/ARInvoiceEntry/Create (POST): | Creates multiple AR Invoice Entry Transactions using the supplied Auto Invoice criteria. |
| api/ARInvoiceEntry/Invoice All (POST): | Creates a new AR Invoice Entry Transaction using the supplied creation data. |
| api/ARInvoiceEntry/Query (POST): | Queries existing AR Invoices using the provided query data. |
| AR REMITTANCE ENTRY API | |
| api/ARRemittanceEntry/Create (POST): | Creates a new AR Remittance Entry Transaction using the supplied creation data. |
| GL ACCOUNT API | |
| api/GLAccount/Create (POST): | Creates a new GL Account using the supplied creation data. |
| api/GLAccount/Update (POST): | Updates an existing GL Account using the supplied update data. |
| api/GLAccount/Query (POST): | Queries existing GL Accounts using the provided query data. |
SYSTEM APIs
| SYSTEM APIs | |
|---|---|
| Version, Get: | Returns the API Version. |
| Auth Token, Get: | Authenticates the supplied Expandable credentials and returns an Authentication Token. |
| Server Time, Get: | Returns the current Server Time. |