name: Debbie Platform API Capabilities
description: >-
  Capabilities exposed by the Debbie Platform API for managing cases,
  creditors, customers, vouchers, files, updates, and webhooks.
capabilities:
  - name: Create Case
    description: Open a new debt-collection case for a creditor and a customer.
    operationId: createCase
    method: POST
    path: /cases
  - name: List Cases
    description: Retrieve cases with pagination and filtering.
    operationId: listCases
    method: GET
    path: /cases
  - name: Get Case
    description: Fetch a single case by ID.
    operationId: getCase
    method: GET
    path: /cases/{caseId}
  - name: Update Case
    description: Patch attributes such as status or amounts on a case.
    operationId: patchCase
    method: PATCH
    path: /cases/{caseId}
  - name: Add Case Voucher
    description: Attach a supporting voucher (invoice, receipt) to a case.
    operationId: addCaseVoucher
    method: POST
    path: /cases/{caseId}/vouchers
  - name: Create Creditor
    description: Onboard a new creditor organization onto Debbie.
    operationId: createCreditor
    method: POST
    path: /creditors
  - name: Create Customer
    description: Register a debtor with contact details and reference IDs.
    operationId: createCustomer
    method: POST
    path: /customers
  - name: Upload File
    description: Upload supporting documentation associated with a case or customer.
    operationId: createFile
    method: POST
    path: /files
  - name: Create Update
    description: Record an event or note against a referenced resource.
    operationId: createUpdate
    method: POST
    path: /updates
  - name: List Webhook Items
    description: List webhook delivery events for monitoring and replay.
    operationId: listWebhookItems
    method: GET
    path: /webhooks/items
  - name: Get Deposit Distribution
    description: Retrieve how received deposits are split across principal, fees, and creditor share.
    operationId: getDepositDistribution
    method: GET
    path: /billing/deposit-distribution
use_cases:
  - name: ERP and billing integration
    description: Push overdue invoices into Debbie automatically from ERP/billing systems.
  - name: Self-service collection
    description: Drive automated digital reminder flows that resolve cases without staff intervention.
  - name: Collection-agency workflow
    description: Power agency case management, debtor dialogue, and payout reconciliation.
  - name: Real-time status sync
    description: Keep external systems updated via webhooks for cases, payments, and payouts.