List claims
List your claims.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Filter by claim_disputed value of the claim
Filter by the delay_date of the claim
Filter by the document_reference of the claim
Filter by the due_date of the claim
Filter by our ID of the claim
Number of results to return per page.
Filter by the obligation_fulfilled value of the claim
The initial index from which to return the results.
Filter by the reminder_date of the claim
Filter by the starting_approach of the claim
Filter by the subject_matter of the claim
Filter by the submission_state of the claim
Filter by your_reference of the claim
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter by claim_disputed value of the claim
Filter by the delay_date of the claim
Filter by the document_reference of the claim
Filter by the due_date of the claim
Filter by our ID of the claim
Number of results to return per page.
Filter by the obligation_fulfilled value of the claim
The initial index from which to return the results.
Filter by the reminder_date of the claim
Filter by the starting_approach of the claim
Filter by the subject_matter of the claim
Filter by the submission_state of the claim
Filter by your_reference of the claim
Response
created- Createdreleased- Released for processingunder_review- Under reviewclient_response_pending- Pending client responseaccepted- Acceptedrejected- Rejected
created, released, under_review, client_response_pending, accepted, rejected Your existing debtor's ID.
Your unique reference.
255A detailed description of the delivered goods or the provided service.
The date of emergence of the principal claim ("Vertragsdatum").
The unique reference of your invoice ("Rechnungsnummer"), contract ("Vertragsnummer") or other document ("Belegnummer").
255The date of your invoice ("Rechnungsdatum"), contract ("Vertragsdatum") or other document ("Belegdatum").
The date your claim was due for payment.
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.
The date from which your debtor is in delay ("Verzugsdatum"). Please check back with our team if you are unsure what to place here.
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.
The original amount of the principal claim including VAT or sales tax. Does not have any additional charges added or payments subtracted.
The items listed on your invoice or contract ("Rechnungsposten" or "Leistungen")
A description of the item.
1000The quantity of the item. Usually a number of pieces or hours.
The unit used to measure the quantity of the item. Examples are: "pcs" ("pieces"), "hours", "kg" (kilograms)
255The amount invoices for the item ("Betrag des Rechnungspostens").
The sum of all additional charges of the claim.
Additional charges for your claim ("incidental claims" or "Nebenforderungen"). Those are typically reminder fees ("Mahngebühren") or bank charges for chargebacks ("Rücklastschriftgebühren").
reminder_fee- Mahngebührbank_charge- Bankgebührprocessing_fee- Bearbeitungsgebührcancellation_fee- Abbruch-/Stornierungsgebührconvenience_fee- Convenience feeadvisory_fee- Advisory feehandling_fee- Handling feeinsurance_fee- Insurance feelegal_fee- Legal feedelivery_charge- Delivery chargeservice_charge- Service chargedata_preparation- Data preparationcommunication_cost- Communication costexpenses- Expenses
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 Your unique reference.
255A description of the incidental claim. For example "Mahngebühren 1. Mahnung".
The date the charge was initiated. For example the date of the reminder (reminder fee) or a chargeback fee's value date.
The date of the document the charge was initiated with ("Belegdatum").
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)
The amount of the additional charge.
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.
comment- commentinvoice:reference- invoice:referenceinvoice:date- invoice:dateinvoice:address_line_1- invoice:address_line_1invoice:address_line_2- invoice:address_line_2invoice:address_city- invoice:address_cityinvoice:address_country- invoice:address_countryinvoice:address_zip- invoice:address_zipinvoice:amount- invoice:amounttransaction:reference- transaction:referencetransaction:source_ip_address- transaction:source_ip_addresscontract:reference- contract:referencereport:reference- report:referenceaccount:reference- account:referenceclaim:holder:address:country- claim:holder:address:countryclaim:holder:address:city- claim:holder:address:cityclaim:holder:name- claim:holder:namedunning:level- dunning:levelreminder:date- reminder:datereminder:amount:value- reminder:amount:valuereminder:amount:currency- reminder:amount:currencynotification:date- notification:dateconfirmation:email- confirmation:emailorder:rate- order:rateorder:deposit- order:depositorder:cashback- order:cashbackorder:prepaid- order:prepaidorder:type- order:typerental:pickup:date- rental:pickup:daterental:pickup:time- rental:pickup:timerental:pickup:city- rental:pickup:cityrental:dropoff:date- rental:dropoff:daterental:dropoff:time- rental:dropoff:timerental:dropoff:city- rental:dropoff:cityrental:gps_tracking- rental:gps_trackingrental:charged_items- rental:charged_itemspayment:method- payment:methodimport:csv:filename- import:csv:filenameinsurance:bonus_malus_system- insurance:bonus_malus_systeminsurance:contribution_rate- insurance:contribution_rateinsurance:regional_class_liability_insurance- insurance:regional_class_liability_insuranceinsurance:regional_class_partial_coverage- insurance:regional_class_partial_coveragepayment:frequency- payment:frequencylanguage- languagetax:id- tax:idnotification_delivery:date- notification_delivery:datemerchant:address_line1- merchant:address_line1merchant:address_city- merchant:address_citymerchant:address_zip- merchant:address_zipmerchant:address_country- merchant:address_countrymerchant:company_name- merchant:company_namemerchant:company_type- merchant:company_typemerchant:representative_firstname- merchant:representative_firstnamemerchant:representative_secondname- merchant:representative_secondnamemerchant:website_url- merchant:website_urlchargeback:reason- chargeback:reasonshop:website_url- shop:website_urlsubscription:overdue_period- subscription:overdue_periodsubscription:duration- subscription:durationsubscription:start- subscription:startsubscription:delivery:address- subscription:delivery:addresssubscription:reference- subscription:referencesubscription:renewal- subscription:renewalsubscription:last_login- subscription:last_loginsubscription:photo_available- subscription:photo_availablesubscription:type- subscription:typesubscription:termination- subscription:terminationmedical:patient- medical:patientdebtor:file_id- debtor:file_idemail:seller- email:sellername:seller- name:selleraddressline:seller- addressline:sellerzip:seller- zip:sellercity:seller- city:sellername:ditsributor- name:ditsributoremail:distributor- email:distributoraddressline:distributor- addressline:distributorzip:distributor- zip:distributorcity:distributor- city:distributorlogo:distributor_pdf- logo:distributor_pdflogo:distributor_email- logo:distributor_emailaccount:beneficiary- account:beneficiarypurchase:price- purchase:priceconditional:purchase_price- conditional:purchase_pricedirect:payments- direct:paymentsVAT- VATproduct:type- product:type
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 255Events regarding the additional charge. See request/response examples.
invoice- invoicetransaction- transaction
invoice, transaction 255255255255Any payments you have received for your claim so far.
Your unique reference.
255The value date of the payment.
The metadata object allows you to submit additional relevant information related to the payment as type/value pairs. You can submit an unlimited number of metadata sets.
comment- commentinvoice:reference- invoice:referenceinvoice:update_and_capture- invoice:update_and_capturetransaction:reference- transaction:referencecontract:reference- contract:referencereport:reference- report:referencecontravention:reference- contravention:reference
comment, invoice:reference, invoice:update_and_capture, transaction:reference, contract:reference, report:reference, contravention:reference 255Our starting approach to collect the claim: extrajudicial ("außergerichtlich") or judicial ("gerichtliches Mahnverfahren").
extrajudicial- Zunächst außergerichtlich startenjudicial- Gleich Mahnbescheid beantragen
extrajudicial, judicial 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- JaFalse- Nein
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- JaFalse- Nein
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.
comment- commentinvoice:reference- invoice:referenceinvoice:date- invoice:dateinvoice:address_line_1- invoice:address_line_1invoice:address_line_2- invoice:address_line_2invoice:address_city- invoice:address_cityinvoice:address_country- invoice:address_countryinvoice:address_zip- invoice:address_zipinvoice:amount- invoice:amounttransaction:reference- transaction:referencetransaction:source_ip_address- transaction:source_ip_addresscontract:reference- contract:referencereport:reference- report:referenceaccount:reference- account:referenceclaim:holder:address:country- claim:holder:address:countryclaim:holder:address:city- claim:holder:address:cityclaim:holder:name- claim:holder:namedunning:level- dunning:levelreminder:date- reminder:datereminder:amount:value- reminder:amount:valuereminder:amount:currency- reminder:amount:currencynotification:date- notification:dateconfirmation:email- confirmation:emailorder:rate- order:rateorder:deposit- order:depositorder:cashback- order:cashbackorder:prepaid- order:prepaidorder:type- order:typerental:pickup:date- rental:pickup:daterental:pickup:time- rental:pickup:timerental:pickup:city- rental:pickup:cityrental:dropoff:date- rental:dropoff:daterental:dropoff:time- rental:dropoff:timerental:dropoff:city- rental:dropoff:cityrental:gps_tracking- rental:gps_trackingrental:charged_items- rental:charged_itemspayment:method- payment:methodimport:csv:filename- import:csv:filenameinsurance:bonus_malus_system- insurance:bonus_malus_systeminsurance:contribution_rate- insurance:contribution_rateinsurance:regional_class_liability_insurance- insurance:regional_class_liability_insuranceinsurance:regional_class_partial_coverage- insurance:regional_class_partial_coveragepayment:frequency- payment:frequencylanguage- languagetax:id- tax:idnotification_delivery:date- notification_delivery:datemerchant:address_line1- merchant:address_line1merchant:address_city- merchant:address_citymerchant:address_zip- merchant:address_zipmerchant:address_country- merchant:address_countrymerchant:company_name- merchant:company_namemerchant:company_type- merchant:company_typemerchant:representative_firstname- merchant:representative_firstnamemerchant:representative_secondname- merchant:representative_secondnamemerchant:website_url- merchant:website_urlchargeback:reason- chargeback:reasonshop:website_url- shop:website_urlsubscription:overdue_period- subscription:overdue_periodsubscription:duration- subscription:durationsubscription:start- subscription:startsubscription:delivery:address- subscription:delivery:addresssubscription:reference- subscription:referencesubscription:renewal- subscription:renewalsubscription:last_login- subscription:last_loginsubscription:photo_available- subscription:photo_availablesubscription:type- subscription:typesubscription:termination- subscription:terminationmedical:patient- medical:patientdebtor:file_id- debtor:file_idemail:seller- email:sellername:seller- name:selleraddressline:seller- addressline:sellerzip:seller- zip:sellercity:seller- city:sellername:ditsributor- name:ditsributoremail:distributor- email:distributoraddressline:distributor- addressline:distributorzip:distributor- zip:distributorcity:distributor- city:distributorlogo:distributor_pdf- logo:distributor_pdflogo:distributor_email- logo:distributor_emailaccount:beneficiary- account:beneficiarypurchase:price- purchase:priceconditional:purchase_price- conditional:purchase_pricedirect:payments- direct:paymentsVAT- VATproduct:type- product:type
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 255Events regarding the claim. See request/response examples.
claim- claimdelivery- delivery
claim, delivery 255255255255