DEdebitura
CollectionRequests

Submit one invoice for collection

Changed on

Available only when Starter Integration is enabled. Send exactly one invoice in the invoices array. Return navigation uses the referral partner configuration; no per-request returnUrl is supported. Client details are used only on creation; existing clients approve a new connection. solutionUrl points to the first outstanding action: onboarding, approval, signature, KYC, fixing drafts, then the case. Resubmitting a client invoice reference returns its existing case within the same data classification.

post/collection-requests

Request

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

Headers

Idempotency-Keystring

Request body

externalTenantIdstring nullable

Example request

{
  "invoices": [
    {
      "claimLines": [
        {
          "dueDate": "2024-01-15",
          "amount": 423.42,
          "reference": "INV-1001"
        }
      ]
    }
  ]
}

Response

Created

idstring uuid
status'awaiting_onboarding' | 'awaiting_approval' | 'awaiting_signature' | 'awaiting_kyc' | 'needs_fixing' | 'submitted' | 'rejected' | 'expired' | 'processing'
solutionUrlstring nullable
solutionType'onboarding' | 'approval' | 'sdca' | 'sdca_update' | 'power_of_attorney' | 'jurisdiction_pricing_appendix' | 'kyc' | 'fix' | 'case' | 'signature' nullable

Next action: onboarding, approval, sdca (initial/fallback SDCA), sdca_update, power_of_attorney, jurisdiction_pricing_appendix, kyc, fix or case. Null when no action is available. Status remains awaiting_signature for agreement work. The legacy signature value can appear only in an immutable keyed replay snapshot.

externalTenantIdstring nullable
createdAtstring date-time
updatedAtstring date-time

Changes