Archive a mandate
Set mandate’s archived status by modifying it’s field archived.
Mandates that are archived, are displayed under their own category in the mandates list view in the webinterface.
Changing this property does not affect any business logic on our side. This means, that archiving a running mandate will not stop us from further processing it. Unarchiving on the other hand will not re-activate a closed mandate.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Response
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").
Amount
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.