DEdebitura
Reporting

Get transaction-level revenue data

Changed on

Retrieves comprehensive transaction-level financial data for all clients linked to the authenticated referral partner.

IMPORTANT: Fields whose names end in Usd are returned in USD. Native transaction amounts retain their own currencies: case amounts use case.currency, collected amounts use payment.currency, and earnings.collectionPartnerAmount uses earnings.collectionPartnerCurrency.

Revenue Recognition Stages The response includes a 4-stage revenue breakdown for each transaction, representing the complete lifecycle from collection to payment:

  1. Unrecognized Revenue - Collections that have occurred but revenue is not yet recognized (typically due to pending verifications or disputes)
  2. Uninvoiced Recognized Revenue - Revenue that has been recognized as earned but not yet invoiced to the partner
  3. Invoiced Revenue - Revenue that has been invoiced to the partner but not yet paid
  4. 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 (case, payment, and collection-partner amounts in their identified native currencies; revenue-stage fields 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 with explicit native and USD currency fields
  • 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.

get/reporting/transactions

Request

  • Base URL
    https://referral-api.debitura.com
  • URL
    https://referral-api.debitura.com/reporting/transactions
  • Auth
    API key in header XApiKey

Query parameters

FromDatestring date-time

Filter transactions from this date (inclusive). ISO 8601 format.

ToDatestring date-time

Filter transactions to this date (inclusive). ISO 8601 format.

ExternalTenantIdstring

Filter by specific client's external tenant ID

HasRecognizedRevenueboolean

When true, only show transactions where revenue has been recognized (collection partner has paid Debitura). When false, only show unrecognized transactions.

CommissionPaymentStatusesDebituraDomainModelInvoicePaymentsPayoutsEnumsPayoutCommissionPaymentStatus[]

Filter by commission payment status (Unpaid = 0, Paid = 1, Credited = 2). Tracks whether Debitura has received the collection partner's commission.

PlatformInvoicingStatusesDebituraDomainModelCoreInvoicePaymentsPlatformInvoicingStatus[]

Filter by platform invoicing status (NotInvoiced = 0, InvoiceIssued = 1, PaymentReceived = 2, InvoiceCredited = 3). Tracks Debitura's invoicing lifecycle with the collection partner.

ReferralInvoicingStatusesDebituraDomainModelReferralPartnersEnumsReferralInvoicingStatus[]

Filter by referral invoicing status (Pending = 0, Invoiced = 1, Paid = 2)

RevenueStagesDebituraWebReferralPartnerApiModelsReportingTransactionRevenueStage[]

Filter by revenue-lifecycle stage (see TransactionRevenueStage). Use this instead of combining CommissionPaymentStatuses/PlatformInvoicingStatuses/ReferralInvoicingStatuses when you need a row list for one specific "Ready to Invoice" tab bucket — it applies the same ConfirmedPipeline fold the summary already uses, so the row list matches the badge count exactly for partners in ConfirmedPipeline mode. ANDed with the other filters above if both are supplied.

Only narrows the row-list (data) — the returned summary always reports all 7 bucket totals regardless of this filter, since its purpose is to drive tab badge counts and would otherwise collapse the other buckets toward zero.

Searchstring

Search text to filter by case reference, client company name, or debtor name (company or individual first/last name) — case-insensitive, partial match. Minimum 2 characters required for search to be applied.

Pageinteger

Page number (1-indexed)

PageSizeinteger

Number of results per page (default: 10, max: 100)

CountryIdsinteger[]

Filter by debtor country ID(s). Multiple values can be provided. Only transactions where the debtor's country matches one of the specified IDs are returned.

CollectionPartnerIdsstring[]

Filter by collection partner ID(s). Multiple values can be provided. Only transactions for cases assigned to one of the specified collection partners are returned.

Sortstring

Sort field and direction. Format: "field[:asc|desc]" Supported fields: collectionDate, amount Examples: "collectionDate:desc", "amount:asc" Default: collectionDate:desc

Response

Transactions retrieved successfully

Changes

  • 739ec0889478Revision changes
    • breaking

      removed the enum value 0.00 from the property items/ of the query request parameter CommissionPaymentStatuses

    • breaking

      removed the enum value 0.00 from the property items/ of the query request parameter PlatformInvoicingStatuses

    • breaking

      removed the enum value 0.00 from the property items/ of the query request parameter ReferralInvoicingStatuses

    • breaking

      removed the enum value 0.00 from the property items/ of the query request parameter RevenueStages

    • breaking

      removed the enum value 1.00 from the property items/ of the query request parameter CommissionPaymentStatuses

    • breaking

      removed the enum value 1.00 from the property items/ of the query request parameter PlatformInvoicingStatuses

    • breaking

      removed the enum value 1.00 from the property items/ of the query request parameter ReferralInvoicingStatuses

    • breaking

      removed the enum value 1.00 from the property items/ of the query request parameter RevenueStages

    • breaking

      removed the enum value 2.00 from the property items/ of the query request parameter CommissionPaymentStatuses

    • breaking

      removed the enum value 2.00 from the property items/ of the query request parameter PlatformInvoicingStatuses

    • breaking

      removed the enum value 2.00 from the property items/ of the query request parameter ReferralInvoicingStatuses

    • breaking

      removed the enum value 2.00 from the property items/ of the query request parameter RevenueStages

    • breaking

      removed the enum value 3.00 from the property items/ of the query request parameter PlatformInvoicingStatuses

    • breaking

      removed the enum value 3.00 from the property items/ of the query request parameter ReferralInvoicingStatuses

    • breaking

      removed the enum value 3.00 from the property items/ of the query request parameter RevenueStages

    • breaking

      removed the enum value 4.00 from the property items/ of the query request parameter RevenueStages

    • breaking

      removed the enum value 5.00 from the property items/ of the query request parameter RevenueStages

    • breaking

      removed the enum value 6.00 from the property items/ of the query request parameter RevenueStages

    • warning

      for the query request parameter CommissionPaymentStatuses, the type of property items/ changed from integer to string, and format from int32 to no format

    • warning

      for the query request parameter PlatformInvoicingStatuses, the type of property items/ changed from integer to string, and format from int32 to no format

    • warning

      for the query request parameter ReferralInvoicingStatuses, the type of property items/ changed from integer to string, and format from int32 to no format

    • warning

      for the query request parameter RevenueStages, the type of property items/ changed from integer to string, and format from int32 to no format

    • info

      added the enum value AwaitingCollectionPartnerPayment to the property items/ of the query request parameter RevenueStages

    • info

      added the enum value AwaitingDebituraPayment to the property items/ of the query request parameter RevenueStages

    • info

      added the enum value ConfirmedPendingInvoice to the property items/ of the query request parameter RevenueStages

    • info

      added the enum value Credited to the property items/ of the query request parameter CommissionPaymentStatuses

    • info

      added the enum value Disputed to the property items/ of the query request parameter ReferralInvoicingStatuses

    • info

      added the enum value Disputed to the property items/ of the query request parameter RevenueStages

    • info

      added the enum value InvoiceCredited to the property items/ of the query request parameter PlatformInvoicingStatuses

    • info

      added the enum value InvoiceIssued to the property items/ of the query request parameter PlatformInvoicingStatuses

    • info

      added the enum value Invoiced to the property items/ of the query request parameter ReferralInvoicingStatuses

    • info

      added the enum value NotInvoiced to the property items/ of the query request parameter PlatformInvoicingStatuses

    • info

      added the enum value Paid to the property items/ of the query request parameter CommissionPaymentStatuses

    • info

      added the enum value Paid to the property items/ of the query request parameter ReferralInvoicingStatuses

    • info

      added the enum value Paid to the property items/ of the query request parameter RevenueStages

    • info

      added the enum value PaymentReceived to the property items/ of the query request parameter PlatformInvoicingStatuses

    • info

      added the enum value Pending to the property items/ of the query request parameter ReferralInvoicingStatuses

    • info

      added the enum value Pending to the property items/ of the query request parameter RevenueStages

    • info

      added the enum value ReadyToInvoiceDebitura to the property items/ of the query request parameter RevenueStages

    • info

      added the enum value Unpaid to the property items/ of the query request parameter CommissionPaymentStatuses

  • b0bc60fbff11Revision changes
    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)

    • info

      added the optional property // to the response with the status (media type: text/plain)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: text/json)

    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)