# Debbie Creditor API Documentation

- [Introduction](https://creditor-documentation.debbiecollect.com/index.md): The Debbie Creditor API is a RESTful interface allowing you, as a creditor, to programmatically send data to your debt collection partner 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 respons…
- [Getting started](https://creditor-documentation.debbiecollect.com/getting-started.md): Get started using the Creditor API
- [Core concepts](https://creditor-documentation.debbiecollect.com/core-concepts.md): Understand the core concepts in the Creditor API
- [Invoice-to-cash integration](https://creditor-documentation.debbiecollect.com/guides/invoice-to-cash.md): Hand unpaid invoices to your debt collection partner, and get the money and the bookkeeping back
- [Settlements](https://creditor-documentation.debbiecollect.com/guides/settlements.md): Post a settlement: what you are paid, what you are charged, and what is already in your books
- [Introduction](https://creditor-documentation.debbiecollect.com/api-reference/introduction.md): Welcome to the Debbie Creditor API
- [Authentication](https://creditor-documentation.debbiecollect.com/api-reference/authentication.md): Authenticate using bearer token
- [Pagination](https://creditor-documentation.debbiecollect.com/api-reference/pagination.md): How list endpoints paginate results
- [Idempotency](https://creditor-documentation.debbiecollect.com/api-reference/idempotency.md): Ensuring safe retries with Idempotency Keys
- [Voucher types](https://creditor-documentation.debbiecollect.com/api-reference/voucher-types.md): Ids for the built-in voucher types
- [Create customer](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/create.md): Create a new customer under your creditor. A customer represents your end-customer relationship and holds the contact details of the debtor.
- [Get customer by id](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get.md): Get a customer by customer id, including the users and cases related to the customer.
- [Get customer by reference id](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get-by-reference.md): Get a customer by your own reference id, including the users and cases related to the customer.
- [Add case vouchers](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/add-case-vouchers.md): Add new case vouchers (e.g. unpaid invoices, reminder fees or deposits) to a customer. Based on the vouchers, the platform automatically determines whether to create a new case or add the vouchers to an existing case.
- [Register case voucher allocation](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/case-vouchers/allocations.md): Register a payment made directly to the creditor or a credit note against a list of existing case vouchers. Set `voucherTypeId` to deposit or credit note; other types are currently rejected. All created vouchers use source `CREDITOR`.
- [Upload file](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/files/create.md): Upload a file. The returned file id can be used as an appendix on a case voucher, for example a pdf copy of an invoice.
- [Get file](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/files/get.md): Download a file by file id.
- [Add document](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create.md): Attach a document to one of your cases, or to your creditor. Upload the file first with [Upload file](/api-reference/endpoints/files/create) and pass the object it returns as `file`.
- [Get voucher types](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/voucher-types/get.md): Get the voucher types available on your debt collection partner, sorted by their order. Fetch the list once and cache it rather than hard-coding the ids — it also covers the types your partner has defined themselves, which are not on the [Voucher types](/api-reference/voucher-types) page.
- [Get deposit distribution](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/billings/deposit-distribution.md): How each payment in a settlement was split — what went to your debt collection partner, and what is yours. Every entry carries `source`, which tells you whether you already have the posting in your own books (`CREDITOR`) or whether your debt collection partner added it (`COLLECTOR`).
- [Get billing vouchers](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/billings/billing-vouchers.md): The fees (honorarer) and disbursements (udlæg) you are charged on a settlement — what you pay, next to what you are paid.
- [Webhooks](https://creditor-documentation.debbiecollect.com/api-reference/webhooks/introduction.md): Receive events through webhook deliveries or poll pending items
- [Create webhook](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/create.md): Creates a webhook for the events it is subscribed to. By default, deliveries are POSTed to the URL. Set pull=true to hold deliveries for polling through the webhook items endpoints. The response carries the verification token sent with every POST delivery.
- [Get webhooks](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/get-list.md): Lists the webhooks that are receiving events, paginated. Stop paging when a page comes back with fewer items than pageSize. A key only ever sees the webhooks of the creditor it is issued for.
- [Get webhook](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/get.md): Gets a single webhook.
- [Delete webhook](https://creditor-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://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/get-items.md): Lists webhook items for the creditor the API key is issued for. Use state=PENDING to fetch unprocessed items, optionally limited to one webhook with webhookId. For polling, create the webhook with pull=true and mark each item SUCCESS after processing it. Fetch page 0 again after acknowledging a batc…
- [Patch webhook item](https://creditor-documentation.debbiecollect.com/api-reference/endpoints/webhooks/patch-item.md): Updates the state of a webhook item belonging to the creditor the API key is issued for. After successfully processing a pending item, send {"state":"SUCCESS"} to acknowledge it. The item will no longer appear when filtering by state=PENDING.
- [Case created](https://creditor-documentation.debbiecollect.com/api-reference/webhooks/cases.create.md): Notifies when a case is created. A creditor webhook only receives events for the creditor it was created for.
- [Case updated](https://creditor-documentation.debbiecollect.com/api-reference/webhooks/cases.update.md): Notifies when a case is patched. Only the changed fields are sent. A creditor webhook only receives events for the creditor it was created for.
- [Case deleted](https://creditor-documentation.debbiecollect.com/api-reference/webhooks/cases.delete.md): Notifies when a case is deleted. A creditor webhook only receives events for the creditor it was created for.
- [Billing created](https://creditor-documentation.debbiecollect.com/api-reference/webhooks/billings.create.md): Notifies when a billing has been created. A creditor webhook only receives events for the creditor it was created for.

## OpenAPI Specs

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

## Optional

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.