> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paywise.de/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the paywise Case Management API

## About the API

Use our API to submit claims to our debt collection service, track mandates, submit payment notifications and get full insights into our client statements.

This API adheres to REST best practices, offering:

* Predictable, resource-oriented URLs
* JSON request bodies and responses
* Standard HTTP response codes, authentication, and verbs

### Important Notes:

* Depending on the endpoint or entity being managed, some operations may be restricted due to procedural or legal limitations.
* The paywise API supports a **test mode**, allowing you to simulate requests without affecting live data. The API key used to authenticate requests determines whether they are executed in live or test mode.
* Bulk updates are not supported. Each request works on a single object.

## What's the Difference Between the Case Management API and the Partner API?

The paywise platform offers two APIs, each serving distinct purposes:

### Case Management API:

* The Case Management API focuses exclusively on facilitating the debt collection process.

### Partner API:

* Use the [separate Partner API](/api-docs/partner-api/introduction) to create and manage paywise accounts for your client companies and onboard their users.
* Typical use cases:
  * SaaS services that offer a user-friendly interface to their clients for managing receivables.
  * Parent companies managing groups of companies.

#### Key Points:

* If you represent a single company and manage your own debt collection, you only need the Case Management API (documented here).
* Partners can use the Case Management API on behalf of their client companies.

## Authentication

All API requests must be made over HTTPS; calls over plain HTTP will fail. Requests must also include proper authentication.

### Authentication Details:

* The API uses Bearer tokens for authentication.
* Separate tokens are provided for test and production environments. Start with test keys for integration.
* Generate API keys in your [paywise account](https://app.paywise.de/).
* Include the token in the `Authorization` header as follows:

```javascript theme={null}
$ curl -X GET https://api.paywise.de/v1/claims/ -H 'Authorization: Bearer YOUR_TOKEN'
```

## Getting Started

Here’s an overview of the typical workflow for submitting claims via the API:

<Steps>
  <Step title="Create a Debtor">
    [Create a Debtor](/api-docs/case-management-api/debtors/create-a-debtor). Provide all relevant information about the debtor.
  </Step>

  <Step title="Create a Claim">
    [Create a Claim](/api-docs/case-management-api/claims/create-a-claim). Include all available information about the claim, such as an unpaid invoice.
  </Step>

  <Step title="Upload Documents">
    [Upload documents to the Claim](/api-docs/case-management-api/claims/upload-a-document-to-a-claim). Provide all relevant documents, such as an invoice. This step is optional but highly recommended, as it facilitates the collections process.
  </Step>

  <Step title="Release the Claim for Processing">
    Once all information is submitted, you can [release the claim for processing](/api-docs/case-management-api/claims/release-claim-for-processing) by setting its `submission_state` field to `released`. Our team will review the claim.
  </Step>

  <Step title="Wait for the Claim to be Accepted in a Mandate">
    Wait for the claim to be accepted in a Mandate. When accepted, the claim is added to a [Mandate](/api-docs/case-management-api/mandates/list-mandates), and its `submission_state` is set to `accepted`. Periodically check the claim's `submission_state` and `mandate` fields.
  </Step>

  <Step title="Check for Mandate Status Updates">
    Periodically [check the mandate's status updates](/api-docs/case-management-api/mandates/list-status-updates) to track progress in the collection process.
  </Step>

  <Step title="Answer Requests from paywise">
    During the collection process, paywise may send you requests for additional information or documents ("Rückfragen"). [Check for and answer these requests](/api-docs/case-management-api/mandates/list-requests-to-client-for-a-mandate) to ensure smooth processing of your mandate.
  </Step>

  <Step title="Report Payments">
    [Report payments](/api-docs/case-management-api/payments/create-a-payment) for a claim if you receive payments directly from the debtor.
  </Step>

  <Step title="Wait for our Collection Statement">
    [List your collection statements](/api-docs/case-management-api/statements/list-statements) to get full insights into your statement data (Abrechnungsdaten). All the information from our periodic statements to you is available through the API.
  </Step>
</Steps>

<Info>
  **Important:** Creating a claim (submission\_state = `created`) does not constitute acceptance of the case by paywise. A claim is only formally accepted when its `submission_state` changes to `accepted` and you receive a formal acceptance notification.
</Info>