NextProcess Web API Help Page

Capital Projects

Project

Get projects and associated purchase orders and invoices. Acknowledge projects that have been exported.

Hide/Show
APIDescription
GET api/Project/DocId/{docId}

Get Project by Document ID

GET api/Project/Guid/{guid}

Get Project by Guid

GET api/Project/PurchaseOrders/{docId}

Get full Purchase Order details for Project Document ID

GET api/Project/Invoices/{docId}

Get full Invoice details for Project Document ID

POST api/Project/Ack

Project acknowledgement

Procurement

Requisition

Get requisitions and acknowledge requisitions that have been exported to the ERP system.

Hide/Show
APIDescription
GET api/Requisition/DocId/{docId}

Get Requisition by Document Id

POST api/Requisition/Ack

Acknowledge Requisition

Receiver

Get Receivers and acknowledge receivers exported to the ERP system.

Hide/Show
APIDescription
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 all receivers for a PO Number

GET api/Receiver/ByInvoiceDocId/{invoiceDocId}

Get receivers associated with an invoice Document ID. If there are no receivers associated with the provided invoice document ID, an empty receiver list will be returned.

POST api/Receiver/Ack

Acknowledge Receiver

PurchaseOrder

Procurement Purchase Order APIs

Hide/Show
APIDescription
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

GET api/PurchaseOrder/Status

Get a list of available statuses.

POST api/PurchaseOrder/Create

Creates a Purchase Order

Order

Get or create order forms.

Hide/Show
APIDescription
GET api/Order/DocId/{docId}

Get Order Form by Order Form Id

GET api/Order/Guid/{guid}

Get Order Form by Order Form Guid

POST api/Order/Create

Create Order Form

AP Automation

Invoice

Invoice APIs - Retrieve details for a specific invoice, retrieve all invoices that are ready to pay and acknowledge invoices that have been successfully imported to your ERP system.

Hide/Show
APIDescription
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 Request acknowledgement

CheckRequest

Retrieve details for a specific check request, retrieve all check request that are ready to pay and acknowledge check request that have been successfully imported to your ERP system.

Hide/Show
APIDescription
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.

Hide/Show
APIDescription
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.

POST 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.

GLCode

Manage GL codes in the system.

Hide/Show
APIDescription
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 the system of existing GL Codes and replace them with new GL Codes.

Disbursements

PaymentSetup

Payment setup options for Wire, ACH and check payment

Hide/Show
APIDescription
GET api/PaymentSetup/GetAllWireConfig/{clientId}/{companyCode}

Get all wire configurations for the company.

GET api/PaymentSetup/GetAllWireConfig/{clientId}

Get all wire configurations for a client.

POST api/PaymentSetup/WireAddUpdate

Add/Update Wire Configuration.

GET api/PaymentSetup/GetAllACHConfig/{clientId}

Get all ACH configs for the client

GET api/PaymentSetup/GetAllACHConfig/{clientId}/{companyCode}

Get all ACH configs for a company

POST api/PaymentSetup/ACHAddUpdate

Add/Update ACH Configuration

GET api/PaymentSetup/GetAllCheckConfig/{clientId}/{companyCode}

Get all Check configs for a company.

GET api/PaymentSetup/GetAllCheckConfig/{clientId}

Get all Check configs for the client.

POST api/PaymentSetup/CheckAddUpdate

Add/Update Check Configuration.

Payment

Payments - Mark documents as paid and provide the details about the payments to keep the vendors informed.

Hide/Show
APIDescription
POST api/Payment

Record payments

GET api/disbursement/getpayments/{clientId}/{companyCode}/{fromDate}/{toDate}

Get ACH, Wire and Check payment information for a date range by company.

GET api/disbursement/getpayments/{clientId}/{fromDate}/{toDate}

Get ACH, Wire and Check payment information for a date range.

CheckPrint

Check Printing - post payment information to the system

Hide/Show
APIDescription
POST api/CheckPrint

Check Payment: Post check payment information to be printed and/or record the payment information for documents in the system.

Other Endpoints

ItemCatalogFmt1

Item Catalog, custom format 1. Add, update, delete, or bulk update item catalog records.

Hide/Show
APIDescription
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

POST api/ItemCatalogFmt1/Delete

Add Catalog Item

Users

User authentication provides the token used in subsequent calls.

Hide/Show
APIDescription
GET api/Users/{username}/{password}

Authenticate and retrieve bearer token and authorization list

ListMaintenance

List Maintenance - Add, Update, Delete or bulk update lists such as routing matrices, specializeds lists used by the system and item catalogs. Please refer to your implementation guide for the appropriate List Type and what values to include for each list type.

Hide/Show
APIDescription
POST api/ListMaintenance/Add

Add list item

POST api/ListMaintenance/BulkAdd

Clear existing list items and replace them with a new list

POST api/ListMaintenance/Update

Update list item

GET api/ListMaintenance/ListDefinitions

Get a 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


© 2026 - NextProcess Web APIs