API Documentation
Integrate with Oxiom Invoice Processing using secure REST APIs for invoice ingestion, retrieval, workflow updates, vendor data, and reporting.
Authentication
API access uses scoped API keys issued by an Oxiom administrator. Send the key in the Authorization header as a bearer token and rotate keys according to your security policy.
Base URL
https://api.oxiom.in/v1
Use environment-specific credentials and network controls when connecting from production integrations.
Rate limits
Integrations should expect request-rate controls and respect retry headers during peak processing windows.
Endpoints overview
GET /invoices
List invoices with filtering by status, supplier, amount, date range, and workflow ownership.
POST /invoices
Create or ingest a new invoice record with source metadata and document references.
GET /invoices/{id}
Retrieve invoice header data, status, workflow history, and related document metadata.
PATCH /invoices/{id}/status
Update invoice workflow status when the calling integration has appropriate permissions.
GET /vendors
Return vendor master data available to the authenticated account or integration scope.
GET /reports/summary
Fetch aggregate reporting metrics for throughput, aging, and exception activity.
Request/response formats
Requests and responses use JSON. Invoice objects typically include document identifiers, vendor references, totals, status, timestamps, workflow ownership, and supporting metadata required for downstream processing or reporting.
Webhooks and SDKs
Oxiom can publish event notifications for invoice status changes. Subscribers should verify signatures, log deliveries securely, and design handlers to process duplicate deliveries safely. Integrations are commonly implemented with existing enterprise HTTP clients and middleware.
Error codes
| HTTP | Meaning | Guidance |
|---|---|---|
| 400 | Bad Request | The request payload is malformed, incomplete, or violates validation rules. |
| 401 | Unauthorized | The API key is missing, invalid, expired, or not authorized for the request scope. |
| 403 | Forbidden | The integration is authenticated but lacks permission for the requested resource or action. |
| 404 | Not Found | The requested resource does not exist or is out of scope. |
| 429 | Rate Limited | The integration exceeded the current request threshold. |
| 500 | Server Error | An unexpected platform issue occurred. |