Base URL
All API requests should be made to:Authentication
All API requests require a valid JWT token in the Authorization header.
Request Format
Headers
| Header | Value | Required |
|---|---|---|
Authorization | jwt YOUR_TOKEN | Yes |
Content-Type | application/json | Yes (for POST/PUT) |
X-Idempotency-Key | Unique identifier | Recommended for mutations |
Idempotency
For critical operations like approvals and payments, include an idempotency key to prevent duplicate processing:Response Format
Success Response
Error Response
Pagination
List endpoints support pagination:| Parameter | Description | Default |
|---|---|---|
limit | Number of results per page | 20 |
offset | Number of results to skip | 0 |
Date Formats
All dates use ISO 8601 format:- Date only:
YYYY-MM-DD(e.g.,2024-01-15) - Date and time:
YYYY-MM-DDTHH:mm:ssZ(e.g.,2024-01-15T10:30:00Z)
Multi-Currency Support
Aden supports multi-currency operations:- Amounts are represented as numbers with up to 2 decimal places
- Currency codes follow ISO 4217 (e.g.,
USD,EUR,GBP) - Exchange rates are stored with up to 6 decimal places
- Multi-entity consolidation handles currency conversion automatically
Multi-Entity Support
Aden’s API supports multi-entity operations for organizations with multiple legal entities:- Each API call operates within the context of a specific entity
- Consolidated reporting aggregates data across entities
- Inter-company transactions are tracked automatically
Rate Limiting
The API implements rate limiting to ensure fair usage:- Standard limit: 1000 requests per minute
- Burst limit: 100 requests per second
429 Too Many Requests response.
Error Codes
| Code | Description |
|---|---|
400 | Bad Request - Invalid input |
401 | Unauthorized - Invalid or missing token |
403 | Forbidden - Insufficient permissions |
404 | Not Found - Resource doesn’t exist |
409 | Conflict - Resource already exists or state conflict |
422 | Unprocessable Entity - Business rule violation |
429 | Too Many Requests - Rate limit exceeded |
500 | Internal Server Error |
Best Practices
Use Idempotency Keys
Use Idempotency Keys
Always include idempotency keys for POST requests that modify data, especially for approvals and payments. This prevents duplicate transactions if a request is retried.
Handle Pagination
Handle Pagination
When fetching lists, always implement pagination handling. Don’t assume all results fit in one response.
Validate Before Submit
Validate Before Submit
Use the
/applicable endpoint to check which approval rules will apply before submitting documents for approval.Check Document Status
Check Document Status
Before performing workflow actions, always check the document’s current status to ensure the action is valid.
Use Proper Error Handling
Use Proper Error Handling
Implement robust error handling for all API calls. Check for specific error codes to provide appropriate user feedback.
Integration
Aden integrates seamlessly with your existing tools and workflows. Contact your Aden administrator for information about available integrations.Support
For API support:- Book a Discovery Call
- Website: https://adenhq.com