This website uses Cookies to provide you with the best possible service. Please see our Privacy Policy for more information. Click the check box below to accept cookies. Then confirm with a click on "Save". Yes, cookies may be saved.

`/collect/claim/{az}/status/`

Response Daten

Bei einer erfolgreichen Anfrage HTTP-Statuscode = 200 werden als Antwort immer folgende Datentypen als JSON encoded String zurückgeliefert:

Response ⬆️

Das Response Objekt wird sowohl bei erfolgreichen als auch fehlerbehafteten Antworten zurückgeliefert

Feld	Beschreibung	Feldeigenschaften	mögliche Werte
bSuccess	Zeigt an, ob eine Anfrage an das Inkassosystem erfolgreich war	type: boolean	true oder false
aMessage	Beinhaltet zusätzliche Informationen zum Anfrageergebnis	type: array of collectResponseMessage	siehe collectResponseMessage

Data ⬆️

Das Data Objekt wird nur bei erfolgreichen Anfragen (bSuccess=true) zurückgeliefert.

Feld	Beschreibung	Feldeigenschaften	mögliche Werte
ClientCustomerRefNo	Referenznummer vom Gläubiger	type: string	example: "6910-2"
ImportStatus	Auftragsstatus	type: string constraint: Enum	"succeeded" = "Forderung erfolgreich im Inkassosystem angelegt" "pending" = "Forderungsimport vorgemerkt und noch ausstehend" "failed" = "automatischer Forderungsimport fehlgeschlagen, Übergabe an Sachbearbeitung"
Stage	Aktenstadium	type: string constraint: Enum	"V" = "Vorgerichtlich" "G" = "Gerichtlich" "L" = "Langzeitüberwachung vorgerichtlich" "N" = "Nachgerichtlich" "Ü" = "Nachgerichtliche Überwachung"
Reason	Begründung	type: object	siehe Reason

Reason ⬆️

Weitere Statusangaben zu einer bestimmten Fall-Entscheidung z.B. Aktenabschluss

Feld	Beschreibung	Feldeigenschaften	mögliche Werte
Notice	Hinweis	type: string	example: "Teilzahlung"
ClosingDate	Abschlussdatum	type: string format: date	example: "2023-10-11"

collectResponseMessage ⬆️

Beinhaltet zusätzliche Informationen zum Anfrageergebnis.

Feld	Beschreibung	Feldeigenschaften	mögliche Werte
sKey	Gibt die Art der Information an	type: string	"code" "info" "error"
sValue	Information in textueller Form	type: string	example: "Operation successful"

✅ Beispiel Response - erfolgreiche Statusanfrage

{
  "Response": {
    "bSuccess": true,
    "aMessage": [
      {
        "sKey": "info",
        "sValue": "Request successfully received"
      }
    ]
  },
  "Data": {
    "ClientCustomerRefNo": "6910-2",
    "ImportStatus": "succeeded",
    "Stage": "V",
    "Reason": {
      "Notice": "Teilzahlung",
      "ClosingDate": "2022-10-11"
    }
  }
}

🚫 Beispiel Response - fehlerhafte Statusanfrage: Aktenzeichen nicht gefunden

{
  "bSuccess": false,
  "aMessage": [
    {
      "sKey": "error",
      "sValue": "Filenumber not found"
    },
    {
      "sKey": "code",
      "sValue": "IKP105"
    }
  ]
}