Download of documents
Riverty’s Accounting-as-a-Service (AaaS) generates various types of documents across multiple accounting processes, including:
Steps to receive documents created by Accounting as a Service
- Invoices
- Dunning Notices
- Booking Confirmations
These documents may be created and delivered in different formats:
- As HTML emails (e.g., Dunning, Booking Confirmation)
- As HTML emails with PDF attachments (e.g., Invoices)
- Solely as PDF files (e.g., Invoice PDFs, printable Dunning Letters)
All documents are stored and archived in Riverty’s optical archive, where:
- Emails are archived as files
.eml
- PDF documents are stored directly as
.pdf
Each created document receives a unique URL, which is provided through event-driven notifications (such as documentCreated or invoiceCreated). These links allow clients to access and download the respective documents.
This mechanism also supports retrieval of historical data, for example when a client discontinues the AaaS service and requires a complete set of past records.
Access and Authentication
To download a document:
- The client must be registered on the AQI Developer Portal to receive an API key.
- This subscription key must be included in the request headers when calling the document URL. It identifies the client and verifies authorization for access.
GET https://api-uat.accounting.riverty.io/documents/v1/S/{UUID} Headers: X-Subscription-Key: {your-api-key}
Rate Limiting and Reliability
Downloads are subject to rate limiting to ensure system stability:
- The current limit is 10 requests per second per IP address
- If this threshold is exceeded, the API returns
HTTP 429 – Rate Limit Exceeded
You must implement a retry mechanism to handle rate-limit errors, especially when retrieving a large number of documents.