The Financials API allows you to integrate financial data into the Equus Platform, enabling seamless management of vouchers, invoices, expenses, and payments. This API provides a structured way to retrieve and update financial records while automating report scheduling for efficient data exchange with external accounting systems.
The API supports GET, PATCH, and POST operations, allowing to fetch records, update payment statuses, and automate financial reporting. Integration requires middleware or a organization-developed financial platform for proper data mapping, tracking, and processing.
Key Features
Retrieve and update financial records: Supports GET, PATCH, and POST for vouchers, invoices, and payments.
Automated Report Scheduling: Utilizes the User Report Scheduler to deliver financial data as structured JSON web requests.
Data Exchange: Enables the automated transfer of vouchers, invoices, and payment data between Equus and financial systems.
Configurable Middleware Support: Adapts to different accounting platforms using middleware for data transformation and mapping.
The Financial API consists of two main financial processes:
Payables: Vouchers & Expense Entries - Retrieves and update payables such as vouchers and expense transactions
Receivables: Invoices & Billing Module - Supports invoice tracking, payment applications, and receivables reconciliation, allowing businesses to monitor outstanding invoices and their payment statuses.
How does the Financials API Work?
Sending the Payables Information via Web Request
The User Report Scheduler is configured to generates JSON web requests containing voucher and expense data, which are sent to the financial platform via middleware. The financial system processes and stores the data. Once received, the middleware extracts EMWP IDs and sends a PATCH API request to update the voucher status in Equus. A VOUCHER_HISTORY record is created to track status changes.
Receiving Payment Information via API
When a payment is made, the financial system updates the total cost amount and mode for the voucher and sends a PATCH request to Equus Platform. If a voucher payment is completed, wire transfer or check details are also sent via PATCH.
Sending the Invoice/Receivables Information via Web Request
The middleware retrieves the EMWP ID and sends a PATCH request to update the invoice status in Equus Platform. The system automatically updates the INVOICEPOST_DATE to mark the invoice as received.
Receiving Payment Information via API
When an invoice payment is received, the financial platform generates a PAYMENT_CREDIT record using a POST request. If applied to multiple invoices, PAYMENT_CREDIT_APPLY records are created to allocate funds. Once payments are applied, Equus updates the invoice payment status to Partially Paid or Paid, logging all financial transactions.