PATCH
/
v1
/
mandates
/
{id}
/
Archive a mandate
curl --request PATCH \
  --url https://api.paywise.de/v1/mandates/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "archived": true
}'
{
  "href": "<string>",
  "id": "<string>",
  "reference_number": "<string>",
  "further_reference_numbers": [
    "<string>"
  ],
  "debtor": {
    "name": "<string>"
  },
  "legal_stage": "extrajudicial",
  "processing_state": "in_progress",
  "payment_state": "unpaid",
  "legal_claim_balance": {
    "balance_of_costs_interest_bearing": {
      "value": "<string>",
      "currency": "EUR"
    },
    "balance_of_costs_interest_free": {
      "value": "<string>",
      "currency": "EUR"
    },
    "balance_of_interest_on_costs": {
      "value": "<string>",
      "currency": "EUR"
    },
    "balance_of_interest_on_principal_claim": {
      "value": "<string>",
      "currency": "EUR"
    },
    "balance_of_principal_claim": {
      "value": "<string>",
      "currency": "EUR"
    },
    "total_balance": {
      "value": "<string>",
      "currency": "EUR"
    },
    "legal_claim_of_costs_interest_bearing": {
      "value": "<string>",
      "currency": "EUR"
    },
    "legal_claim_of_costs_interest_free": {
      "value": "<string>",
      "currency": "EUR"
    },
    "legal_claim_of_interest_on_costs": {
      "value": "<string>",
      "currency": "EUR"
    },
    "legal_claim_of_interest_on_principal_claim": {
      "value": "<string>",
      "currency": "EUR"
    },
    "legal_claim_of_principal_claim": {
      "value": "<string>",
      "currency": "EUR"
    },
    "total_legal_claim": {
      "value": "<string>",
      "currency": "EUR"
    },
    "payment_on_costs_interest_bearing": {
      "value": "<string>",
      "currency": "EUR"
    },
    "payment_on_costs_interest_free": {
      "value": "<string>",
      "currency": "EUR"
    },
    "payment_on_interest_on_costs": {
      "value": "<string>",
      "currency": "EUR"
    },
    "payment_on_interest_on_principal_claim": {
      "value": "<string>",
      "currency": "EUR"
    },
    "payment_on_principal_claim": {
      "value": "<string>",
      "currency": "EUR"
    },
    "total_payment": {
      "value": "<string>",
      "currency": "EUR"
    },
    "updated": "2023-11-07T05:31:56Z"
  },
  "claims": [
    {
      "href": "<string>",
      "id": "<string>",
      "payments": [
        {
          "href": "<string>",
          "id": "<string>"
        }
      ]
    }
  ],
  "total_mandate_amount": {
    "value": "<string>",
    "currency": "EUR"
  },
  "status_updates": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "legal_stage": "extrajudicial",
      "processing_state": "in_progress",
      "created": "2023-11-07T05:31:56Z",
      "downloads": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "filename": "<string>",
          "mime_type": "<string>",
          "file_size": 123,
          "download_url": "<string>"
        }
      ]
    }
  ],
  "archived": true,
  "created": "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

​
archived
boolean

Response

200 - application/json
​
href
string<uri>
required
​
debtor
object
required
​
legal_stage
enum<string>
required
  • extrajudicial - Außergerichtlich
  • judicial_dunning - Gerichtliches Mahnverfahren
  • foreclosure - Zwangsvollstreckung
  • long_term_monitoring - In Langzeitüberwachung
  • ended - Beendet
Available options:
extrajudicial,
judicial_dunning,
foreclosure,
long_term_monitoring,
ended
​
processing_state
enum<string>
required
  • in_progress - Laufend
  • paused - Pausiert
  • canceled_by_client - Abgebrochen durch Mandant
  • canceled_by_service_provider - Abgebrochen durch uns
  • ended - Beendet
Available options:
in_progress,
paused,
canceled_by_client,
canceled_by_service_provider,
ended
​
payment_state
enum<string>
required
  • unpaid - Unbezahlt
  • partially_paid - Teilweise bezahlt
  • fully_paid - Voll bezahlt
Available options:
unpaid,
partially_paid,
fully_paid
​
legal_claim_balance
object
required

The legal claim balance of the mandate ("Forderungsstand").

​
total_mandate_amount
object
required

Amount

​
status_updates
object[]
required
​
archived
boolean
required
​
created
string<date-time>
required
​
id
string
​
reference_number
string

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.

​
further_reference_numbers
string[]

If a mandate bears multiple reference numbers, the most recent one is saved in reference_number above. All others will be placed here.

​
claims
object[]