Upload a document to a claim

POST

claims

{id}

documents

curl --request POST \
  --url https://api.paywise.de/v1/claims/{id}/documents/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "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

string

required

Body

Only used for claim document upload

file

required

A document to upload. Allowed formats are pdf, jpeg and png. Should use multipart/form-data encoding (RFC 2388).

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

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").

additional_charges.your_reference

string | null

required

Your unique reference.

Maximum length: 255

additional_charges.subject_matter

string | null

required

A description of the incidental claim. For example "Mahngebühren 1. Mahnung".

additional_charges.occurence_date

string | null

required

The date the charge was initiated. For example the date of the reminder (reminder fee) or a chargeback fee's value date.

additional_charges.document_date

string | null

required

The date of the document the charge was initiated with ("Belegdatum").

additional_charges.due_date

string | null

required

The date your additional charge was due for payment. Applicaple mainly for payment reminders. Leave empty if no due date exists (for example in case of bank fees)

additional_charges.amount

object

required

The amount of the additional charge.

additional_charges.id

string

additional_charges.type

reminder_fee - Mahngebühr
bank_charge - Bankgebühr
processing_fee - Bearbeitungsgebühr
cancellation_fee - Abbruch-/Stornierungsgebühr
convenience_fee - Convenience fee
advisory_fee - Advisory fee
handling_fee - Handling fee
insurance_fee - Insurance fee
legal_fee - Legal fee
delivery_charge - Delivery charge
service_charge - Service charge
data_preparation - Data preparation
communication_cost - Communication cost
expenses - Expenses

Available options:

reminder_fee,

bank_charge,

processing_fee,

cancellation_fee,

convenience_fee,

advisory_fee,

handling_fee,

insurance_fee,

legal_fee,

delivery_charge,

service_charge,

data_preparation,

communication_cost,

expenses

additional_charges.metadata

object[]

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

Metadata for debtors

additional_charges.metadata.type

enum<string>

required

comment - comment
invoice:reference - invoice:reference
invoice:date - invoice:date
invoice:address_line_1 - invoice:address_line_1
invoice:address_line_2 - invoice:address_line_2
invoice:address_city - invoice:address_city
invoice:address_country - invoice:address_country
invoice:address_zip - invoice:address_zip
invoice:amount - invoice:amount
transaction:reference - transaction:reference
transaction:source_ip_address - transaction:source_ip_address
contract:reference - contract:reference
report:reference - report:reference
account:reference - account:reference
claim:holder:address:country - claim:holder:address:country
claim:holder:address:city - claim:holder:address:city
claim:holder:name - claim:holder:name
dunning:level - dunning:level
reminder:date - reminder:date
reminder:amount:value - reminder:amount:value
reminder:amount:currency - reminder:amount:currency
notification:date - notification:date
confirmation:email - confirmation:email
order:rate - order:rate
order:deposit - order:deposit
order:cashback - order:cashback
order:prepaid - order:prepaid
order:type - order:type
rental:pickup:date - rental:pickup:date
rental:pickup:time - rental:pickup:time
rental:pickup:city - rental:pickup:city
rental:dropoff:date - rental:dropoff:date
rental:dropoff:time - rental:dropoff:time
rental:dropoff:city - rental:dropoff:city
rental:gps_tracking - rental:gps_tracking
rental:charged_items - rental:charged_items
payment:method - payment:method
import:csv:filename - import:csv:filename
insurance:bonus_malus_system - insurance:bonus_malus_system
insurance:contribution_rate - insurance:contribution_rate
insurance:regional_class_liability_insurance - insurance:regional_class_liability_insurance
insurance:regional_class_partial_coverage - insurance:regional_class_partial_coverage
payment:frequency - payment:frequency
language - language
tax:id - tax:id
notification_delivery:date - notification_delivery:date
merchant:address_line1 - merchant:address_line1
merchant:address_city - merchant:address_city
merchant:address_zip - merchant:address_zip
merchant:address_country - merchant:address_country
merchant:company_name - merchant:company_name
merchant:company_type - merchant:company_type
merchant:representative_firstname - merchant:representative_firstname
merchant:representative_secondname - merchant:representative_secondname
merchant:website_url - merchant:website_url
chargeback:reason - chargeback:reason
shop:website_url - shop:website_url
subscription:overdue_period - subscription:overdue_period
subscription:duration - subscription:duration
subscription:start - subscription:start
subscription:delivery:address - subscription:delivery:address
subscription:reference - subscription:reference
subscription:renewal - subscription:renewal
subscription:last_login - subscription:last_login
subscription:photo_available - subscription:photo_available
subscription:type - subscription:type
subscription:termination - subscription:termination
medical:patient - medical:patient
debtor:file_id - debtor:file_id
email:seller - email:seller
name:seller - name:seller
addressline:seller - addressline:seller
zip:seller - zip:seller
city:seller - city:seller
name:ditsributor - name:ditsributor
email:distributor - email:distributor
addressline:distributor - addressline:distributor
zip:distributor - zip:distributor
city:distributor - city:distributor
logo:distributor_pdf - logo:distributor_pdf
logo:distributor_email - logo:distributor_email
account:beneficiary - account:beneficiary
purchase:price - purchase:price
conditional:purchase_price - conditional:purchase_price
direct:payments - direct:payments
VAT - VAT
product:type - product:type

