# Debbie API Documentation ## Docs - [Authentication](https://documentation.debbiecollect.com/api-reference/authentication.md): Authenticate using bearer token - [Get deposit distribution](https://documentation.debbiecollect.com/api-reference/endpoints/billing/get.md): Get deposit distribution in a billing. - [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-by-case-id.md): Get case vouchers on a case - [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 - [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 - [Add case vouchers](https://documentation.debbiecollect.com/api-reference/endpoints/customers/add-case-vouchers.md): Add new case vouchers to a customer - [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 - [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 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 - [Get properties](https://documentation.debbiecollect.com/api-reference/endpoints/properties/get.md): Get properties by reference type and id - [Create update](https://documentation.debbiecollect.com/api-reference/endpoints/updates/create.md): Create new update allows the api consumer to create new updates - [Get update types](https://documentation.debbiecollect.com/api-reference/endpoints/updates/get-types.md): Get update types - [Patch update](https://documentation.debbiecollect.com/api-reference/endpoints/updates/patch.md): Patch an existing update - [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 - [Idempotency](https://documentation.debbiecollect.com/api-reference/idempotency.md): Ensuring safe retries with Idempotency Keys - [Introduction](https://documentation.debbiecollect.com/api-reference/introduction.md): Welcome to the Debbie API - [Billing created](https://documentation.debbiecollect.com/api-reference/webhooks/billings.create.md): Notifies when a billing has been created. - [Case voucher created](https://documentation.debbiecollect.com/api-reference/webhooks/case-vouchers.create.md): Notifies when a case voucher has been created. - [Case voucher deleted](https://documentation.debbiecollect.com/api-reference/webhooks/case-vouchers.delete.md): Notifies when a case voucher has been deleted. - [Case voucher updated](https://documentation.debbiecollect.com/api-reference/webhooks/case-vouchers.update.md): Notifies when a case voucher has been updated. - [Case merged](https://documentation.debbiecollect.com/api-reference/webhooks/cases.merge.md): Notifies when a case is merged into another case. - [Case status change](https://documentation.debbiecollect.com/api-reference/webhooks/cases.status-change.md): Notifies when a case changes status. - [Case merge undoed](https://documentation.debbiecollect.com/api-reference/webhooks/cases.undo-merge.md): Notifies when a case merge is undoed. - [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. - [Customer created](https://documentation.debbiecollect.com/api-reference/webhooks/customers.create.md): Notifies when a customer has been created. - [Interaction sent](https://documentation.debbiecollect.com/api-reference/webhooks/interactions.send.md): Notifies when an interaction has been sent. - [Payment plan status change](https://documentation.debbiecollect.com/api-reference/webhooks/payment-plans.status-change.md): Notifies when a payment plan changes status. - [Payout created](https://documentation.debbiecollect.com/api-reference/webhooks/payouts.create.md): Notifies when a payout has been created. - [Update created](https://documentation.debbiecollect.com/api-reference/webhooks/updates.create.md): Notifies when an update has been created. - [Update deleted](https://documentation.debbiecollect.com/api-reference/webhooks/updates.delete.md): Notifies when an update has been deleted. - [Update updated](https://documentation.debbiecollect.com/api-reference/webhooks/updates.update.md): Notifies when an update has been patched. - [Core concepts](https://documentation.debbiecollect.com/core-concepts.md): Understand core concepts in Debbie - [Getting started](https://documentation.debbiecollect.com/getting-started.md): Get started using the API - [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. ## OpenAPI Specs - [openapi](https://documentation.debbiecollect.com/api-reference/openapi.json) ## Optional - [API Status](https://debbie.freshstatus.io/)