NextProcess Web API Help Page
Introduction
The Following NextProcess APIs are available.
Requisition
Procurement Requisition APIs
| API | Description |
|---|---|
| GET api/Requisition/DocId/{docId} | Get Requisition by Document ID |
| POST api/Requisition/Ack | Acknowledge Requisition |
ItemCatalogFmt1
Item Catalog, custom format 1. Add, update, delete or bulk update item catalog records.
| API | Description |
|---|---|
| GET api/ItemCatalogFmt1/bulkdownload/{clientId} | Get All Catalog Items by client |
| POST api/ItemCatalogFmt1/Add | Add Catalog Item |
| POST api/ItemCatalogFmt1/BulkAdd | Add/Update Catalog Bulk Item Load |
| POST api/ItemCatalogFmt1/Update | Update Catalog Item |
| DELETE api/ItemCatalogFmt1/Delete | Add Catalog Item |
PaymentSetup
Payment setup options for Wire, ACH and check payment
| API | Description |
|---|---|
| GET api/PaymentSetup/GetAllWireConfig/{clientId}/{companyCode} | Get all wire configurations for company |
| GET api/PaymentSetup/GetAllWireConfig/{clientId} | Get all wire configurations for client |
| POST api/PaymentSetup/WireAddUpdate | Add/Update Wire Configuration |
| GET api/PaymentSetup/GetAllACHConfig/{clientId} | Get all ACH configs for client |
| GET api/PaymentSetup/GetAllACHConfig/{clientId}/{companyCode} | Get all ACH configs for company |
| POST api/PaymentSetup/ACHAddUpdate | Add/Update ACH Configuration |
| GET api/PaymentSetup/GetAllCheckConfig/{clientId}/{companyCode} | Get all Check configs for company |
| GET api/PaymentSetup/GetAllCheckConfig/{clientId} | Get all Check configs for company |
| POST api/PaymentSetup/CheckAddUpdate | Add/Update Check Configuration |
Users
User Controller
| API | Description |
|---|---|
| GET api/Users/{username}/{password} | Authenticate |
Receiver
Purchase Order Receiver APIs
| API | Description |
|---|---|
| GET api/Receiver/DocId/{docId} | Get Receiver by Document ID |
| GET api/Receiver/Guid/{guid} | Get Receiver by Document Guid |
| GET api/Receiver/ByPO/{poNumber} | Get Receivers by PO Number |
| GET api/Receiver/ByInvoiceDocId/{invoiceDocId} | Get receivers associated with an invoice Document ID. If there are no receivers associatd with the provided invoice document ID an empty receiver list will be returned. |
| POST api/Receiver/Ack | Acknowledge Receiver |
Invoice
Invoice APIs – Retrieve details for a specific invoice, retrieve all invoices that are ready to pay and acknowlege invoices that have been successfully imported to your ERP system.
| API | Description |
|---|---|
| GET api/Invoice/DocId/{docId} | Get Invoice by Document ID |
| GET api/Invoice/Guid/{invoiceGuid} | Get Invoice by Document Guid |
| GET api/Invoice/ReadyToPay/{clientId} | Export invoices that are ready to pay for a client. Invoices retrieved from this will be set to a status of “Exported”, meaning exported and awaiting an acknowledgement. |
| GET api/Invoice/ReadyToPay/{clientId}/{companyCode} | Export invoices that are ready to pay for a client/company combination. Invoices retrieved from this will be set to a status of “Exported”, meaning exported and awaiting an acknowledgement. |
| POST api/Invoice/Post | Post invoice to System |
| POST api/Invoice/Ack | Invoice acknowledgement |
| POST api/InvoiceCR/Ack | Invoice OR Check Reqeust acknowledgement |
Project
Project APIs
| API | Description |
|---|---|
| GET api/Project/DocId/{docId} | Get Project by Document ID |
| GET api/Project/Guid/{guid} | Get Project by Guid |
| POST api/Project/Ack | Project acknowledgement |
Payment
Payments – Mark documents as paid and provide the details about the paymennts to keep the vendors informed.
| API | Description |
|---|---|
| POST api/Payment | Record payments |
| GET api/disbursement/getpayments/{clientId}/{companyCode}/{fromDate}/{toDate} | Get ACH, Wire and Check payment information for date range by company |
| GET api/disbursement/getpayments/{clientId}/{fromDate}/{toDate} | Get ACH, Wire and Check payment information for date range |
PurchaseOrder
Procurement Purchase Order APIs
| API | Description |
|---|---|
| GET api/PurchaseOrder/DocId/{docId} | Get Purchase Order by Document ID |
| GET api/PurchaseOrder/{poNumber} | Get Purchase Order by PO Number |
| GET api/PurchaseOrder/InvoiceDocId/{invoiceDocId} | Get Purchase Order by Invoice Document ID. If there is no Purchase Order linked to the invoice document ID an empty purchase order will be returned. |
| POST api/PurchaseOrder/Ack | Purchase Order acknowledgement |
CheckRequest
Check Request APIs
| API | Description |
|---|---|
| GET api/CheckRequest/DocId/{docId} | Get Check Request by Document ID |
| GET api/CheckRequest/Guid/{docGuid} | Get Check Request by Document Guid |
| GET api/CheckRequest/ReadyToPay/{clientId} | Get ready to pay check requests by client id |
| GET api/CheckRequest/ReadyToPay/{clientId}/{companyCode} | Get ready to pay check requests by client ID and company code |
| POST api/CheckRequest/Ack | Check Request acknowledgement |
Vendor
Vendor APIs – Add, update delete or bulk load vendors.
| API | Description |
|---|---|
| GET api/Vendor/BulkDownload/{clientId} | Get All Vendors by client |
| GET api/Vendor/BulkDownload/{clientId}/{companyCode} | Get All Vendors by client and company |
| GET api/Vendor/{clientId}/{vendorNumber} | Get Vendor |
| GET api/Vendor/{clientId}/{companyCode}/{vendorNumber} | Get Vendor |
| POST api/Vendor/Add | Add Vendor. If the vendor does not pass the validation rules the error message will contain the vendor code and a list of errors for that vendor code. |
| POST api/Vendor/Update | Update Vendor. If the vendor does not pass the validation rules the error message will contain the vendor code and a list of errors for that vendor code. |
| DELETE api/Vendor/Delete | Delete Vendor |
| POST api/Vendor/BulkAdd | Bulk Add Vendors. If a vendor does not pass the validation rules the error message will contain the vendor code and a list of errors for that vendor code. If a vendor is already in the system it will not be loaded and be reported back as a duplicate. |
ListMaintenance
List Maintenance – Add, Update, Delete or bulk update lists to include routing matrices and specializeds lists used by the system.
Please refere to your impplementation guide for the appropriate List Type and what values to include for each list type.
| API | Description |
|---|---|
| POST api/ListMaintenance/Add | Add list item |
| POST api/ListMaintenance/BulkAdd | Clear existing list items and replace with new list |
| GET api/ListMaintenance/ListDefinitions | Get full list of list definitions including routes and special lists |
| GET api/ListMaintenance/GetList/{listReferenceId} | Get full list details for specified list Id |
| POST api/ListMaintenance/Delete/{itemId} | Delete list item |
GLCode
GL Code APIs
| API | Description |
|---|---|
| GET api/GLCode/BulkDownload/{clientId} | Get All GL Codes by client |
| GET api/GLCode/bulkdownload/{clientId}/{companyCode} | Get All GL Codes by client and company |
| POST api/GLCode/Add | Add GL Code |
| POST api/GLCode/BulkAdd | Bulk Add GL Codes – purge system of existing GL Codes and replace with new GL Codes |
CheckPrint
Check Print APIs
| API | Description |
|---|---|
| POST api/CheckPrint | Check Payment: Post check payment information to be printed or to update the payment information for documents in the system. |