Available options:

comment,

invoice:reference,

invoice:date,

invoice:address_line_1,

invoice:address_line_2,

invoice:address_city,

invoice:address_country,

invoice:address_zip,

invoice:amount,

transaction:reference,

transaction:source_ip_address,

contract:reference,

report:reference,

account:reference,

claim:holder:address:country,

claim:holder:address:city,

claim:holder:name,

dunning:level,

reminder:date,

reminder:amount:value,

reminder:amount:currency,

notification:date,

confirmation:email,

order:rate,

order:deposit,

order:cashback,

order:prepaid,

order:type,

rental:pickup:date,

rental:pickup:time,

rental:pickup:city,

rental:dropoff:date,

rental:dropoff:time,

rental:dropoff:city,

rental:gps_tracking,

rental:charged_items,

payment:method,

import:csv:filename,

insurance:bonus_malus_system,

insurance:contribution_rate,

insurance:regional_class_liability_insurance,

insurance:regional_class_partial_coverage,

payment:frequency,

language,

tax:id,

notification_delivery:date,

merchant:address_line1,

merchant:address_city,

merchant:address_zip,

merchant:address_country,

merchant:company_name,

merchant:company_type,

merchant:representative_firstname,

merchant:representative_secondname,

merchant:website_url,

chargeback:reason,

shop:website_url,

subscription:overdue_period,

subscription:duration,

subscription:start,

subscription:delivery:address,

subscription:reference,

subscription:renewal,

subscription:last_login,

subscription:photo_available,

subscription:type,

subscription:termination,

medical:patient,

debtor:file_id,

email:seller,

name:seller,

addressline:seller,

zip:seller,

city:seller,

name:ditsributor,

email:distributor,

addressline:distributor,

zip:distributor,

city:distributor,

logo:distributor_pdf,

logo:distributor_email,

account:beneficiary,

purchase:price,

conditional:purchase_price,

direct:payments,

VAT,

product:type

additional_charges.metadata.value

string

required

Maximum length: 255

additional_charges.events

object[]

Events regarding the additional charge. See request/response examples.

Event for debtors

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

metadata.type

enum<string>

required

