Claims
Create a claim
POST
/
v1
/
claims
/
Copy
curl --request POST \
--url https://api.paywise.de/v1/claims/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"debtor": "5352c781-9ed1-45cc-bd15-9ec342435ae2",
"your_reference": "order-12-A-245-2022",
"document_reference": "RE-202200045",
"subject_matter": "Warenlieferung Playstation 7",
"occurence_date": "2022-09-01",
"document_date": "2022-09-01",
"due_date": "2022-09-19",
"reminder_date": "2022-09-24",
"delay_date": "2022-09-24",
"total_claim_amount": {
"value": "1202.50",
"currency": "EUR"
},
"main_claim_amount": {
"value": "1200.00",
"currency": "EUR"
},
"items": [
{
"description": "Playstation 7",
"quantity": 1,
"unit": "pcs",
"amount": {
"value": "1200.00",
"currency": "EUR"
}
}
],
"additional_charges_amount": {
"value": "2.50",
"currency": "EUR"
},
"additional_charges": [
{
"your_reference": "string",
"document_reference": "MA-2022002",
"subject_matter": "Mahngebühren 1. Mahnung",
"occurence_date": "2022-09-24",
"document_date": "2022-09-24",
"due_date": "2022-10-09",
"amount": {
"value": "2.50",
"currency": "EUR"
},
"events": [
{
"title": "Reminder delivered to debtor'\''s address.",
"occurence": "2019-09-24T06:34:43.206Z",
"your_reference": "123456789",
"description": "The reminder was delivered to the debtor'\''s home address via Deutsche Post AG. Based on information taken from tracking code DPAG-124-234543",
"type": "invoice",
"location": "Debtor home address"
},
{
"title": "Sendout of reminder via postal service",
"occurence": "2019-09-24T06:34:43.206Z",
"your_reference": "123456789",
"description": "The reminder was sent via Deutsche Post AG. Tracking code: DPAG-124-234543",
"type": "invoice",
"location": "Our office"
}
]
}
],
"payments": [
{
"your_reference": "MY-REF02",
"amount": {
"value": "105.00",
"currency": "EUR"
},
"value_date": "2023-05-24",
"metadata": [
{
"type": "invoice:reference",
"value": "RE-202200045"
}
]
},
{
"your_reference": "MY-REF01",
"amount": {
"value": "90.23",
"currency": "EUR"
},
"value_date": "2023-05-23",
"metadata": [
{
"type": "invoice:reference",
"value": "RE-202200045"
}
]
}
],
"starting_approach": "extrajudicial",
"claim_disputed": false,
"obligation_fulfilled": true,
"metadata": [
{
"type": "invoice:reference",
"value": "RE-202200045"
},
{
"type": "comment",
"value": "Der Schuldner hat auf keine unserer Kontaktanfragen reagiert."
}
],
"events": [
{
"title": "Delivery of goods",
"occurence": "2022-09-03T14:15:22Z",
"your_reference": "string",
"description": "Goods were delivered at debtors address. Based on information from DHL tracking code DHL-123-3421.",
"type": "delivery",
"location": "Debtor home address"
}
]
}'
Copy
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
Response
201 - application/json
The response is of type object
.
Copy
curl --request POST \
--url https://api.paywise.de/v1/claims/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"debtor": "5352c781-9ed1-45cc-bd15-9ec342435ae2",
"your_reference": "order-12-A-245-2022",
"document_reference": "RE-202200045",
"subject_matter": "Warenlieferung Playstation 7",
"occurence_date": "2022-09-01",
"document_date": "2022-09-01",
"due_date": "2022-09-19",
"reminder_date": "2022-09-24",
"delay_date": "2022-09-24",
"total_claim_amount": {
"value": "1202.50",
"currency": "EUR"
},
"main_claim_amount": {
"value": "1200.00",
"currency": "EUR"
},
"items": [
{
"description": "Playstation 7",
"quantity": 1,
"unit": "pcs",
"amount": {
"value": "1200.00",
"currency": "EUR"
}
}
],
"additional_charges_amount": {
"value": "2.50",
"currency": "EUR"
},
"additional_charges": [
{
"your_reference": "string",
"document_reference": "MA-2022002",
"subject_matter": "Mahngebühren 1. Mahnung",
"occurence_date": "2022-09-24",
"document_date": "2022-09-24",
"due_date": "2022-10-09",
"amount": {
"value": "2.50",
"currency": "EUR"
},
"events": [
{
"title": "Reminder delivered to debtor'\''s address.",
"occurence": "2019-09-24T06:34:43.206Z",
"your_reference": "123456789",
"description": "The reminder was delivered to the debtor'\''s home address via Deutsche Post AG. Based on information taken from tracking code DPAG-124-234543",
"type": "invoice",
"location": "Debtor home address"
},
{
"title": "Sendout of reminder via postal service",
"occurence": "2019-09-24T06:34:43.206Z",
"your_reference": "123456789",
"description": "The reminder was sent via Deutsche Post AG. Tracking code: DPAG-124-234543",
"type": "invoice",
"location": "Our office"
}
]
}
],
"payments": [
{
"your_reference": "MY-REF02",
"amount": {
"value": "105.00",
"currency": "EUR"
},
"value_date": "2023-05-24",
"metadata": [
{
"type": "invoice:reference",
"value": "RE-202200045"
}
]
},
{
"your_reference": "MY-REF01",
"amount": {
"value": "90.23",
"currency": "EUR"
},
"value_date": "2023-05-23",
"metadata": [
{
"type": "invoice:reference",
"value": "RE-202200045"
}
]
}
],
"starting_approach": "extrajudicial",
"claim_disputed": false,
"obligation_fulfilled": true,
"metadata": [
{
"type": "invoice:reference",
"value": "RE-202200045"
},
{
"type": "comment",
"value": "Der Schuldner hat auf keine unserer Kontaktanfragen reagiert."
}
],
"events": [
{
"title": "Delivery of goods",
"occurence": "2022-09-03T14:15:22Z",
"your_reference": "string",
"description": "Goods were delivered at debtors address. Based on information from DHL tracking code DHL-123-3421.",
"type": "delivery",
"location": "Debtor home address"
}
]
}'
Copy
{
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.