Get transaction-level revenue data
GET/reporting/transactions
Retrieves comprehensive transaction-level financial data for all clients linked to the authenticated referral partner.
IMPORTANT: All amounts are returned in USD regardless of the original collection currency.
Revenue Recognition Stages The response includes a 4-stage revenue breakdown for each transaction, representing the complete lifecycle from collection to payment:
- Unrecognized Revenue - Collections that have occurred but revenue is not yet recognized (typically due to pending verifications or disputes)
- Uninvoiced Recognized Revenue - Revenue that has been recognized as earned but not yet invoiced to the partner
- Invoiced Revenue - Revenue that has been invoiced to the partner but not yet paid
- Paid Revenue - Revenue that has been paid to the partner
Exchange Rate Rules (Critical for Revenue Calculations)
- Stage 1 (Unrecognized) - Amounts fluctuate with current exchange rates (recalculated in real-time)
- Stages 2-4 (Recognized/Invoiced/Paid) - Amounts are LOCKED at the exchange rate from the moment revenue was recognized (Stage 1 → Stage 2 transition)
- This locking prevents exchange rate volatility from affecting recognized revenue, invoices, and payments
- The locked exchange rate is used for all downstream stages (Stages 2, 3, and 4)
Monthly Invoicing Workflow Revenue progresses through stages on a monthly cycle:
- Collections occur throughout the month (Stage 1)
- At month-end, unrecognized revenue is reviewed and recognized (Stage 1 → Stage 2, exchange rate locked)
- Recognized revenue is invoiced to the partner (Stage 2 → Stage 3)
- Partner pays the invoice (Stage 3 → Stage 4)
- Use this endpoint to track revenue status before and after monthly invoicing
Transaction Data Each transaction includes:
- Client identification (External Tenant ID, Client ID, Company Name)
- Case/Invoice details (Case ID, Debitura Reference, Creditor Reference)
- Debtor information (Name, Country)
- Financial amounts (Gross Amount in original currency, all revenue stages in USD, Collection Date)
- Revenue breakdown across all 4 stages (in USD)
- Referral fee percentage applied to this transaction
Filtering and Pagination
- DateFrom/DateTo - Filter transactions by collection date range (ISO 8601 format)
- ExternalTenantId - Filter to specific client(s)
- Page/PageSize - Paginate results (default: page 1, size 10, max: 100)
Sorting
- Sort - Sort field and direction (format: 'field:direction')
- Supported fields: collectionDate, amount
- Examples: 'collectionDate:desc', 'amount:asc'
- Default: collectionDate:desc (most recent first)
Use Cases
- Generate partner commission reports (all amounts in USD)
- Track revenue recognition status and exchange rate impact
- Reconcile monthly invoices and payments
- Analyze per-client performance
- Export financial data for accounting systems
- Monitor outstanding receivables
- Understand exchange rate fluctuations on Stage 1 (unrecognized) revenue
The data returned represents real collection activity and actual revenue earned from cases created through the referral partnership.
Request
Responses
- 200
- 400
- 500
Transactions retrieved successfully
Invalid request parameters (e.g., invalid date format, page size too large)
Internal server error