# Debbie API Documentation

- [Introduction](https://documentation.debbiecollect.com/index.md): The Debbie API is a RESTful interface, allowing you to programmatically update, add and access your data in the platform. It provides predictable URLs for accessing resources, and uses built-in HTTP features to receive commands and return responses.
- [Getting started](https://documentation.debbiecollect.com/getting-started.md): Get started using the API
- [Core concepts](https://documentation.debbiecollect.com/core-concepts.md): Understand core concepts in Debbie
- [Law firm systems](https://documentation.debbiecollect.com/guides/law-firm-systems.md): Integrating a law firm case management system with Debbie
- [Introduction](https://documentation.debbiecollect.com/api-reference/introduction.md): Welcome to the Debbie API
- [Authentication](https://documentation.debbiecollect.com/api-reference/authentication.md): Authenticate using bearer token
- [Pagination](https://documentation.debbiecollect.com/api-reference/pagination.md): How list endpoints paginate results
- [Idempotency](https://documentation.debbiecollect.com/api-reference/idempotency.md): Ensuring safe retries with Idempotency Keys
- [Create creditor](https://documentation.debbiecollect.com/api-reference/endpoints/creditors/create.md): Create new creditor allows the api consumer to create new creditors
- [Get creditor](https://documentation.debbiecollect.com/api-reference/endpoints/creditors/get.md): Get a creditor
- [Patch creditor](https://documentation.debbiecollect.com/api-reference/endpoints/creditors/patch.md): Patch a creditor
- [Create customer](https://documentation.debbiecollect.com/api-reference/endpoints/customers/create.md): Create new customer allows the api consumer to create a customer related to a creditor
- [Get customer id](https://documentation.debbiecollect.com/api-reference/endpoints/customers/get.md): Get a customer by customer id
- [Get customer by reference id](https://documentation.debbiecollect.com/api-reference/endpoints/customers/get-by-reference.md): Get a customer by customer reference id
- [Add case vouchers](https://documentation.debbiecollect.com/api-reference/endpoints/customers/add-case-vouchers.md): Add new case vouchers to a customer
- [Add user on customer](https://documentation.debbiecollect.com/api-reference/endpoints/customers/add-user-on-customer.md): Add a new user (party) to a customer. Use this to add for example a driver, a representative or another party that should be able to receive communication on the customer's cases.
- [Patch user on customer](https://documentation.debbiecollect.com/api-reference/endpoints/customers/patch-user-on-customer.md): Patch user information on a user associated with a customer
- [Create case](https://documentation.debbiecollect.com/api-reference/endpoints/cases/create.md): Create new case allows the api consumer to create new cases
- [Get case](https://documentation.debbiecollect.com/api-reference/endpoints/cases/get.md): Get a case by id
- [Get cases](https://documentation.debbiecollect.com/api-reference/endpoints/cases/get-list.md): Get a list of cases paginated
- [Patch case](https://documentation.debbiecollect.com/api-reference/endpoints/cases/patch.md): Updates attributes of a case given the cases id
- [Get case groups](https://documentation.debbiecollect.com/api-reference/endpoints/case-groups/get-list.md): Get a paginated list of the case groups on the tenant. Stop paging when a page comes back with fewer items than pageSize.
- [Create case group](https://documentation.debbiecollect.com/api-reference/endpoints/case-groups/create.md): Create a case group on the tenant.
- [Update case group](https://documentation.debbiecollect.com/api-reference/endpoints/case-groups/update.md): Update the label or settings of a case group.
- [Delete case group](https://documentation.debbiecollect.com/api-reference/endpoints/case-groups/delete.md): Delete a case group. Cases in the group are kept and detached from it.
- [Add case voucher](https://documentation.debbiecollect.com/api-reference/endpoints/case-vouchers/create.md): Add case voucher to case
- [Get case vouchers](https://documentation.debbiecollect.com/api-reference/endpoints/case-vouchers/get-list.md): Get a paginated list of case vouchers. Can be filtered by the reference id of the voucher and by a case voucher property (attribute). Property filtering matches the exact value of a text property.
- [Get case voucher](https://documentation.debbiecollect.com/api-reference/endpoints/case-vouchers/get.md): Get a single case voucher by its id.
- [Get payment plans](https://documentation.debbiecollect.com/api-reference/endpoints/payment-plans/get-list.md): Get a list of payment plans, paginated. Plans are returned oldest first, so a consumer paging through the whole set is not shifted by plans created while it iterates.
- [Get payment plan](https://documentation.debbiecollect.com/api-reference/endpoints/payment-plans/get.md): Get a single payment plan by its id.
- [Create interaction](https://documentation.debbiecollect.com/api-reference/endpoints/interactions/create.md): Create an interaction on a case. Use this to register an incoming message from a debtor or another party, for example a submitted contact form.
- [Get deposit distribution](https://documentation.debbiecollect.com/api-reference/endpoints/billing/get.md): Get deposit distribution in a billing.
- [Get billing vouchers](https://documentation.debbiecollect.com/api-reference/endpoints/billing/get-billing-vouchers.md): Get the fees and disbursements the creditor is charged on a billing.
- [Get transaction accounts](https://documentation.debbiecollect.com/api-reference/endpoints/transaction-accounts/get.md): Get the transaction accounts of the tenant.
- [Create transaction account](https://documentation.debbiecollect.com/api-reference/endpoints/transaction-accounts/create.md): Create a transaction account — a bank account or a payment service provider account that payments are registered on.
- [Patch transaction account](https://documentation.debbiecollect.com/api-reference/endpoints/transaction-accounts/patch.md): Update the name or the reference id of a transaction account.
- [Delete transaction account](https://documentation.debbiecollect.com/api-reference/endpoints/transaction-accounts/delete.md): Delete a transaction account.
- [Get voucher types](https://documentation.debbiecollect.com/api-reference/endpoints/voucher-types/get.md): Get the voucher types of the tenant, sorted by their order. A creditor key only receives the types the creditor can send vouchers in.
- [Get end reasons](https://documentation.debbiecollect.com/api-reference/endpoints/end-reasons/get-list.md): Get a paginated list of the end reasons available on the tenant — the standard end reasons and the ones the tenant has created — sorted by how often they are used. Stop paging when a page comes back with fewer items than pageSize.
- [Create end reason](https://documentation.debbiecollect.com/api-reference/endpoints/end-reasons/create.md): Create an end reason on the tenant. The handle is derived from the label when not provided.
- [Update end reason](https://documentation.debbiecollect.com/api-reference/endpoints/end-reasons/update.md): Update an end reason created on the tenant. The standard end reasons cannot be edited.
- [Delete end reason](https://documentation.debbiecollect.com/api-reference/endpoints/end-reasons/delete.md): Delete an end reason created on the tenant. The standard end reasons cannot be deleted, and an end reason used by ended cases is rejected with a conflict.
- [Get update types](https://documentation.debbiecollect.com/api-reference/endpoints/updates/get-types.md): Get a paginated list of the update types available on the tenant.
- [Get updates](https://documentation.debbiecollect.com/api-reference/endpoints/updates/get-list.md): Get a list of every update on the tenant, paginated. Updates are returned oldest first, so a consumer paging through the whole set is not shifted by updates created while it iterates. Only updates on cases are returned.
- [Get update](https://documentation.debbiecollect.com/api-reference/endpoints/updates/get.md): Get a single update by its id. Only updates on cases can be read; any other update answers 404.
- [Create update](https://documentation.debbiecollect.com/api-reference/endpoints/updates/create.md): Create new update allows the api consumer to create new updates
- [Patch update](https://documentation.debbiecollect.com/api-reference/endpoints/updates/patch.md): Patch an existing update
- [Get properties](https://documentation.debbiecollect.com/api-reference/endpoints/properties/get.md): Get properties by reference type and id
- [Create file](https://documentation.debbiecollect.com/api-reference/endpoints/files/create.md): Upload file allows the api consumer to upload files
- [Get file](https://documentation.debbiecollect.com/api-reference/endpoints/files/get.md): Get file by fileId
- [Create webhook](https://documentation.debbiecollect.com/api-reference/endpoints/webhooks/create.md): Creates a webhook that POSTs the events it is subscribed to. The response carries the verification token sent with every delivery — store it, it is not shown again.
- [Get webhooks](https://documentation.debbiecollect.com/api-reference/endpoints/webhooks/get-list.md): Lists the webhooks that are receiving events.
- [Get webhook](https://documentation.debbiecollect.com/api-reference/endpoints/webhooks/get.md): Gets a single webhook.
- [Delete webhook](https://documentation.debbiecollect.com/api-reference/endpoints/webhooks/delete.md): Deletes a webhook. It stops receiving events immediately; deliveries already made are kept.
- [Get webhook items](https://documentation.debbiecollect.com/api-reference/endpoints/webhooks/get-items.md): Get webhook items paginated
- [Patch webhook item](https://documentation.debbiecollect.com/api-reference/endpoints/webhooks/patch-item.md): Patch webhook item
- [Update created](https://documentation.debbiecollect.com/api-reference/webhooks/updates.create.md): Notifies when an update has been created.
- [Update updated](https://documentation.debbiecollect.com/api-reference/webhooks/updates.update.md): Notifies when an update has been patched.
- [Update deleted](https://documentation.debbiecollect.com/api-reference/webhooks/updates.delete.md): Notifies when an update has been deleted.
- [Creditor created](https://documentation.debbiecollect.com/api-reference/webhooks/creditors.create.md): Notifies when a creditor has been created.
- [Creditor updated](https://documentation.debbiecollect.com/api-reference/webhooks/creditors.update.md): Notifies when a creditor has been updated.
- [Case voucher created](https://documentation.debbiecollect.com/api-reference/webhooks/case-vouchers.create.md): Notifies when a case voucher has been created.
- [Case voucher updated](https://documentation.debbiecollect.com/api-reference/webhooks/case-vouchers.update.md): Notifies when a case voucher has been updated.
- [Case voucher deleted](https://documentation.debbiecollect.com/api-reference/webhooks/case-vouchers.delete.md): Notifies when a case voucher has been deleted.
- [Deposit created](https://documentation.debbiecollect.com/api-reference/webhooks/deposits.created.md): Notifies when a deposit has been created, with or without a case. A deposit created directly on a case fires `deposits.created` and `deposits.booked`.
- [Deposit booked](https://documentation.debbiecollect.com/api-reference/webhooks/deposits.booked.md): Notifies when a deposit has been booked on a case it was not on before. It does not fire when a deposit moves between cases — that is `deposits.moved`.
- [Deposit moved](https://documentation.debbiecollect.com/api-reference/webhooks/deposits.moved.md): Notifies when a deposit has been moved from one case to another. `fromCaseId` and `toCaseId` carry the two cases.
- [Deposit unbooked](https://documentation.debbiecollect.com/api-reference/webhooks/deposits.unbooked.md): Notifies when a deposit has been removed from its case without landing on another. `fromCaseId` carries the case it came off.
- [Deposit deleted](https://documentation.debbiecollect.com/api-reference/webhooks/deposits.deleted.md): Notifies when a deposit has been deleted.
- [Deposit restored](https://documentation.debbiecollect.com/api-reference/webhooks/deposits.restored.md): Notifies when a deleted deposit has been restored.
- [Payment plan created](https://documentation.debbiecollect.com/api-reference/webhooks/payment-plans.create.md): Notifies when a payment plan is created.
- [Payment plan updated](https://documentation.debbiecollect.com/api-reference/webhooks/payment-plans.update.md): Notifies when a payment plan is patched. Only the changed fields are sent. Also dispatched when creating a plan on a case that already has one: the existing plan is reshaped instead of a new one being created, and the result is reported here rather than as payment-plans.create.
- [Payment plan deleted](https://documentation.debbiecollect.com/api-reference/webhooks/payment-plans.delete.md): Notifies when a payment plan is deleted.
- [Interaction sent](https://documentation.debbiecollect.com/api-reference/webhooks/interactions.send.md): Notifies when an interaction has been sent.
- [Customer created](https://documentation.debbiecollect.com/api-reference/webhooks/customers.create.md): Notifies when a customer has been created.
- [Case created](https://documentation.debbiecollect.com/api-reference/webhooks/cases.create.md): Notifies when a case is created.
- [Case updated](https://documentation.debbiecollect.com/api-reference/webhooks/cases.update.md): Notifies when a case is patched. Only the changed fields are sent.
- [Case deleted](https://documentation.debbiecollect.com/api-reference/webhooks/cases.delete.md): Notifies when a case is deleted.
- [Case merged](https://documentation.debbiecollect.com/api-reference/webhooks/cases.merge.md): Notifies when a case is merged into another case.
- [Case merge undoed](https://documentation.debbiecollect.com/api-reference/webhooks/cases.undo-merge.md): Notifies when a case merge is undoed.
- [Billing created](https://documentation.debbiecollect.com/api-reference/webhooks/billings.create.md): Notifies when a billing has been created.
- [Payout created](https://documentation.debbiecollect.com/api-reference/webhooks/payouts.create.md): Notifies when a payout has been created.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## Optional

- [API Status](https://debbie.checkly-status-page.com)