Finance Endpoints
Use public API endpoints for invoices, estimates, expenses, and payments.
Finance public API endpoints are available under /public/v1.
Resources
/invoices/estimates/expenses/payments
Each resource supports public API operations according to the generated OpenAPI reference and the abilities on the API key.
Common Integration Patterns
Use Finance endpoints when a trusted backend needs to create billing records, export accounting data, or reconcile payment status. Typical examples include creating invoices from an order system, sending estimate data to a reporting warehouse, recording offline payments from a bank workflow, or exporting expenses for accounting review.
Finance writes affect customer balances and reports, so treat them as production operations. Test with one customer or one invoice before running a bulk process.
Useful Includes
- Invoices:
account,payments - Estimates:
account - Expenses:
account,project - Payments:
invoice,account
Use includes when the integration needs related customer or payment context in the same response. For exports, page through the base resource first and request related data only when the downstream system needs it.
Before Creating Finance Records
Validate:
- Customer account or contact mapping.
- Currency, tax, discount, and line-item totals.
- Invoice or estimate status expected after creation.
- Payment method, amount, date, and reference for manual payments.
- Idempotency behavior for retries so duplicate invoices or payments are not created.
Do not use the public API to mark a customer payment as successful unless the payment has actually been confirmed by your payment provider or finance team.
Reconciliation Checks
After a sync, compare Agiled totals with the source system. Check invoice count, invoice totals, payment totals, outstanding balances, and any failed validation responses. Resolve mismatches before sending customer-facing emails or exporting reports.
Finance Rollout Plan
Roll out finance integrations in stages. Start with read-only exports, then one test invoice or estimate, then a small customer group, and only then broad automation. Review every created finance record in Agiled before enabling customer notifications or payment collection.
Keep an external reference ID on the source side so support can trace an Agiled invoice, estimate, payment, or expense back to the original system.
Protect Customer Communication
Finance API writes can trigger downstream review, reminders, or customer-facing workflows depending on workspace setup. Before enabling automation, confirm whether created invoices or estimates should be sent manually, sent by workflow, or kept as drafts for review.
Use one safe customer record to test the full path from API write to preview, payment, email, and reporting.