PATCH
/
v1
/
claims
/
{id}
curl --request PATCH \
  --url https://api.paywise.de/v1/claims/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "submission_state": "released"
}'
{
  "href": "<string>",
  "id": "<string>",
  "submission_state": "created",
  "debtor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mandate": {
    "href": "<string>",
    "id": "<string>",
    "reference_number": "<string>"
  },
  "your_reference": "<string>",
  "subject_matter": "<string>",
  "occurence_date": "2023-12-25",
  "document_reference": "<string>",
  "document_date": "2023-12-25",
  "due_date": "2023-12-25",
  "reminder_date": "2023-12-25",
  "delay_date": "2023-12-25",
  "total_claim_amount": {
    "value": "<string>",
    "currency": "EUR"
  },
  "main_claim_amount": {
    "value": "<string>",
    "currency": "EUR"
  },
  "items": [
    {
      "description": "<string>",
      "quantity": 123,
      "unit": "<string>",
      "amount": {
        "value": "<string>",
        "currency": "EUR"
      }
    }
  ],
  "additional_charges_amount": {
    "value": "<string>",
    "currency": "EUR"
  },
  "additional_charges": [
    {
      "id": "<string>",
      "type": "reminder_fee",
      "your_reference": "<string>",
      "subject_matter": "<string>",
      "occurence_date": "2023-12-25",
      "document_date": "2023-12-25",
      "due_date": "2023-12-25",
      "amount": {
        "value": "<string>",
        "currency": "EUR"
      },
      "metadata": [
        {
          "type": "comment",
          "value": "<string>"
        }
      ],
      "events": [
        {
          "type": "invoice",
          "title": "<string>",
          "occurence": "2023-11-07T05:31:56Z",
          "your_reference": "<string>",
          "description": "<string>",
          "location": "<string>"
        }
      ]
    }
  ],
  "payments": [
    {
      "href": "<string>",
      "your_reference": "<string>",
      "amount": {
        "value": "<string>",
        "currency": "EUR"
      },
      "value_date": "2023-12-25",
      "metadata": [
        {
          "type": "comment",
          "value": "<string>"
        }
      ],
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "starting_approach": "extrajudicial",
  "claim_disputed": true,
  "obligation_fulfilled": true,
  "documents": [
    {
      "id": "<string>",
      "mime_type": "<string>",
      "filename": "<string>"
    }
  ],
  "metadata": [
    {
      "type": "comment",
      "value": "<string>"
    }
  ],
  "events": [
    {
      "type": "claim",
      "title": "<string>",
      "occurence": "2023-11-07T05:31:56Z",
      "your_reference": "<string>",
      "description": "<string>",
      "location": "<string>"
    }
  ],
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

Response

200 - application/json

The response is of type object.