List mandates
List and filter your mandates
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Filter by archived status of the mandate
Filter by our ID of the debtor
Filter by the name of the debtor's organization (in case debtor is an organization and has the 'organization' object associated with it)
Filter by the first name of the debtor (in case debtor is a person has the 'person' object associated with it). Can be combined with debtor_person_last_name
Filter by the last name of the debtor (in case debtor is a person and has the 'person' object associated with it). Can be combined with debtor_person_first_name
Filter by the field your_reference of the mandate's debtor
Filter by the legal stage of the mandate
Number of results to return per page.
The initial index from which to return the results.
Filter by the payment state of the mandate
Filter by the processing state of the mandate
Filter by the reference number of the mandate
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter by archived status of the mandate
Filter by our ID of the debtor
Filter by the name of the debtor's organization (in case debtor is an organization and has the 'organization' object associated with it)
Filter by the first name of the debtor (in case debtor is a person has the 'person' object associated with it). Can be combined with debtor_person_last_name
Filter by the last name of the debtor (in case debtor is a person and has the 'person' object associated with it). Can be combined with debtor_person_first_name
Filter by the field your_reference of the mandate's debtor
Filter by the legal stage of the mandate
Number of results to return per page.
The initial index from which to return the results.
Filter by the payment state of the mandate
Filter by the processing state of the mandate
Filter by the reference number of the mandate
Response
Our case file reference number ("Aktenzeichen").<br><br>Note: Usually a mandate bears only one reference number. But there are edge cases where a mandate is assigned multiple reference numbers. If a new reference number is added to the mandate, this field is overwritten with the new reference number. This previous reference number is then added to the array of further_reference_numbers. See field below.
If a mandate bears multiple reference numbers, the most recent one is saved in reference_number above. All others will be placed here.
extrajudicial- Außergerichtlichjudicial_dunning- Gerichtliches Mahnverfahrenforeclosure- Zwangsvollstreckunglong_term_monitoring- In Langzeitüberwachungended- Beendet
extrajudicial, judicial_dunning, foreclosure, long_term_monitoring, ended in_progress- Laufendpaused- Pausiertclient_response_pending- Warte auf Mandantenantwortcanceled_by_client- Abgebrochen durch Mandantcanceled_by_service_provider- Abgebrochen durch unsended- Beendet
in_progress, paused, client_response_pending, canceled_by_client, canceled_by_service_provider, ended unpaid- Unbezahltpartially_paid- Teilweise bezahltfully_paid- Voll bezahlt
unpaid, partially_paid, fully_paid The legal claim balance of the mandate ("Forderungsstand").
The balance of the interest-bearing costs.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The balance of the interest-free costs.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The balance of the interest on the costs.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The balance of the interest on the principal claim.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The balance of the principal claim.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The current total balance of the legal claim.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The legal claim of costs interest bearing.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The legal claim of interest free costs.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The legal claim of interests on costs.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The legal claim of interests on principal claim.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The legal claim of principal claim.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The total amount of the legal claim.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The debtor's payment on interest-bearing costs.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The debtor's payment on interest-free costs.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The debtor's payment on interests on costs.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The debtor's payment on the principal claim's interest.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The debtor's payment on the principal claim.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD The total of payments on the legal claim.
A string representation of a positive integer or decimal with two decimal places.
The three-character currency code (ISO-4217).
EUR- EuroUSD- US Dollar
EUR, USD extrajudicial- Außergerichtlichjudicial_dunning- Gerichtliches Mahnverfahrenforeclosure- Zwangsvollstreckunglong_term_monitoring- In Langzeitüberwachungended- Beendet
extrajudicial, judicial_dunning, foreclosure, long_term_monitoring, ended in_progress- Laufendpaused- Pausiertclient_response_pending- Warte auf Mandantenantwortcanceled_by_client- Abgebrochen durch Mandantcanceled_by_service_provider- Abgebrochen durch unsended- Beendet
in_progress, paused, client_response_pending, canceled_by_client, canceled_by_service_provider, ended