List claims

Claims addressed by their stable UUID and current relationships.

Read claims throughout their lifecycle using URLs that remain valid after internal order moves. Standalone creation requires a draft order_id; the relationship is read-only thereafter. Create, PATCH, and DELETE require a draft order and otherwise return 409 claim_not_editable. An expired draft instead returns 409 order_expired. Tenant-scoped by the authenticated company.

GET /v2/claims/

List claims

Python

import requests

url = "https://api.paywise.de/v2/claims/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "count": 123,
  "results": [
    {
      "additional_charges": [
        {
          "amount": {
            "currency": "EUR",
            "value": "<string>"
          },
          "events": [
            {
              "description": "<string>",
              "location": "<string>",
              "occurence": "2023-11-07T05:31:56Z",
              "title": "<string>",
              "type": "<string>",
              "your_reference": "<string>"
            }
          ],
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "metadata": [
            {
              "type": "<string>",
              "value": "<string>"
            }
          ],
          "occurrence_date": "2023-12-25",
          "subject_matter": "<string>",
          "type": "reminder_fee",
          "your_reference": "<string>"
        }
      ],
      "additional_charges_amount": {
        "currency": "EUR",
        "value": "<string>"
      },
      "additional_debtor_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "debtor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "delay_date": "2023-12-25",
      "dispute_reason": "<string>",
      "document_date": "2023-12-25",
      "document_reference": "<string>",
      "documents": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "download_url": "<string>",
          "failure_reason": "page_limit_exceeded",
          "filename": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "mime_type": "<string>",
          "parent": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "claim"
          },
          "status": "pending",
          "type": "bank_statement",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "due_date": "2023-12-25",
      "events": [
        {
          "description": "<string>",
          "location": "<string>",
          "occurence": "2023-11-07T05:31:56Z",
          "title": "<string>",
          "type": "<string>",
          "your_reference": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_disputed": true,
      "items": [
        {
          "amount": {
            "currency": "EUR",
            "value": "<string>"
          },
          "description": "<string>",
          "quantity": "<string>",
          "unit": "<string>",
          "unit_price": {
            "currency": "EUR",
            "value": "<string>"
          }
        }
      ],
      "legal_basis": {
        "claim_type_code": "<string>",
        "contract_date": "2023-12-25",
        "description": "<string>"
      },
      "mandate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": [
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payments": [
        {
          "amount": {
            "currency": "<string>",
            "value": "<string>"
          },
          "claim": {
            "document_reference": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "your_reference": "<string>"
          },
          "created_at": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "mandate": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "reference_number": "<string>"
          },
          "metadata": [
            {
              "type": "<string>",
              "value": "<string>"
            }
          ],
          "updated_at": "2023-11-07T05:31:56Z",
          "value_date": "2023-12-25",
          "your_reference": "<string>"
        }
      ],
      "principal_amount": {
        "currency": "EUR",
        "value": "<string>"
      },
      "reminders": [
        {
          "date": "2023-12-25",
          "due_date": "2023-12-25",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "status": "draft",
      "subject_matter": "<string>",
      "total_amount": {
        "currency": "EUR",
        "value": "<string>"
      },
      "type": "receivable",
      "updated_at": "2023-11-07T05:31:56Z",
      "your_reference": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

caseBearerAuthpartnerBearerAuth

Authorization · string · header · required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company · string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Query Parameters

cursor · string

Opaque continuation cursor for incremental synchronization, taken from the next URL of a previous page. Only valid together with updated_since: with updated_since set the list is ordered by change time and then id and pages by this cursor instead of offset, so a row that changes while you page is returned again later instead of pushing another row out of the result. Rows changed less than 60 seconds ago are held back until they are settled; use the largest updated_at you received as the next updated_since.

document_reference · string

Exact match on the document reference (e.g. the invoice number), ignoring case and surrounding whitespace.

limit · integer · default: 10

Number of results to return (maximum 100).

Required range: 1 <= x <= 100

offset · integer · default: 0

Zero-based result offset. Cannot be combined with updated_since; follow the next URL (cursor) instead.

Required range: x >= 0

order_id · string<uuid>

Filter claims by their parent order's UUID.

status · enum<string>

• draft - draft
• submitted - submitted
• awaiting_client_response - awaiting_client_response
• accepted - accepted
• rejected - rejected
• withdrawn - withdrawn

Available options: accepted, awaiting_client_response, draft, rejected, submitted, withdrawn

updated_since · string<date-time>

Return rows changed at or after this timezone-aware RFC 3339 timestamp. Results are ordered by updated_at and id (a requested ordering is ignored), page by cursor instead of offset, and rows changed less than a minute ago are held back.

your_reference · string

Exact match on your claim reference, ignoring case and surrounding whitespace.

Response

200

application/json

count · integer · required

Total number of matching resources.

Example:

123

results · (Receivable claim · object | Titled claim · object)[] · required

Resources returned for the requested page.

A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.

Receivable claim

Titled claim

Show child attributes

next · string<uri> | null

URL for the next page, or null when this is the last page. With updated_since it carries an opaque cursor.

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous · string<uri> | null

URL for the previous page, or null when this is the first page. Always null with updated_since.

Example:

"http://api.example.org/accounts/?offset=200&limit=100"