comment - comment
invoice:reference - invoice:reference
invoice:date - invoice:date
invoice:address_line_1 - invoice:address_line_1
invoice:address_line_2 - invoice:address_line_2
invoice:address_city - invoice:address_city
invoice:address_country - invoice:address_country
invoice:address_zip - invoice:address_zip
invoice:amount - invoice:amount
transaction:reference - transaction:reference
transaction:source_ip_address - transaction:source_ip_address
contract:reference - contract:reference
report:reference - report:reference
account:reference - account:reference
claim:holder:address:country - claim:holder:address:country
claim:holder:address:city - claim:holder:address:city
claim:holder:name - claim:holder:name
dunning:level - dunning:level
reminder:date - reminder:date
reminder:amount:value - reminder:amount:value
reminder:amount:currency - reminder:amount:currency
notification:date - notification:date
confirmation:email - confirmation:email
order:rate - order:rate
order:deposit - order:deposit
order:cashback - order:cashback
order:prepaid - order:prepaid
order:type - order:type
rental:pickup:date - rental:pickup:date
rental:pickup:time - rental:pickup:time
rental:pickup:city - rental:pickup:city
rental:dropoff:date - rental:dropoff:date
rental:dropoff:time - rental:dropoff:time
rental:dropoff:city - rental:dropoff:city
rental:gps_tracking - rental:gps_tracking
rental:charged_items - rental:charged_items
payment:method - payment:method
import:csv:filename - import:csv:filename
insurance:bonus_malus_system - insurance:bonus_malus_system
insurance:contribution_rate - insurance:contribution_rate
insurance:regional_class_liability_insurance - insurance:regional_class_liability_insurance
insurance:regional_class_partial_coverage - insurance:regional_class_partial_coverage
payment:frequency - payment:frequency
language - language
tax:id - tax:id
notification_delivery:date - notification_delivery:date
merchant:address_line1 - merchant:address_line1
merchant:address_city - merchant:address_city
merchant:address_zip - merchant:address_zip
merchant:address_country - merchant:address_country
merchant:company_name - merchant:company_name
merchant:company_type - merchant:company_type
merchant:representative_firstname - merchant:representative_firstname
merchant:representative_secondname - merchant:representative_secondname
merchant:website_url - merchant:website_url
chargeback:reason - chargeback:reason
shop:website_url - shop:website_url
subscription:overdue_period - subscription:overdue_period
subscription:duration - subscription:duration
subscription:start - subscription:start
subscription:delivery:address - subscription:delivery:address
subscription:reference - subscription:reference
subscription:renewal - subscription:renewal
subscription:last_login - subscription:last_login
subscription:photo_available - subscription:photo_available
subscription:type - subscription:type
subscription:termination - subscription:termination
medical:patient - medical:patient
debtor:file_id - debtor:file_id
email:seller - email:seller
name:seller - name:seller
addressline:seller - addressline:seller
zip:seller - zip:seller
city:seller - city:seller
name:ditsributor - name:ditsributor
email:distributor - email:distributor
addressline:distributor - addressline:distributor
zip:distributor - zip:distributor
city:distributor - city:distributor
logo:distributor_pdf - logo:distributor_pdf
logo:distributor_email - logo:distributor_email
account:beneficiary - account:beneficiary
purchase:price - purchase:price
conditional:purchase_price - conditional:purchase_price
direct:payments - direct:payments
VAT - VAT
product:type - product:type

Available options:

comment,

invoice:reference,

invoice:date,

invoice:address_line_1,

invoice:address_line_2,

invoice:address_city,

invoice:address_country,

invoice:address_zip,

invoice:amount,

transaction:reference,

transaction:source_ip_address,

contract:reference,

report:reference,

account:reference,

claim:holder:address:country,

claim:holder:address:city,

claim:holder:name,

dunning:level,

reminder:date,

reminder:amount:value,

reminder:amount:currency,

notification:date,

confirmation:email,

order:rate,

order:deposit,

order:cashback,

order:prepaid,

order:type,

rental:pickup:date,

rental:pickup:time,

rental:pickup:city,

rental:dropoff:date,

rental:dropoff:time,

rental:dropoff:city,

rental:gps_tracking,

rental:charged_items,

payment:method,

import:csv:filename,

insurance:bonus_malus_system,

insurance:contribution_rate,

insurance:regional_class_liability_insurance,

insurance:regional_class_partial_coverage,

payment:frequency,

language,

tax:id,

notification_delivery:date,

merchant:address_line1,

merchant:address_city,

merchant:address_zip,

merchant:address_country,

merchant:company_name,

merchant:company_type,

merchant:representative_firstname,

merchant:representative_secondname,

merchant:website_url,

chargeback:reason,

shop:website_url,

subscription:overdue_period,

subscription:duration,

subscription:start,

subscription:delivery:address,

subscription:reference,

subscription:renewal,

subscription:last_login,

subscription:photo_available,

subscription:type,

subscription:termination,

medical:patient,

debtor:file_id,

email:seller,

name:seller,

addressline:seller,

zip:seller,

city:seller,

name:ditsributor,

email:distributor,

addressline:distributor,

zip:distributor,

city:distributor,

logo:distributor_pdf,

logo:distributor_email,

account:beneficiary,

purchase:price,

conditional:purchase_price,

direct:payments,

VAT,

product:type

metadata.value

string

required

Maximum length: 255

events

object[]

Events regarding the claim. See request/response examples.

Event for claims

Release claim for processing List debtors

curl --request POST \
  --url https://api.paywise.de/v1/claims/{id}/documents/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "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"
}

Case Management API

Claims

Debtors

Mandates

Payments

Token Info

Authorizations

Path Parameters

Body

Response