POST
/
v1
/
claims
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"
    }
  ]
}'
{
  "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

​
debtor
string
required

Your existing debtor's ID.

​
your_reference
string | null
required

Your unique reference.

Maximum length: 255
​
subject_matter
string | null
required

A detailed description of the delivered goods or the provided service.

​
occurence_date
string | null
required

The date of emergence of the principal claim ("Vertragsdatum").

​
document_reference
string | null
required

The unique reference of your invoice ("Rechnungsnummer"), contract ("Vertragsnummer") or other document ("Belegnummer").

Maximum length: 255
​
document_date
string | null
required

The date of your invoice ("Rechnungsdatum"), contract ("Vertragsdatum") or other document ("Belegdatum").

​
due_date
string | null
required

The date your claim was due for payment.

​
reminder_date
string | null
required

The date of your first reminder ("Mahnung") to your customer. Please note: the date of a "Zahlungserinnerung" does not qualify. It must be a "Mahnung" by german standards.

​
delay_date
string | null
required

The date from which your debtor is in delay ("Verzugsdatum"). Please check back with our team if you are unsure what to place here.

​
total_claim_amount
object
required

The total open amount of the claim, including additional charges. Equals the sum of the main claim amount and the sum of all additional charges' amounts - minus any payments you already received on the claim.

​
main_claim_amount
object
required

The original amount of the principal claim including VAT or sales tax. Does not have any additional charges added or payments subtracted.

​
starting_approach
enum<string>
required

Our starting approach to collect the claim: extrajudicial ("außergerichtlich") or judicial ("gerichtliches Mahnverfahren").

  • extrajudicial - Zunächst außergerichtlich starten
  • judicial - Gleich Mahnbescheid beantragen
Available options:
extrajudicial,
judicial
​
claim_disputed
boolean
required

Tell us if the claim was disputed by your customer. If you are unsure what to select here, please check back with our team.

  • True - Ja
  • False - Nein
​
obligation_fulfilled
boolean
required

Tell us if you fully fulfilled your contractual obligation towards the debtor. If you are unsure what to select here, please check back with our team.

  • True - Ja
  • False - Nein
​
items
object[]

The items listed on your invoice or contract ("Rechnungsposten" or "Leistungen")

Main claim items do not have fields occurence_date and document_date

​
additional_charges_amount
object

The sum of all additional charges of the claim.

​
additional_charges
object[]

Additional charges for your claim ("incidental claims" or "Nebenforderungen"). Those are typically reminder fees ("Mahngebühren") or bank charges for chargebacks ("Rücklastschriftgebühren").

​
payments
object[]

Any payments you have received for your claim so far.

A payment associated for a claim

​
metadata
object[]

The metadata object allows you to submit additional relevant information related to the claim as type/value pairs. You can submit an unlimited number of metadata sets.

Metadata for debtors

​
events
object[]

Events regarding the claim. See request/response examples.

Event for claims

Response

201 - application/json
​
href
string
required
​
submission_state
enum<string>
required
  • created - Created
  • released - Released for processing
  • under_review - Under review
  • client_response_pending - Pending client response
  • accepted - Accepted
  • rejected - Rejected
Available options:
created,
released,
under_review,
client_response_pending,
accepted,
rejected
​
debtor
string
required

Your existing debtor's ID.

​
mandate
object
required

After a submitted claim was accepted by our team, it is added to a mandate.

​
your_reference
string | null
required

Your unique reference.

Maximum length: 255
​
subject_matter
string | null
required

A detailed description of the delivered goods or the provided service.

​
occurence_date
string | null
required

The date of emergence of the principal claim ("Vertragsdatum").

​
document_reference
string | null
required

The unique reference of your invoice ("Rechnungsnummer"), contract ("Vertragsnummer") or other document ("Belegnummer").

Maximum length: 255
​
document_date
string | null
required

The date of your invoice ("Rechnungsdatum"), contract ("Vertragsdatum") or other document ("Belegdatum").

​
due_date
string | null
required

The date your claim was due for payment.

​
reminder_date
string | null
required

The date of your first reminder ("Mahnung") to your customer. Please note: the date of a "Zahlungserinnerung" does not qualify. It must be a "Mahnung" by german standards.

​
delay_date
string | null
required

The date from which your debtor is in delay ("Verzugsdatum"). Please check back with our team if you are unsure what to place here.

​
total_claim_amount
object
required

The total open amount of the claim, including additional charges. Equals the sum of the main claim amount and the sum of all additional charges' amounts - minus any payments you already received on the claim.

​
main_claim_amount
object
required

The original amount of the principal claim including VAT or sales tax. Does not have any additional charges added or payments subtracted.

​
starting_approach
enum<string>
required

Our starting approach to collect the claim: extrajudicial ("außergerichtlich") or judicial ("gerichtliches Mahnverfahren").

  • extrajudicial - Zunächst außergerichtlich starten
  • judicial - Gleich Mahnbescheid beantragen
Available options:
extrajudicial,
judicial
​
claim_disputed
boolean
required

Tell us if the claim was disputed by your customer. If you are unsure what to select here, please check back with our team.

  • True - Ja
  • False - Nein
​
obligation_fulfilled
boolean
required

Tell us if you fully fulfilled your contractual obligation towards the debtor. If you are unsure what to select here, please check back with our team.

  • True - Ja
  • False - Nein
​
documents
object[]
required

Documents relevant for processing of the claim. Usually invoices, reminders, contracts or correspondence with the debtor.

​
created
string
required
​
updated
string
required
​
id
string
​
items
object[]

The items listed on your invoice or contract ("Rechnungsposten" or "Leistungen")

Main claim items do not have fields occurence_date and document_date

​
additional_charges_amount
object

The sum of all additional charges of the claim.

​
additional_charges
object[]

Additional charges for your claim ("incidental claims" or "Nebenforderungen"). Those are typically reminder fees ("Mahngebühren") or bank charges for chargebacks ("Rücklastschriftgebühren").

​
payments
object[]

Any payments you have received for your claim so far.

A payment associated for a claim

​
metadata
object[]

The metadata object allows you to submit additional relevant information related to the claim as type/value pairs. You can submit an unlimited number of metadata sets.

Metadata for debtors

​
events
object[]

Events regarding the claim. See request/response examples.

Event for claims