DEdebitura
Cases

Upload a file to a case. Optionally posts a system chat message to notify the collection partner.

Changed on

Uploads a file and associates it with a case owned by one of the referral partner's clients.

File requirements:

  • Maximum file size: 25 MB
  • Allowed types: PDF, Excel (.xls, .xlsx), CSV, Text (.txt), Images (.jpg, .jpeg, .png, .gif)

documentType (optional form field, case-insensitive) says what the document is. Omit it when you do not know it; the file is then stored as not specified. Valid values: OriginalInvoice, AccountStatement, Contract, TermsAndConditions, ProofOfDelivery, DemandLetter, Correspondence, PaymentProof, CourtDocument, IdentityDocument, Miscellaneous. Still accepted for existing integrations: DebtorDocuments, CreditorDocuments, PartnerDocuments. Any other value is rejected with 400 and error InvalidDocumentType.

When sendChatNotification is true (default), a system message is posted on the case chat to notify the collection partner that a new file was uploaded.

post/cases/{caseId}/files

Request

  • Base URL
    https://referral-api.debitura.com
  • URL
    https://referral-api.debitura.com/cases/{caseId}/files
  • Auth
    API key in header XApiKey

Path parameters

caseIdstring uuid required

Query parameters

sendChatNotificationboolean

Headers

Idempotency-Keystring

Optional non-empty, non-whitespace idempotency key (max 255 characters) for safely retrying this request. If a previous request used the same key with an identical body, the original terminal response is replayed verbatim. Reusing the key with a different body returns 422 with businessErrors[0].type: "IdempotencyConflict". Field-level 400 validation errors are not stored, so you may fix the request and retry with the same key.

Request body multipart/form-data

filestring binary
documentTypestring

Response

File uploaded successfully

Changes