{ "openapi": "3.1.0", "info": { "title": "live API", "version": "1.6.1000-161", "description": "HTTP interface of the live server.\n\n**Only the `public` section is released for integrations:** sign in with an API key and create, read, list and change assignments. This part is stable – it is only ever extended; nothing goes away and nothing changes its meaning. Everything under `internal` serves the web app and the tools and may change without notice.\n\n## Conventions\n\n- All payloads are JSON (`content-type: application/json`).\n- Points in time are milliseconds since 1970 (UTC).\n- Errors come as JSON with a fixed `code` (e.g. `policy.missing_right`), `category`, `status` and `message`. Decide on `code`, never on `message`. `401`: key missing or invalid. `403`: the account lacks the right.\n- Responses may carry fields not described here; ignore unknown fields.\n\n## 1. Sign in\n\nEvery request carries the API key in a header: `x-api-key: live_api_…`. An admin issues the key for an account; it is shown only once and acts with that account's rights.\n\n## 2. Create an assignment\n\n`POST /api/dto/fsg3` with `order`, `subject` and `creditor`. The executing partner is assigned by postal code. The answer names the `assignmentId` and the reference number `ref`.\n\n## 3. Read an assignment\n\n`GET /api/dto/fsg3/{ref}` – complete, with status, dates and results (`results..`).\n\n## 4. List assignments\n\n`GET /api/dto/fsg3` with a filter (`filter=status=pending`), search (`search=`), order (`sort=subjectDisplayName&dir=asc`) and page size (`limit=`). While the answer carries `nextCursor`, the same request plus `cursor=` returns the next page.\n\n## 5. Change an assignment\n\n`PATCH /api/dto/fsg3/{ref}` with the fields to change: fields not named stay, `null` clears a field, `{ \"status\": { \"status\": \"cancelled\" } }` changes the status. There is no delete; cancelling is a status change.\n\nThe field names are English; each field names its column in the fsg3 format.\n\nThis page shows a complete example for each of these endpoints." }, "servers": [ { "url": "https://lab.inkasso.live" } ], "tags": [ { "name": "public", "description": "The released, stable interface: sign in with an API key and create, read, list and change assignments. It is only ever extended." } ], "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Schritt 1 des Standardablaufs: Anmeldung per API-Key.\n\nDen Key stellt der Betrieb für ein Konto aus; er handelt mit den Rechten dieses Kontos. Jede Anfrage trägt ihn im Kopf:\n\n`x-api-key: live_api_EEToy.`" } }, "schemas": { "ErrorResponse": { "type": "object", "additionalProperties": true, "properties": { "error": { "type": "string", "description": "High-level error category such as auth, validation, policy, storage or routing." }, "code": { "oneOf": [ { "type": "string" }, { "type": "integer" } ], "description": "Stable machine-readable error code." }, "status": { "type": "integer", "description": "HTTP status for the current transport response." }, "category": { "type": "string", "description": "Stable error namespace / category used for generic handling." }, "message": { "type": "string", "description": "Human-readable summary for logs and diagnostics." }, "detail": { "type": "string", "nullable": true, "description": "Optional compact detail string." }, "requestId": { "type": "string", "description": "Server request identifier for tracing." } }, "required": [ "error", "code", "status", "category", "message", "requestId" ] } }, "responses": { "ErrorResponse": { "description": "Structured application error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "paths": { "/api/dto/fsg3": { "get": { "operationId": "getApiDtoFsg3", "tags": [ "public" ], "summary": "List assignments (FSG, fsg3)", "description": "Schritt 4 des Standardablaufs: Aufträge auflisten, jede Zeile in derselben Form wie beim Lesen.\n\nFilter, Sortierung und Seiten lassen sich kombinieren. Die erste Seite liefert `nextCursor`; dieselbe Anfrage mit `cursor=` liefert die Folgeseite, bis `nextCursor` fehlt.\n\nBeispiel erste Seite: `GET /api/dto/fsg3?filter=status%3Dto_confirm&sort=subjectDisplayName&limit=2` mit dem Kopf `x-api-key`.", "parameters": [ { "name": "filter", "in": "query", "required": false, "description": "Filter, wiederholbar: `status=`, `ref=` oder ein Datumsbereich wie `modified>=`.", "schema": { "type": "string" }, "example": "status=to_confirm", "style": "form", "explode": true }, { "name": "search", "in": "query", "required": false, "description": "Freitextsuche (Name, Aktenzeichen, Adresse).", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Sortierfeld, z. B. `ref`, `subjectDisplayName`, `status`, `editedAt`, `dueDate`. Ohne Angabe nach Auftrags-ID.", "schema": { "type": "string" }, "example": "subjectDisplayName" }, { "name": "dir", "in": "query", "required": false, "description": "`asc` (Vorgabe) oder `desc`.", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Seitengröße (Vorgabe 100, höchstens 1000).", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "example": "2" }, { "name": "cursor", "in": "query", "required": false, "description": "`nextCursor` der vorigen Seite, unverändert.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Alternative zum Cursor: Position der Seite.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "lifecycle", "in": "query", "required": false, "description": "`active` (Vorgabe), `inactive` oder `all`.", "schema": { "type": "string" } } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Eine Seite Aufträge", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "required": [ "total", "offset", "limit", "returned", "rows" ], "properties": { "filter": { "type": "array", "items": { "type": "string" }, "description": "Die angewendeten Filter." }, "total": { "type": "integer", "description": "Treffer insgesamt." }, "offset": { "type": "integer", "description": "Position der Seite." }, "limit": { "type": "integer", "description": "Seitengröße." }, "returned": { "type": "integer", "description": "Zeilen auf dieser Seite." }, "nextCursor": { "type": "string", "description": "Token für die Folgeseite; fehlt auf der letzten Seite." }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": true, "description": "Ein FSG-Auftrag in der fsg3-Form mit englischen Feldnamen. Felder ohne Wert fehlen; Bereiche ohne Leserecht fehlen ganz. Weitere Felder können hinzukommen; die hier genannten bleiben.", "required": [ "id", "ref", "status", "modified" ], "properties": { "id": { "type": "string", "description": "Auftrags-ID." }, "ref": { "type": "string", "description": "fsg3: `IADB-Auftrag` – Auftragsnummer" }, "tenantId": { "type": [ "string", "null" ], "description": "Mandant." }, "moduleId": { "type": [ "string", "null" ] }, "lifecycleState": { "type": [ "string", "null" ], "description": "`active`, `archived` oder `removed`." }, "clientId": { "type": [ "string", "null" ], "description": "Einspeisender (Organisation)." }, "partnerId": { "type": [ "string", "null" ], "description": "Ausführender (Organisation), per PLZ zugeordnet." }, "subjectDisplayName": { "type": [ "string", "null" ], "description": "Anzeigename des Schuldners." }, "phone": { "type": "string", "description": "fsg3: `Telefon`" }, "clientRef": { "type": "string", "description": "fsg3: `EinspeisenderNr` – Einspeisender-Nr." }, "clientDisplayName": { "type": "string", "description": "fsg3: `Einspeisender`" }, "partnerRef": { "type": "string", "description": "fsg3: `AusführenderNr` – Ausführender-Nr." }, "partnerDisplayName": { "type": "string", "description": "fsg3: `Ausführender`" }, "assignee": { "type": [ "object", "null" ], "description": "Bearbeiter beim Ausführenden.", "properties": { "id": { "type": "string" }, "displayName": { "type": [ "string", "null" ] } } }, "status": { "type": "object", "additionalProperties": true, "description": "Status und Datumswerte. Die Datumswerte setzt der Ablauf; beim Schreiben werden sie ignoriert.", "required": [ "status", "statusLabel" ], "properties": { "status": { "type": "string", "description": "fsg3: `Auftragsstatus` – Status" }, "statusLabel": { "type": [ "string", "null" ], "description": "Bearbeitungsstand als Anzeigetext." }, "deliveryDate": { "type": [ "integer", "string" ], "description": "fsg3: `Einstelldatum` – Einstelldatum" }, "confirmationDate": { "type": [ "integer", "string" ], "description": "fsg3: `Bestätigungsdatum` – Bestätigungsdatum" }, "dueDate": { "type": [ "integer", "string" ], "description": "fsg3: `Bearbeitungsende` – Fälligkeitsdatum" }, "returnDate": { "type": [ "integer", "string" ], "description": "fsg3: `Rückgabedatum` – Rückgabedatum" }, "invoiceDate": { "type": [ "integer", "string" ], "description": "fsg3: `Rechnungsdatum` – Rechnungsdatum" }, "processedDate": { "type": [ "integer", "string" ], "description": "fsg3: `Abschlussdatum` – Bearbeitungsdatum" } } }, "order": { "type": "object", "additionalProperties": true, "description": "Auftragsdaten.", "properties": { "serviceIds": { "type": "array", "items": { "type": "string" }, "description": "Beauftragte Leistungen, z. B. `AD340`." }, "creditorReference": { "type": "string", "description": "fsg3: `AktenzeichenDesGlaeubigers` – Aktenzeichen Gläubiger" }, "clientReference": { "type": "string", "description": "fsg3: `AktenzeichenEinspeisender` – Aktenzeichen Einspeisender" }, "stage": { "type": "string", "description": "fsg3: `Stadium` – Stadium" }, "private": { "type": [ "boolean", "string" ], "description": "fsg3: `private` – Privater Auftrag" }, "comment": { "type": "string", "description": "fsg3: `Bemerkung` – Kommentar" }, "settlementLimit": { "type": "string", "description": "fsg3: `Vergleichsgrenze` – Vergleichsgrenze" }, "installmentLimit": { "type": [ "number", "string" ], "description": "fsg3: `Ratenzahlungsgrenze` – Ratenzahlungsgrenze" }, "installmentLabel": { "type": "string", "description": "fsg3: `BezeichnungRatenzahlungsvereinbarung` – Bezeichnung Ratenzahlung" }, "installmentFee": { "type": [ "number", "string" ], "description": "fsg3: `GebuehrRatenzahlungsvereinbarung` – Gebühr Ratenzahlung" }, "showVatToSubject": { "type": [ "boolean", "string" ], "description": "fsg3: `MwStGegenueberDemSchuldnerAusweisen` – MwSt gegenüber Schuldner ausweisen" }, "typeLabel": { "type": "string", "description": "fsg3: `Auftragsart` – Auftragsart" }, "principalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Hauptforderung` – Hauptforderung" }, "costs": { "type": [ "number", "string" ], "description": "fsg3: `Kosten` – Kosten" }, "interest": { "type": [ "number", "string" ], "description": "fsg3: `Zinsen` – Zinsen" }, "payments": { "type": [ "number", "string" ], "description": "fsg3: `Zahlungen` – Zahlungen" }, "totalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Gesamtforderung` – Gesamtforderung" }, "dailyInterest": { "type": [ "number", "string" ], "description": "fsg3: `Tageszinsen` – Tageszinsen" }, "claimDescription": { "type": "string", "description": "fsg3: `Forderungsbegründung` – Forderungsbegründung" }, "bankName": { "type": "string", "description": "fsg3: `eBank` – Bank (Einspeiser)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `eKontoinhaber` – Kontoinhaber (Einspeiser)" }, "bankBic": { "type": "string", "description": "fsg3: `eBIC` – BIC (Einspeiser)" }, "bankIban": { "type": "string", "description": "fsg3: `eIBAN` – IBAN (Einspeiser)" }, "BBFS_question": { "type": "string", "description": "fsg3: `BBFS_Fragestellung` – BBFS Fragestellung" } } }, "subject": { "type": "object", "additionalProperties": true, "description": "Schuldner (die gesuchte Person).", "properties": { "salutation": { "type": "string", "description": "fsg3: `sAnrede` – Schuldner Anrede" }, "firstName": { "type": "string", "description": "fsg3: `sVorname` – Schuldner Vorname" }, "name1": { "type": "string", "description": "fsg3: `sName1` – Schuldner Name" }, "name2": { "type": "string", "description": "fsg3: `sName2` – Schuldner Namenszusatz" }, "street": { "type": "string", "description": "fsg3: `sStrasse` – Schuldner Straße" }, "postalCode": { "type": "string", "description": "fsg3: `sPLZ` – PLZ" }, "city": { "type": "string", "description": "fsg3: `sOrt` – Ort" }, "previousAddresses": { "type": "string", "description": "fsg3: `sVoradressen` – Voradressen" }, "birthDate": { "type": [ "integer", "string" ], "description": "fsg3: `sGeburtsdatum` – Geburtsdatum" }, "birthName": { "type": "string", "description": "fsg3: `sGeburtsname` – Geburtsname" }, "phone": { "type": "string", "description": "fsg3: `sTelefon` – Telefon" }, "email": { "type": "string", "description": "fsg3: `sEmail` – E-Mail" }, "maritalStatus": { "type": "string", "description": "fsg3: `sFamilienstand` – Familienstand" }, "evDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumEV` – Datum EV" }, "arrestWarrantDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumHaftbefehl` – Datum Haftbefehl" }, "bankName": { "type": "string", "description": "fsg3: `sBank` – Bank (Schuldner)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `sKontoinhaber` – Kontoinhaber (Schuldner)" }, "bankBic": { "type": "string", "description": "fsg3: `sBIC` – BIC (Schuldner)" }, "bankIban": { "type": "string", "description": "fsg3: `sIBAN` – IBAN (Schuldner)" }, "children": { "type": "string", "description": "fsg3: `sKinder` – Kinder" }, "income": { "type": "string", "description": "fsg3: `sEinkommen` – Einkommen" }, "employer": { "type": "string", "description": "fsg3: `sArbeitgeber` – Arbeitgeber" }, "lifeInsurance": { "type": "string", "description": "fsg3: `sLebensversicherung` – Lebensversicherung" }, "buildingSociety": { "type": "string", "description": "fsg3: `sBausparer` – Bausparvertrag" }, "car": { "type": "string", "description": "fsg3: `sPKW` – PKW" }, "landlord": { "type": "string", "description": "fsg3: `sVermieter` – Vermieter" }, "otherAttachableAssets": { "type": "string", "description": "fsg3: `sSonstigesPfaendbaresVermoegen` – Sonstiges pfändbares Vermögen" } } }, "creditor": { "type": "object", "additionalProperties": true, "description": "Gläubiger.", "properties": { "firstName": { "type": "string", "description": "fsg3: `gVorname` – Gläubiger Vorname" }, "name1": { "type": "string", "description": "fsg3: `gName1` – Gläubiger" }, "name2": { "type": "string", "description": "fsg3: `gName2` – Gläubiger Namenszusatz" }, "postalCode": { "type": "string", "description": "fsg3: `gPLZ` – Gläubiger PLZ" }, "city": { "type": "string", "description": "fsg3: `gOrt` – Gläubiger Ort" }, "street": { "type": "string", "description": "fsg3: `gStrasse` – Gläubiger Straße" }, "originalCreditor": { "type": "string", "description": "fsg3: `gUrsprungsglaeubiger` – Ursprungsgläubiger" }, "sepaMandateReference": { "type": "string", "description": "fsg3: `gSepaMandateReference` – SEPA-Mandatsreferenz" }, "sepaClientIdentificationNumber": { "type": "string", "description": "fsg3: `gSepaClientIdentificationNumber` – SEPA-Gläubiger-ID" } } }, "results": { "type": "object", "additionalProperties": true, "description": "Ergebnisse je Leistung: `results..`. Nur mit dem Leserecht für Ergebnisse.", "properties": { "RZV101": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RZV101.", "properties": { "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_Unterschriftsdatum` – RZV101 Unterschriftsdatum" }, "bankName": { "type": "string", "description": "fsg3: `RZV101_Bank` – RZV101 Bank" }, "settlementAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Vergleichsbetrag` – RZV101 Vergleichsbetrag" }, "fullTransferDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_ÜberweisungsdatumVoll` – RZV101 ÜberweisungsdatumVoll" }, "acknowledgedDebtAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Schuldanerkenntnis` – RZV101 Schuldanerkenntnis" }, "costs": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Kosten` – RZV101 Kosten" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Ratenhöhe` – RZV101 Ratenhöhe" }, "firstInstallmentDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_ersteRate` – RZV101 ersteRate" }, "monthlyDueDay": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_monatlichzum` – RZV101 monatlichzum" }, "deadline": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_Befristung` – RZV101 Befristung" }, "cashCollectionAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Barinkasso` – RZV101 Barinkasso" }, "receipt": { "type": "string", "description": "fsg3: `RZV101_Quittung` – RZV101 Quittung" } } }, "SEE301": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung SEE301.", "properties": { "healthInsurerKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Krankenkasse_JN` – SEE301 Krankenkasse_JN" }, "healthInsurer": { "type": "string", "description": "fsg3: `SEE301_Krankenkasse` – SEE301 Krankenkasse" }, "pensionInsurerKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Rentenversicherungsträger_JN` – SEE301 Rentenversicherungsträger_JN" }, "pensionInsurer": { "type": "string", "description": "fsg3: `SEE301_Rentenversicherungsträger` – SEE301 Rentenversicherungsträger" }, "pensionInsuranceNumber": { "type": "string", "description": "fsg3: `SEE301_Rentenversicherungsnummer` – SEE301 Rentenversicherungsnummer" }, "bankKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Kreditinstitut_JN` – SEE301 Kreditinstitut_JN" }, "bankName": { "type": "string", "description": "fsg3: `SEE301_Kreditinstitut` – SEE301 Kreditinstitut" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `SEE301_Unterschriftsdatum` – SEE301 Unterschriftsdatum" } } }, "DA320": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung DA320.", "properties": { "subjectName": { "type": "string", "description": "fsg3: `DA320_sName` – DA320 sName" }, "subjectAddress": { "type": "string", "description": "fsg3: `DA320_sAdresse` – DA320 sAdresse" }, "subjectBankName": { "type": "string", "description": "fsg3: `DA320_sBank` – DA320 sBank" }, "subjectBankCode": { "type": "string", "description": "fsg3: `DA320_sBLZ` – DA320 sBLZ" }, "subjectAccountNumber": { "type": "string", "description": "fsg3: `DA320_sKto` – DA320 sKto" }, "subjectIban": { "type": "string", "description": "fsg3: `DA320_sIBAN` – DA320 sIBAN" }, "subjectBic": { "type": "string", "description": "fsg3: `DA320_sBIC` – DA320 sBIC" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `DA320_Ratenbetrag` – DA320 Ratenbetrag" }, "startDate": { "type": [ "integer", "string" ], "description": "fsg3: `DA320_Beginn` – DA320 Beginn" }, "interval": { "type": "string", "description": "fsg3: `DA320_Intervall` – DA320 Intervall" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `DA320_Unterschriftsdatum` – DA320 Unterschriftsdatum" } } }, "LS321": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung LS321.", "properties": { "subjectName": { "type": "string", "description": "fsg3: `LS321_sName` – LS321 sName" }, "subjectAddress": { "type": "string", "description": "fsg3: `LS321_sAdresse` – LS321 sAdresse" }, "subjectBankName": { "type": "string", "description": "fsg3: `LS321_sBank` – LS321 sBank" }, "subjectBankCode": { "type": "string", "description": "fsg3: `LS321_sBLZ` – LS321 sBLZ" }, "subjectAccountNumber": { "type": "string", "description": "fsg3: `LS321_sKto` – LS321 sKto" }, "subjectIban": { "type": "string", "description": "fsg3: `LS321_sIBAN` – LS321 sIBAN" }, "subjectBic": { "type": "string", "description": "fsg3: `LS321_sBIC` – LS321 sBIC" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `LS321_Ratenbetrag` – LS321 Ratenbetrag" }, "startDate": { "type": [ "integer", "string" ], "description": "fsg3: `LS321_Beginn` – LS321 Beginn" }, "interval": { "type": "string", "description": "fsg3: `LS321_Intervall` – LS321 Intervall" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `LS321_Unterschriftsdatum` – LS321 Unterschriftsdatum" } } }, "MSA330": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung MSA330.", "properties": { "salutation": { "type": "string", "description": "fsg3: `MSA330_Anrede` – MSA330 Anrede" }, "firstName": { "type": "string", "description": "fsg3: `MSA330_Vorname` – MSA330 Vorname" }, "name1": { "type": "string", "description": "fsg3: `MSA330_Name1` – MSA330 Name1" }, "name2": { "type": "string", "description": "fsg3: `MSA330_Name2` – MSA330 Name2" }, "street": { "type": "string", "description": "fsg3: `MSA330_Strasse` – MSA330 Strasse" }, "houseNumber": { "type": "string", "description": "fsg3: `MSA330_Hausnummer` – MSA330 Hausnummer" }, "postalCode": { "type": "string", "description": "fsg3: `MSA330_PLZ` – MSA330 PLZ" }, "city": { "type": "string", "description": "fsg3: `MSA330_Ort` – MSA330 Ort" }, "previousAddress": { "type": "string", "description": "fsg3: `MSA330_Voradresse` – MSA330 Voradresse" }, "birthDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_Geburtsdatum` – MSA330 Geburtsdatum" }, "birthName": { "type": "string", "description": "fsg3: `MSA330_Geburtsname` – MSA330 Geburtsname" }, "phoneNumber": { "type": "string", "description": "fsg3: `MSA330_Telefonnummer` – MSA330 Telefonnummer" }, "email": { "type": "string", "description": "fsg3: `MSA330_Email` – MSA330 Email" }, "maritalStatus": { "type": "string", "description": "fsg3: `MSA330_Familienstand` – MSA330 Familienstand" }, "evDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_DatumEV` – MSA330 DatumEV" }, "arrestWarrantDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_DatumHaftbefehl` – MSA330 DatumHaftbefehl" }, "bankName": { "type": "string", "description": "fsg3: `MSA330_Bank` – MSA330 Bank" }, "bankCode": { "type": "string", "description": "fsg3: `MSA330_BLZ` – MSA330 BLZ" }, "accountNumber": { "type": "string", "description": "fsg3: `MSA330_KontoNr` – MSA330 KontoNr" }, "accountHolder": { "type": "string", "description": "fsg3: `MSA330_Kontoinhaber` – MSA330 Kontoinhaber" }, "bic": { "type": "string", "description": "fsg3: `MSA330_BIC` – MSA330 BIC" }, "iban": { "type": "string", "description": "fsg3: `MSA330_IBAN` – MSA330 IBAN" }, "children": { "type": [ "number", "string" ], "description": "fsg3: `MSA330_Kinder` – MSA330 Kinder" }, "income": { "type": "string", "description": "fsg3: `MSA330_Einkommen` – MSA330 Einkommen" }, "employer": { "type": "string", "description": "fsg3: `MSA330_Arbeitgeber` – MSA330 Arbeitgeber" }, "lifeInsurance": { "type": "string", "description": "fsg3: `MSA330_Lebensversicherung` – MSA330 Lebensversicherung" }, "buildingSociety": { "type": "string", "description": "fsg3: `MSA330_Bausparer` – MSA330 Bausparer" }, "car": { "type": "string", "description": "fsg3: `MSA330_PKW` – MSA330 PKW" }, "landlord": { "type": "string", "description": "fsg3: `MSA330_Vermieter` – MSA330 Vermieter" }, "otherAttachableAssets": { "type": "string", "description": "fsg3: `MSA330_sonstiges pfändbare Vermögen` – MSA330 sonstiges pfändbare Vermögen" }, "notes": { "type": "string", "description": "fsg3: `MSA330_Notizen` – MSA330 Notizen" } } }, "AD340": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung AD340.", "properties": { "idNumber": { "type": "string", "description": "fsg3: `AD340_Ausweisnummer` – AD340 Ausweisnummer" }, "deceased": { "type": "string", "description": "fsg3: `AD340_verstorben` – AD340 verstorben" }, "livingSituation": { "type": "string", "description": "fsg3: `AD340_Wohnsituation` – AD340 Wohnsituation" }, "floor": { "type": "string", "description": "fsg3: `AD340_Etage` – AD340 Etage" }, "door": { "type": "string", "description": "fsg3: `AD340_Tür` – AD340 Tür" }, "remarks": { "type": "string", "description": "fsg3: `AD340_Sonstiges` – AD340 Sonstiges" }, "mailbox": { "type": "string", "description": "fsg3: `AD340_Briefkasten` – AD340 Briefkasten" }, "visit1Date": { "type": [ "integer", "string" ], "description": "fsg3: `AD340_Besuchsdatum1` – AD340 Besuchsdatum1" }, "metAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_angetroffen1_JN` – AD340 angetroffen1_JN" }, "agreementAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Vereinbarung1_JN` – AD340 Vereinbarung1_JN" }, "disputedPrincipalClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_HF1_JN` – AD340 bestritten_HF1_JN" }, "disputedAncillaryClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_NF1_JN` – AD340 bestritten_NF1_JN" }, "notificationCardVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Benachrichtigungskarte1_JN` – AD340 Benachrichtigungskarte1_JN" }, "visit1Remarks": { "type": "string", "description": "fsg3: `AD340_SonstigesBesuch1` – AD340 SonstigesBesuch1" }, "visit2Date": { "type": [ "integer", "string" ], "description": "fsg3: `AD340_Besuchsdatum2` – AD340 Besuchsdatum2" }, "metAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Angetroffen2_JN` – AD340 Angetroffen2_JN" }, "agreementAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Vereinbarung2_JN` – AD340 Vereinbarung2_JN" }, "disputedPrincipalClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_HF2_JN` – AD340 bestritten_HF2_JN" }, "disputedAncillaryClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_NF2_JN` – AD340 bestritten_NF2_JN" }, "notificationCardVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Benachrichtigungskarte2_JN` – AD340 Benachrichtigungskarte2_JN" }, "visit2Remarks": { "type": "string", "description": "fsg3: `AD340_SonstigesBesuch2` – AD340 SonstigesBesuch2" }, "callback": { "type": "string", "description": "fsg3: `AD340_Rückruf` – AD340 Rückruf" }, "successProspect": { "type": "string", "description": "fsg3: `AD340_Erfolgsaussicht` – AD340 Erfolgsaussicht" }, "recommendation": { "type": "string", "description": "fsg3: `AD340_Empfehlung` – AD340 Empfehlung" } } }, "VZ350": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung VZ350.", "properties": { "fullPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `VZ350_VollzahlungBetrag` – VZ350 VollzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `VZ350_Datum` – VZ350 Datum" }, "receipt": { "type": "string", "description": "fsg3: `VZ350_Quittung` – VZ350 Quittung" } } }, "TZ351": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung TZ351.", "properties": { "partialPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `TZ351_TeilzahlungBetrag` – TZ351 TeilzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `TZ351_Datum` – TZ351 Datum" }, "receipt": { "type": "string", "description": "fsg3: `TZ351_Quittung` – TZ351 Quittung" } } }, "TZ352": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung TZ352.", "properties": { "partialPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `TZ352_TeilzahlungBetrag` – TZ352 TeilzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `TZ352_Datum` – TZ352 Datum" }, "receipt": { "type": "string", "description": "fsg3: `TZ352_Quittung` – TZ352 Quittung" } } }, "SAR401": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung SAR401.", "properties": { "date": { "type": [ "integer", "string" ], "description": "fsg3: `SAR401_SARDatum` – SAR401 SARDatum" }, "specialRemarks": { "type": "string", "description": "fsg3: `SAR401_SARBesonderes` – SAR401 SARBesonderes" } } }, "RVAA": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAA.", "properties": { "employer": { "type": "string", "description": "fsg3: `RVAA_Arbeitgeber` – RVAA Arbeitgeber" }, "street": { "type": "string", "description": "fsg3: `RVAA_Straße` – RVAA Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAA_Postleitzahl` – RVAA Postleitzahl" }, "city": { "type": "string", "description": "fsg3: `RVAA_Ort` – RVAA Ort" }, "earnings": { "type": [ "number", "string" ], "description": "fsg3: `RVAA_Verdienst` – RVAA Verdienst" } } }, "RVAB": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAB.", "properties": { "bankName": { "type": "string", "description": "fsg3: `RVAB_Bank` – RVAB Bank" }, "iban": { "type": "string", "description": "fsg3: `RVAB_IBAN` – RVAB IBAN" } } }, "RVAK": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAK.", "properties": { "healthInsurer": { "type": "string", "description": "fsg3: `RVAK_Krankenkasse` – RVAK Krankenkasse" }, "street": { "type": "string", "description": "fsg3: `RVAK_Straße` – RVAK Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAK_PLZ` – RVAK PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAK_Ort` – RVAK Ort" }, "phoneNumber": { "type": "string", "description": "fsg3: `RVAK_Telefonnummer` – RVAK Telefonnummer" }, "email": { "type": "string", "description": "fsg3: `RVAK_EMail` – RVAK EMail" }, "fax": { "type": "string", "description": "fsg3: `RVAK_Fax` – RVAK Fax" }, "website": { "type": "string", "description": "fsg3: `RVAK_Homepage` – RVAK Homepage" }, "contactForm": { "type": "string", "description": "fsg3: `RVAK_Kontaktformular` – RVAK Kontaktformular" } } }, "RVAR": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAR.", "properties": { "pensionInsurer": { "type": "string", "description": "fsg3: `RVAR_Rentenversicherung` – RVAR Rentenversicherung" }, "street": { "type": "string", "description": "fsg3: `RVAR_Straße` – RVAR Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAR_PLZ` – RVAR PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAR_Ort` – RVAR Ort" } } }, "RVAV": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAV.", "properties": { "landlord": { "type": "string", "description": "fsg3: `RVAV_Vermieter` – RVAV Vermieter" }, "street": { "type": "string", "description": "fsg3: `RVAV_Straße` – RVAV Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAV_PLZ` – RVAV PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAV_Ort` – RVAV Ort" }, "phoneNumber": { "type": "string", "description": "fsg3: `RVAV_Telefonnummer` – RVAV Telefonnummer" } } }, "RSET": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSET.", "properties": { "phoneNumber": { "type": "string", "description": "fsg3: `RSET_Telefonnummer` – RSET Telefonnummer" } } }, "RSEE": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSEE.", "properties": { "email": { "type": "string", "description": "fsg3: `RSEE_EMail` – RSEE EMail" } } }, "RSES": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSES.", "properties": { "dateOfDeath": { "type": [ "integer", "string" ], "description": "fsg3: `RSES_Sterbedatum` – RSES Sterbedatum" } } }, "RSEI": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSEI.", "properties": { "insolvencyDate": { "type": [ "integer", "string" ], "description": "fsg3: `RSEI_Insolvenzdatum` – RSEI Insolvenzdatum" }, "localCourt": { "type": "string", "description": "fsg3: `RSEI_Amtsgericht` – RSEI Amtsgericht" }, "caseReference": { "type": "string", "description": "fsg3: `RSEI_Aktenzeichen` – RSEI Aktenzeichen" } } }, "BBFS": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung BBFS.", "properties": { "answer": { "type": "string", "description": "fsg3: `BBFS_Antwort` – BBFS Antwort" } } }, "VNA": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung VNA.", "properties": { "street": { "type": "string", "description": "fsg3: `VNA_Straße` – VNA Straße" }, "postalCode": { "type": "string", "description": "fsg3: `VNA_Postleitzahl` – VNA Postleitzahl" }, "city": { "type": "string", "description": "fsg3: `VNA_Ort` – VNA Ort" } } }, "3ADP": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung 3ADP.", "properties": { "visit1Date": { "type": [ "integer", "string" ], "description": "fsg3: `3ADP_Besuchsdatum1` – 3ADP Besuchsdatum1" }, "metAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_angetroffen1_JN` – 3ADP angetroffen1_JN" }, "agreementAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Vereinbarung1_JN` – 3ADP Vereinbarung1_JN" }, "disputedPrincipalClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_HF1_JN` – 3ADP bestritten_HF1_JN" }, "disputedAncillaryClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_NF1_JN` – 3ADP bestritten_NF1_JN" }, "notificationCardVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Benachrichtigungskarte1_JN` – 3ADP Benachrichtigungskarte1_JN" }, "visit2Date": { "type": [ "integer", "string" ], "description": "fsg3: `3ADP_Besuchsdatum2` – 3ADP Besuchsdatum2" }, "metAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Angetroffen2_JN` – 3ADP Angetroffen2_JN" }, "agreementAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Vereinbarung2_JN` – 3ADP Vereinbarung2_JN" }, "disputedPrincipalClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_HF2_JN` – 3ADP bestritten_HF2_JN" }, "disputedAncillaryClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_NF2_JN` – 3ADP bestritten_NF2_JN" }, "notificationCardVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Benachrichtigungskarte2_JN` – 3ADP Benachrichtigungskarte2_JN" }, "successProspect": { "type": "string", "description": "fsg3: `3ADP_Erfolgsaussicht` – 3ADP Erfolgsaussicht" } } } } }, "modified": { "type": "integer", "description": "Letzte Änderung, Millisekunden seit 1970." } } } } } }, "example": { "filter": [ "status=to_confirm" ], "total": 3, "offset": 0, "limit": 2, "returned": 2, "nextCursor": "eyJrIjoiZXlKemIzSjBWbUZzZFdVaU9pSndaWFJ5WVNCaVpXbHpjR2xsYkNJc0ltRnpjMmxuYm0xbGJuUkpaQ0k2SWpObU5tUXlZekZsSW4wIiwibiI6Mn0", "rows": [ { "id": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "ref": "100036", "tenantId": "tenant-demo1", "moduleId": "module/fsg", "lifecycleState": "active", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "clientRef": "IADB-4201", "clientDisplayName": "DEBICO AG", "partnerId": "b1c2d3e4-0000-4000-8000-000000000001", "partnerRef": "IADB-5001", "partnerDisplayName": "Anton Aus GmbH", "subjectDisplayName": "Petra Beispiel", "assignee": null, "status": { "status": "to_confirm", "statusLabel": "Zu bestätigen", "deliveryDate": 1790222260000 }, "order": { "serviceIds": [ "AD340" ], "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "claimDescription": "Adressermittlung", "principalClaim": 100, "totalClaim": 100, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" }, "results": {}, "modified": 1790222267453 }, { "id": "5b0e…", "ref": "100037", "tenantId": "tenant-demo1", "moduleId": "module/fsg", "lifecycleState": "active", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "clientRef": "IADB-4201", "clientDisplayName": "DEBICO AG", "partnerId": "b1c2d3e4-0000-4000-8000-000000000001", "partnerRef": "IADB-5001", "partnerDisplayName": "Anton Aus GmbH", "subjectDisplayName": "Paul Beispiel", "assignee": null, "status": { "status": "to_confirm", "statusLabel": "Zu bestätigen", "deliveryDate": 1790222260000 }, "order": { "serviceIds": [ "AD340" ], "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "claimDescription": "Adressermittlung", "principalClaim": 100, "totalClaim": 100, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" }, "results": {}, "modified": 1790222267453 } ] }, "examples": { "firstPage": { "summary": "Erste Seite (filter=status%3Dto_confirm&sort=subjectDisplayName&limit=2)", "value": { "filter": [ "status=to_confirm" ], "total": 3, "offset": 0, "limit": 2, "returned": 2, "nextCursor": "eyJrIjoiZXlKemIzSjBWbUZzZFdVaU9pSndaWFJ5WVNCaVpXbHpjR2xsYkNJc0ltRnpjMmxuYm0xbGJuUkpaQ0k2SWpObU5tUXlZekZsSW4wIiwibiI6Mn0", "rows": [ { "id": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "ref": "100036", "tenantId": "tenant-demo1", "moduleId": "module/fsg", "lifecycleState": "active", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "clientRef": "IADB-4201", "clientDisplayName": "DEBICO AG", "partnerId": "b1c2d3e4-0000-4000-8000-000000000001", "partnerRef": "IADB-5001", "partnerDisplayName": "Anton Aus GmbH", "subjectDisplayName": "Petra Beispiel", "assignee": null, "status": { "status": "to_confirm", "statusLabel": "Zu bestätigen", "deliveryDate": 1790222260000 }, "order": { "serviceIds": [ "AD340" ], "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "claimDescription": "Adressermittlung", "principalClaim": 100, "totalClaim": 100, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" }, "results": {}, "modified": 1790222267453 }, { "id": "5b0e…", "ref": "100037", "tenantId": "tenant-demo1", "moduleId": "module/fsg", "lifecycleState": "active", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "clientRef": "IADB-4201", "clientDisplayName": "DEBICO AG", "partnerId": "b1c2d3e4-0000-4000-8000-000000000001", "partnerRef": "IADB-5001", "partnerDisplayName": "Anton Aus GmbH", "subjectDisplayName": "Paul Beispiel", "assignee": null, "status": { "status": "to_confirm", "statusLabel": "Zu bestätigen", "deliveryDate": 1790222260000 }, "order": { "serviceIds": [ "AD340" ], "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "claimDescription": "Adressermittlung", "principalClaim": 100, "totalClaim": 100, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" }, "results": {}, "modified": 1790222267453 } ] } }, "nextPage": { "summary": "Folgeseite (dieselbe Anfrage plus cursor=)", "value": { "filter": [ "status=to_confirm" ], "total": 3, "offset": 2, "limit": 2, "returned": 1, "rows": [ { "id": "7c2a…", "ref": "100038", "tenantId": "tenant-demo1", "moduleId": "module/fsg", "lifecycleState": "active", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "clientRef": "IADB-4201", "clientDisplayName": "DEBICO AG", "partnerId": "b1c2d3e4-0000-4000-8000-000000000001", "partnerRef": "IADB-5001", "partnerDisplayName": "Anton Aus GmbH", "subjectDisplayName": "Pia Beispiel", "assignee": null, "status": { "status": "to_confirm", "statusLabel": "Zu bestätigen", "deliveryDate": 1790222260000 }, "order": { "serviceIds": [ "AD340" ], "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "claimDescription": "Adressermittlung", "principalClaim": 100, "totalClaim": 100, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" }, "results": {}, "modified": 1790222267453 } ] } } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" }, "404": { "$ref": "#/components/responses/ErrorResponse" }, "409": { "$ref": "#/components/responses/ErrorResponse" }, "500": { "$ref": "#/components/responses/ErrorResponse" } } }, "post": { "operationId": "postApiDtoFsg3", "tags": [ "public" ], "summary": "Create an assignment (FSG, fsg3)", "description": "Schritt 2 des Standardablaufs: einen FSG-Auftrag anlegen. Der Ausführende wird wie beim Import über die PLZ des Schuldners zugeordnet. Die Antwort nennt das Aktenzeichen, unter dem der Auftrag gelesen und geändert wird.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Der neue Auftrag. Pflicht sind die Auftrags- und Schuldnerdaten, die das Fachmodul verlangt.", "required": [ "order", "subject" ], "properties": { "id": { "type": "string", "description": "Eigene Auftrags-ID (optional). Ein zweites Anlegen mit derselben ID wird abgewiesen." }, "tenantId": { "type": "string", "description": "Mandant; entfällt, wenn der Key genau einem Mandanten gehört." }, "clientId": { "type": "string", "description": "Einspeisender; entfällt, wenn der Key zu einem Einspeisenden gehört." }, "order": { "type": "object", "additionalProperties": true, "properties": { "serviceIds": { "type": "array", "items": { "type": "string" }, "description": "Beauftragte Leistungen." }, "creditorReference": { "type": "string", "description": "fsg3: `AktenzeichenDesGlaeubigers` – Aktenzeichen Gläubiger" }, "clientReference": { "type": "string", "description": "fsg3: `AktenzeichenEinspeisender` – Aktenzeichen Einspeisender" }, "stage": { "type": "string", "description": "fsg3: `Stadium` – Stadium" }, "private": { "type": [ "boolean", "string" ], "description": "fsg3: `private` – Privater Auftrag" }, "comment": { "type": "string", "description": "fsg3: `Bemerkung` – Kommentar" }, "settlementLimit": { "type": "string", "description": "fsg3: `Vergleichsgrenze` – Vergleichsgrenze" }, "installmentLimit": { "type": [ "number", "string" ], "description": "fsg3: `Ratenzahlungsgrenze` – Ratenzahlungsgrenze" }, "installmentLabel": { "type": "string", "description": "fsg3: `BezeichnungRatenzahlungsvereinbarung` – Bezeichnung Ratenzahlung" }, "installmentFee": { "type": [ "number", "string" ], "description": "fsg3: `GebuehrRatenzahlungsvereinbarung` – Gebühr Ratenzahlung" }, "showVatToSubject": { "type": [ "boolean", "string" ], "description": "fsg3: `MwStGegenueberDemSchuldnerAusweisen` – MwSt gegenüber Schuldner ausweisen" }, "typeLabel": { "type": "string", "description": "fsg3: `Auftragsart` – Auftragsart" }, "principalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Hauptforderung` – Hauptforderung" }, "costs": { "type": [ "number", "string" ], "description": "fsg3: `Kosten` – Kosten" }, "interest": { "type": [ "number", "string" ], "description": "fsg3: `Zinsen` – Zinsen" }, "payments": { "type": [ "number", "string" ], "description": "fsg3: `Zahlungen` – Zahlungen" }, "totalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Gesamtforderung` – Gesamtforderung" }, "dailyInterest": { "type": [ "number", "string" ], "description": "fsg3: `Tageszinsen` – Tageszinsen" }, "claimDescription": { "type": "string", "description": "fsg3: `Forderungsbegründung` – Forderungsbegründung" }, "bankName": { "type": "string", "description": "fsg3: `eBank` – Bank (Einspeiser)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `eKontoinhaber` – Kontoinhaber (Einspeiser)" }, "bankBic": { "type": "string", "description": "fsg3: `eBIC` – BIC (Einspeiser)" }, "bankIban": { "type": "string", "description": "fsg3: `eIBAN` – IBAN (Einspeiser)" }, "BBFS_question": { "type": "string", "description": "fsg3: `BBFS_Fragestellung` – BBFS Fragestellung" } } }, "subject": { "type": "object", "additionalProperties": true, "properties": { "salutation": { "type": "string", "description": "fsg3: `sAnrede` – Schuldner Anrede" }, "firstName": { "type": "string", "description": "fsg3: `sVorname` – Schuldner Vorname" }, "name1": { "type": "string", "description": "fsg3: `sName1` – Schuldner Name" }, "name2": { "type": "string", "description": "fsg3: `sName2` – Schuldner Namenszusatz" }, "street": { "type": "string", "description": "fsg3: `sStrasse` – Schuldner Straße" }, "postalCode": { "type": "string", "description": "fsg3: `sPLZ` – PLZ" }, "city": { "type": "string", "description": "fsg3: `sOrt` – Ort" }, "previousAddresses": { "type": "string", "description": "fsg3: `sVoradressen` – Voradressen" }, "birthDate": { "type": [ "integer", "string" ], "description": "fsg3: `sGeburtsdatum` – Geburtsdatum" }, "birthName": { "type": "string", "description": "fsg3: `sGeburtsname` – Geburtsname" }, "phone": { "type": "string", "description": "fsg3: `sTelefon` – Telefon" }, "email": { "type": "string", "description": "fsg3: `sEmail` – E-Mail" }, "maritalStatus": { "type": "string", "description": "fsg3: `sFamilienstand` – Familienstand" }, "evDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumEV` – Datum EV" }, "arrestWarrantDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumHaftbefehl` – Datum Haftbefehl" }, "bankName": { "type": "string", "description": "fsg3: `sBank` – Bank (Schuldner)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `sKontoinhaber` – Kontoinhaber (Schuldner)" }, "bankBic": { "type": "string", "description": "fsg3: `sBIC` – BIC (Schuldner)" }, "bankIban": { "type": "string", "description": "fsg3: `sIBAN` – IBAN (Schuldner)" }, "children": { "type": "string", "description": "fsg3: `sKinder` – Kinder" }, "income": { "type": "string", "description": "fsg3: `sEinkommen` – Einkommen" }, "employer": { "type": "string", "description": "fsg3: `sArbeitgeber` – Arbeitgeber" }, "lifeInsurance": { "type": "string", "description": "fsg3: `sLebensversicherung` – Lebensversicherung" }, "buildingSociety": { "type": "string", "description": "fsg3: `sBausparer` – Bausparvertrag" }, "car": { "type": "string", "description": "fsg3: `sPKW` – PKW" }, "landlord": { "type": "string", "description": "fsg3: `sVermieter` – Vermieter" }, "otherAttachableAssets": { "type": "string", "description": "fsg3: `sSonstigesPfaendbaresVermoegen` – Sonstiges pfändbares Vermögen" } } }, "creditor": { "type": "object", "additionalProperties": true, "properties": { "firstName": { "type": "string", "description": "fsg3: `gVorname` – Gläubiger Vorname" }, "name1": { "type": "string", "description": "fsg3: `gName1` – Gläubiger" }, "name2": { "type": "string", "description": "fsg3: `gName2` – Gläubiger Namenszusatz" }, "postalCode": { "type": "string", "description": "fsg3: `gPLZ` – Gläubiger PLZ" }, "city": { "type": "string", "description": "fsg3: `gOrt` – Gläubiger Ort" }, "street": { "type": "string", "description": "fsg3: `gStrasse` – Gläubiger Straße" }, "originalCreditor": { "type": "string", "description": "fsg3: `gUrsprungsglaeubiger` – Ursprungsgläubiger" }, "sepaMandateReference": { "type": "string", "description": "fsg3: `gSepaMandateReference` – SEPA-Mandatsreferenz" }, "sepaClientIdentificationNumber": { "type": "string", "description": "fsg3: `gSepaClientIdentificationNumber` – SEPA-Gläubiger-ID" } } }, "status": { "type": "object", "additionalProperties": true, "properties": { "status": { "type": "string", "description": "Neuer Bearbeitungsstand, z. B. `cancelled`." } } } } }, "example": { "id": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "tenantId": "tenant-demo1", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "order": { "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "typeLabel": "std", "serviceIds": [ "AD340" ], "claimDescription": "Adressermittlung", "principalClaim": 100, "costs": 0, "interest": 0, "payments": 0, "totalClaim": 100, "dailyInterest": 0, "showVatToSubject": false, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" } }, "examples": { "create": { "summary": "Auftrag anlegen", "value": { "id": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "tenantId": "tenant-demo1", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "order": { "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "typeLabel": "std", "serviceIds": [ "AD340" ], "claimDescription": "Adressermittlung", "principalClaim": 100, "costs": 0, "interest": 0, "payments": 0, "totalClaim": 100, "dailyInterest": 0, "showVatToSubject": false, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" } } } } } } }, "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Der Auftrag ist angelegt", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "required": [ "assignmentId", "ref", "dataVersion" ], "properties": { "assignmentId": { "type": "string", "description": "Auftrags-ID." }, "ref": { "type": [ "string", "null" ], "description": "Aktenzeichen, unter dem der Auftrag gelesen und geändert wird." }, "dataVersion": { "type": "integer" } } }, "example": { "assignmentId": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "ref": "100036", "dataVersion": 1790222260000 }, "examples": { "created": { "summary": "Angelegt", "value": { "assignmentId": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "ref": "100036", "dataVersion": 1790222260000 } } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" }, "404": { "$ref": "#/components/responses/ErrorResponse" }, "409": { "$ref": "#/components/responses/ErrorResponse" }, "500": { "$ref": "#/components/responses/ErrorResponse" } } } }, "/api/dto/fsg3/{ref}": { "get": { "operationId": "getApiDtoFsg3Ref", "tags": [ "public" ], "summary": "Read an assignment with results (FSG, fsg3)", "description": "Schritt 3 des Standardablaufs: einen Auftrag vollständig lesen – Auftragsdaten, Schuldner, Gläubiger, Status mit Datumswerten und die Ergebnisse je Leistung. Es erscheint nur, was das Konto auch in der App sehen darf.", "parameters": [ { "name": "ref", "in": "path", "required": true, "description": "Aktenzeichen des Auftrags; die Auftrags-ID geht ebenso.", "schema": { "type": "string" }, "example": "100036" } ], "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Der Auftrag", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "required": [ "assignment" ], "properties": { "assignment": { "type": "object", "additionalProperties": true, "description": "Ein FSG-Auftrag in der fsg3-Form mit englischen Feldnamen. Felder ohne Wert fehlen; Bereiche ohne Leserecht fehlen ganz. Weitere Felder können hinzukommen; die hier genannten bleiben.", "required": [ "id", "ref", "status", "modified" ], "properties": { "id": { "type": "string", "description": "Auftrags-ID." }, "ref": { "type": "string", "description": "fsg3: `IADB-Auftrag` – Auftragsnummer" }, "tenantId": { "type": [ "string", "null" ], "description": "Mandant." }, "moduleId": { "type": [ "string", "null" ] }, "lifecycleState": { "type": [ "string", "null" ], "description": "`active`, `archived` oder `removed`." }, "clientId": { "type": [ "string", "null" ], "description": "Einspeisender (Organisation)." }, "partnerId": { "type": [ "string", "null" ], "description": "Ausführender (Organisation), per PLZ zugeordnet." }, "subjectDisplayName": { "type": [ "string", "null" ], "description": "Anzeigename des Schuldners." }, "phone": { "type": "string", "description": "fsg3: `Telefon`" }, "clientRef": { "type": "string", "description": "fsg3: `EinspeisenderNr` – Einspeisender-Nr." }, "clientDisplayName": { "type": "string", "description": "fsg3: `Einspeisender`" }, "partnerRef": { "type": "string", "description": "fsg3: `AusführenderNr` – Ausführender-Nr." }, "partnerDisplayName": { "type": "string", "description": "fsg3: `Ausführender`" }, "assignee": { "type": [ "object", "null" ], "description": "Bearbeiter beim Ausführenden.", "properties": { "id": { "type": "string" }, "displayName": { "type": [ "string", "null" ] } } }, "status": { "type": "object", "additionalProperties": true, "description": "Status und Datumswerte. Die Datumswerte setzt der Ablauf; beim Schreiben werden sie ignoriert.", "required": [ "status", "statusLabel" ], "properties": { "status": { "type": "string", "description": "fsg3: `Auftragsstatus` – Status" }, "statusLabel": { "type": [ "string", "null" ], "description": "Bearbeitungsstand als Anzeigetext." }, "deliveryDate": { "type": [ "integer", "string" ], "description": "fsg3: `Einstelldatum` – Einstelldatum" }, "confirmationDate": { "type": [ "integer", "string" ], "description": "fsg3: `Bestätigungsdatum` – Bestätigungsdatum" }, "dueDate": { "type": [ "integer", "string" ], "description": "fsg3: `Bearbeitungsende` – Fälligkeitsdatum" }, "returnDate": { "type": [ "integer", "string" ], "description": "fsg3: `Rückgabedatum` – Rückgabedatum" }, "invoiceDate": { "type": [ "integer", "string" ], "description": "fsg3: `Rechnungsdatum` – Rechnungsdatum" }, "processedDate": { "type": [ "integer", "string" ], "description": "fsg3: `Abschlussdatum` – Bearbeitungsdatum" } } }, "order": { "type": "object", "additionalProperties": true, "description": "Auftragsdaten.", "properties": { "serviceIds": { "type": "array", "items": { "type": "string" }, "description": "Beauftragte Leistungen, z. B. `AD340`." }, "creditorReference": { "type": "string", "description": "fsg3: `AktenzeichenDesGlaeubigers` – Aktenzeichen Gläubiger" }, "clientReference": { "type": "string", "description": "fsg3: `AktenzeichenEinspeisender` – Aktenzeichen Einspeisender" }, "stage": { "type": "string", "description": "fsg3: `Stadium` – Stadium" }, "private": { "type": [ "boolean", "string" ], "description": "fsg3: `private` – Privater Auftrag" }, "comment": { "type": "string", "description": "fsg3: `Bemerkung` – Kommentar" }, "settlementLimit": { "type": "string", "description": "fsg3: `Vergleichsgrenze` – Vergleichsgrenze" }, "installmentLimit": { "type": [ "number", "string" ], "description": "fsg3: `Ratenzahlungsgrenze` – Ratenzahlungsgrenze" }, "installmentLabel": { "type": "string", "description": "fsg3: `BezeichnungRatenzahlungsvereinbarung` – Bezeichnung Ratenzahlung" }, "installmentFee": { "type": [ "number", "string" ], "description": "fsg3: `GebuehrRatenzahlungsvereinbarung` – Gebühr Ratenzahlung" }, "showVatToSubject": { "type": [ "boolean", "string" ], "description": "fsg3: `MwStGegenueberDemSchuldnerAusweisen` – MwSt gegenüber Schuldner ausweisen" }, "typeLabel": { "type": "string", "description": "fsg3: `Auftragsart` – Auftragsart" }, "principalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Hauptforderung` – Hauptforderung" }, "costs": { "type": [ "number", "string" ], "description": "fsg3: `Kosten` – Kosten" }, "interest": { "type": [ "number", "string" ], "description": "fsg3: `Zinsen` – Zinsen" }, "payments": { "type": [ "number", "string" ], "description": "fsg3: `Zahlungen` – Zahlungen" }, "totalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Gesamtforderung` – Gesamtforderung" }, "dailyInterest": { "type": [ "number", "string" ], "description": "fsg3: `Tageszinsen` – Tageszinsen" }, "claimDescription": { "type": "string", "description": "fsg3: `Forderungsbegründung` – Forderungsbegründung" }, "bankName": { "type": "string", "description": "fsg3: `eBank` – Bank (Einspeiser)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `eKontoinhaber` – Kontoinhaber (Einspeiser)" }, "bankBic": { "type": "string", "description": "fsg3: `eBIC` – BIC (Einspeiser)" }, "bankIban": { "type": "string", "description": "fsg3: `eIBAN` – IBAN (Einspeiser)" }, "BBFS_question": { "type": "string", "description": "fsg3: `BBFS_Fragestellung` – BBFS Fragestellung" } } }, "subject": { "type": "object", "additionalProperties": true, "description": "Schuldner (die gesuchte Person).", "properties": { "salutation": { "type": "string", "description": "fsg3: `sAnrede` – Schuldner Anrede" }, "firstName": { "type": "string", "description": "fsg3: `sVorname` – Schuldner Vorname" }, "name1": { "type": "string", "description": "fsg3: `sName1` – Schuldner Name" }, "name2": { "type": "string", "description": "fsg3: `sName2` – Schuldner Namenszusatz" }, "street": { "type": "string", "description": "fsg3: `sStrasse` – Schuldner Straße" }, "postalCode": { "type": "string", "description": "fsg3: `sPLZ` – PLZ" }, "city": { "type": "string", "description": "fsg3: `sOrt` – Ort" }, "previousAddresses": { "type": "string", "description": "fsg3: `sVoradressen` – Voradressen" }, "birthDate": { "type": [ "integer", "string" ], "description": "fsg3: `sGeburtsdatum` – Geburtsdatum" }, "birthName": { "type": "string", "description": "fsg3: `sGeburtsname` – Geburtsname" }, "phone": { "type": "string", "description": "fsg3: `sTelefon` – Telefon" }, "email": { "type": "string", "description": "fsg3: `sEmail` – E-Mail" }, "maritalStatus": { "type": "string", "description": "fsg3: `sFamilienstand` – Familienstand" }, "evDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumEV` – Datum EV" }, "arrestWarrantDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumHaftbefehl` – Datum Haftbefehl" }, "bankName": { "type": "string", "description": "fsg3: `sBank` – Bank (Schuldner)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `sKontoinhaber` – Kontoinhaber (Schuldner)" }, "bankBic": { "type": "string", "description": "fsg3: `sBIC` – BIC (Schuldner)" }, "bankIban": { "type": "string", "description": "fsg3: `sIBAN` – IBAN (Schuldner)" }, "children": { "type": "string", "description": "fsg3: `sKinder` – Kinder" }, "income": { "type": "string", "description": "fsg3: `sEinkommen` – Einkommen" }, "employer": { "type": "string", "description": "fsg3: `sArbeitgeber` – Arbeitgeber" }, "lifeInsurance": { "type": "string", "description": "fsg3: `sLebensversicherung` – Lebensversicherung" }, "buildingSociety": { "type": "string", "description": "fsg3: `sBausparer` – Bausparvertrag" }, "car": { "type": "string", "description": "fsg3: `sPKW` – PKW" }, "landlord": { "type": "string", "description": "fsg3: `sVermieter` – Vermieter" }, "otherAttachableAssets": { "type": "string", "description": "fsg3: `sSonstigesPfaendbaresVermoegen` – Sonstiges pfändbares Vermögen" } } }, "creditor": { "type": "object", "additionalProperties": true, "description": "Gläubiger.", "properties": { "firstName": { "type": "string", "description": "fsg3: `gVorname` – Gläubiger Vorname" }, "name1": { "type": "string", "description": "fsg3: `gName1` – Gläubiger" }, "name2": { "type": "string", "description": "fsg3: `gName2` – Gläubiger Namenszusatz" }, "postalCode": { "type": "string", "description": "fsg3: `gPLZ` – Gläubiger PLZ" }, "city": { "type": "string", "description": "fsg3: `gOrt` – Gläubiger Ort" }, "street": { "type": "string", "description": "fsg3: `gStrasse` – Gläubiger Straße" }, "originalCreditor": { "type": "string", "description": "fsg3: `gUrsprungsglaeubiger` – Ursprungsgläubiger" }, "sepaMandateReference": { "type": "string", "description": "fsg3: `gSepaMandateReference` – SEPA-Mandatsreferenz" }, "sepaClientIdentificationNumber": { "type": "string", "description": "fsg3: `gSepaClientIdentificationNumber` – SEPA-Gläubiger-ID" } } }, "results": { "type": "object", "additionalProperties": true, "description": "Ergebnisse je Leistung: `results..`. Nur mit dem Leserecht für Ergebnisse.", "properties": { "RZV101": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RZV101.", "properties": { "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_Unterschriftsdatum` – RZV101 Unterschriftsdatum" }, "bankName": { "type": "string", "description": "fsg3: `RZV101_Bank` – RZV101 Bank" }, "settlementAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Vergleichsbetrag` – RZV101 Vergleichsbetrag" }, "fullTransferDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_ÜberweisungsdatumVoll` – RZV101 ÜberweisungsdatumVoll" }, "acknowledgedDebtAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Schuldanerkenntnis` – RZV101 Schuldanerkenntnis" }, "costs": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Kosten` – RZV101 Kosten" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Ratenhöhe` – RZV101 Ratenhöhe" }, "firstInstallmentDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_ersteRate` – RZV101 ersteRate" }, "monthlyDueDay": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_monatlichzum` – RZV101 monatlichzum" }, "deadline": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_Befristung` – RZV101 Befristung" }, "cashCollectionAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Barinkasso` – RZV101 Barinkasso" }, "receipt": { "type": "string", "description": "fsg3: `RZV101_Quittung` – RZV101 Quittung" } } }, "SEE301": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung SEE301.", "properties": { "healthInsurerKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Krankenkasse_JN` – SEE301 Krankenkasse_JN" }, "healthInsurer": { "type": "string", "description": "fsg3: `SEE301_Krankenkasse` – SEE301 Krankenkasse" }, "pensionInsurerKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Rentenversicherungsträger_JN` – SEE301 Rentenversicherungsträger_JN" }, "pensionInsurer": { "type": "string", "description": "fsg3: `SEE301_Rentenversicherungsträger` – SEE301 Rentenversicherungsträger" }, "pensionInsuranceNumber": { "type": "string", "description": "fsg3: `SEE301_Rentenversicherungsnummer` – SEE301 Rentenversicherungsnummer" }, "bankKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Kreditinstitut_JN` – SEE301 Kreditinstitut_JN" }, "bankName": { "type": "string", "description": "fsg3: `SEE301_Kreditinstitut` – SEE301 Kreditinstitut" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `SEE301_Unterschriftsdatum` – SEE301 Unterschriftsdatum" } } }, "DA320": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung DA320.", "properties": { "subjectName": { "type": "string", "description": "fsg3: `DA320_sName` – DA320 sName" }, "subjectAddress": { "type": "string", "description": "fsg3: `DA320_sAdresse` – DA320 sAdresse" }, "subjectBankName": { "type": "string", "description": "fsg3: `DA320_sBank` – DA320 sBank" }, "subjectBankCode": { "type": "string", "description": "fsg3: `DA320_sBLZ` – DA320 sBLZ" }, "subjectAccountNumber": { "type": "string", "description": "fsg3: `DA320_sKto` – DA320 sKto" }, "subjectIban": { "type": "string", "description": "fsg3: `DA320_sIBAN` – DA320 sIBAN" }, "subjectBic": { "type": "string", "description": "fsg3: `DA320_sBIC` – DA320 sBIC" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `DA320_Ratenbetrag` – DA320 Ratenbetrag" }, "startDate": { "type": [ "integer", "string" ], "description": "fsg3: `DA320_Beginn` – DA320 Beginn" }, "interval": { "type": "string", "description": "fsg3: `DA320_Intervall` – DA320 Intervall" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `DA320_Unterschriftsdatum` – DA320 Unterschriftsdatum" } } }, "LS321": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung LS321.", "properties": { "subjectName": { "type": "string", "description": "fsg3: `LS321_sName` – LS321 sName" }, "subjectAddress": { "type": "string", "description": "fsg3: `LS321_sAdresse` – LS321 sAdresse" }, "subjectBankName": { "type": "string", "description": "fsg3: `LS321_sBank` – LS321 sBank" }, "subjectBankCode": { "type": "string", "description": "fsg3: `LS321_sBLZ` – LS321 sBLZ" }, "subjectAccountNumber": { "type": "string", "description": "fsg3: `LS321_sKto` – LS321 sKto" }, "subjectIban": { "type": "string", "description": "fsg3: `LS321_sIBAN` – LS321 sIBAN" }, "subjectBic": { "type": "string", "description": "fsg3: `LS321_sBIC` – LS321 sBIC" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `LS321_Ratenbetrag` – LS321 Ratenbetrag" }, "startDate": { "type": [ "integer", "string" ], "description": "fsg3: `LS321_Beginn` – LS321 Beginn" }, "interval": { "type": "string", "description": "fsg3: `LS321_Intervall` – LS321 Intervall" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `LS321_Unterschriftsdatum` – LS321 Unterschriftsdatum" } } }, "MSA330": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung MSA330.", "properties": { "salutation": { "type": "string", "description": "fsg3: `MSA330_Anrede` – MSA330 Anrede" }, "firstName": { "type": "string", "description": "fsg3: `MSA330_Vorname` – MSA330 Vorname" }, "name1": { "type": "string", "description": "fsg3: `MSA330_Name1` – MSA330 Name1" }, "name2": { "type": "string", "description": "fsg3: `MSA330_Name2` – MSA330 Name2" }, "street": { "type": "string", "description": "fsg3: `MSA330_Strasse` – MSA330 Strasse" }, "houseNumber": { "type": "string", "description": "fsg3: `MSA330_Hausnummer` – MSA330 Hausnummer" }, "postalCode": { "type": "string", "description": "fsg3: `MSA330_PLZ` – MSA330 PLZ" }, "city": { "type": "string", "description": "fsg3: `MSA330_Ort` – MSA330 Ort" }, "previousAddress": { "type": "string", "description": "fsg3: `MSA330_Voradresse` – MSA330 Voradresse" }, "birthDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_Geburtsdatum` – MSA330 Geburtsdatum" }, "birthName": { "type": "string", "description": "fsg3: `MSA330_Geburtsname` – MSA330 Geburtsname" }, "phoneNumber": { "type": "string", "description": "fsg3: `MSA330_Telefonnummer` – MSA330 Telefonnummer" }, "email": { "type": "string", "description": "fsg3: `MSA330_Email` – MSA330 Email" }, "maritalStatus": { "type": "string", "description": "fsg3: `MSA330_Familienstand` – MSA330 Familienstand" }, "evDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_DatumEV` – MSA330 DatumEV" }, "arrestWarrantDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_DatumHaftbefehl` – MSA330 DatumHaftbefehl" }, "bankName": { "type": "string", "description": "fsg3: `MSA330_Bank` – MSA330 Bank" }, "bankCode": { "type": "string", "description": "fsg3: `MSA330_BLZ` – MSA330 BLZ" }, "accountNumber": { "type": "string", "description": "fsg3: `MSA330_KontoNr` – MSA330 KontoNr" }, "accountHolder": { "type": "string", "description": "fsg3: `MSA330_Kontoinhaber` – MSA330 Kontoinhaber" }, "bic": { "type": "string", "description": "fsg3: `MSA330_BIC` – MSA330 BIC" }, "iban": { "type": "string", "description": "fsg3: `MSA330_IBAN` – MSA330 IBAN" }, "children": { "type": [ "number", "string" ], "description": "fsg3: `MSA330_Kinder` – MSA330 Kinder" }, "income": { "type": "string", "description": "fsg3: `MSA330_Einkommen` – MSA330 Einkommen" }, "employer": { "type": "string", "description": "fsg3: `MSA330_Arbeitgeber` – MSA330 Arbeitgeber" }, "lifeInsurance": { "type": "string", "description": "fsg3: `MSA330_Lebensversicherung` – MSA330 Lebensversicherung" }, "buildingSociety": { "type": "string", "description": "fsg3: `MSA330_Bausparer` – MSA330 Bausparer" }, "car": { "type": "string", "description": "fsg3: `MSA330_PKW` – MSA330 PKW" }, "landlord": { "type": "string", "description": "fsg3: `MSA330_Vermieter` – MSA330 Vermieter" }, "otherAttachableAssets": { "type": "string", "description": "fsg3: `MSA330_sonstiges pfändbare Vermögen` – MSA330 sonstiges pfändbare Vermögen" }, "notes": { "type": "string", "description": "fsg3: `MSA330_Notizen` – MSA330 Notizen" } } }, "AD340": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung AD340.", "properties": { "idNumber": { "type": "string", "description": "fsg3: `AD340_Ausweisnummer` – AD340 Ausweisnummer" }, "deceased": { "type": "string", "description": "fsg3: `AD340_verstorben` – AD340 verstorben" }, "livingSituation": { "type": "string", "description": "fsg3: `AD340_Wohnsituation` – AD340 Wohnsituation" }, "floor": { "type": "string", "description": "fsg3: `AD340_Etage` – AD340 Etage" }, "door": { "type": "string", "description": "fsg3: `AD340_Tür` – AD340 Tür" }, "remarks": { "type": "string", "description": "fsg3: `AD340_Sonstiges` – AD340 Sonstiges" }, "mailbox": { "type": "string", "description": "fsg3: `AD340_Briefkasten` – AD340 Briefkasten" }, "visit1Date": { "type": [ "integer", "string" ], "description": "fsg3: `AD340_Besuchsdatum1` – AD340 Besuchsdatum1" }, "metAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_angetroffen1_JN` – AD340 angetroffen1_JN" }, "agreementAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Vereinbarung1_JN` – AD340 Vereinbarung1_JN" }, "disputedPrincipalClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_HF1_JN` – AD340 bestritten_HF1_JN" }, "disputedAncillaryClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_NF1_JN` – AD340 bestritten_NF1_JN" }, "notificationCardVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Benachrichtigungskarte1_JN` – AD340 Benachrichtigungskarte1_JN" }, "visit1Remarks": { "type": "string", "description": "fsg3: `AD340_SonstigesBesuch1` – AD340 SonstigesBesuch1" }, "visit2Date": { "type": [ "integer", "string" ], "description": "fsg3: `AD340_Besuchsdatum2` – AD340 Besuchsdatum2" }, "metAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Angetroffen2_JN` – AD340 Angetroffen2_JN" }, "agreementAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Vereinbarung2_JN` – AD340 Vereinbarung2_JN" }, "disputedPrincipalClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_HF2_JN` – AD340 bestritten_HF2_JN" }, "disputedAncillaryClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_NF2_JN` – AD340 bestritten_NF2_JN" }, "notificationCardVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Benachrichtigungskarte2_JN` – AD340 Benachrichtigungskarte2_JN" }, "visit2Remarks": { "type": "string", "description": "fsg3: `AD340_SonstigesBesuch2` – AD340 SonstigesBesuch2" }, "callback": { "type": "string", "description": "fsg3: `AD340_Rückruf` – AD340 Rückruf" }, "successProspect": { "type": "string", "description": "fsg3: `AD340_Erfolgsaussicht` – AD340 Erfolgsaussicht" }, "recommendation": { "type": "string", "description": "fsg3: `AD340_Empfehlung` – AD340 Empfehlung" } } }, "VZ350": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung VZ350.", "properties": { "fullPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `VZ350_VollzahlungBetrag` – VZ350 VollzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `VZ350_Datum` – VZ350 Datum" }, "receipt": { "type": "string", "description": "fsg3: `VZ350_Quittung` – VZ350 Quittung" } } }, "TZ351": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung TZ351.", "properties": { "partialPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `TZ351_TeilzahlungBetrag` – TZ351 TeilzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `TZ351_Datum` – TZ351 Datum" }, "receipt": { "type": "string", "description": "fsg3: `TZ351_Quittung` – TZ351 Quittung" } } }, "TZ352": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung TZ352.", "properties": { "partialPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `TZ352_TeilzahlungBetrag` – TZ352 TeilzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `TZ352_Datum` – TZ352 Datum" }, "receipt": { "type": "string", "description": "fsg3: `TZ352_Quittung` – TZ352 Quittung" } } }, "SAR401": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung SAR401.", "properties": { "date": { "type": [ "integer", "string" ], "description": "fsg3: `SAR401_SARDatum` – SAR401 SARDatum" }, "specialRemarks": { "type": "string", "description": "fsg3: `SAR401_SARBesonderes` – SAR401 SARBesonderes" } } }, "RVAA": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAA.", "properties": { "employer": { "type": "string", "description": "fsg3: `RVAA_Arbeitgeber` – RVAA Arbeitgeber" }, "street": { "type": "string", "description": "fsg3: `RVAA_Straße` – RVAA Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAA_Postleitzahl` – RVAA Postleitzahl" }, "city": { "type": "string", "description": "fsg3: `RVAA_Ort` – RVAA Ort" }, "earnings": { "type": [ "number", "string" ], "description": "fsg3: `RVAA_Verdienst` – RVAA Verdienst" } } }, "RVAB": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAB.", "properties": { "bankName": { "type": "string", "description": "fsg3: `RVAB_Bank` – RVAB Bank" }, "iban": { "type": "string", "description": "fsg3: `RVAB_IBAN` – RVAB IBAN" } } }, "RVAK": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAK.", "properties": { "healthInsurer": { "type": "string", "description": "fsg3: `RVAK_Krankenkasse` – RVAK Krankenkasse" }, "street": { "type": "string", "description": "fsg3: `RVAK_Straße` – RVAK Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAK_PLZ` – RVAK PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAK_Ort` – RVAK Ort" }, "phoneNumber": { "type": "string", "description": "fsg3: `RVAK_Telefonnummer` – RVAK Telefonnummer" }, "email": { "type": "string", "description": "fsg3: `RVAK_EMail` – RVAK EMail" }, "fax": { "type": "string", "description": "fsg3: `RVAK_Fax` – RVAK Fax" }, "website": { "type": "string", "description": "fsg3: `RVAK_Homepage` – RVAK Homepage" }, "contactForm": { "type": "string", "description": "fsg3: `RVAK_Kontaktformular` – RVAK Kontaktformular" } } }, "RVAR": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAR.", "properties": { "pensionInsurer": { "type": "string", "description": "fsg3: `RVAR_Rentenversicherung` – RVAR Rentenversicherung" }, "street": { "type": "string", "description": "fsg3: `RVAR_Straße` – RVAR Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAR_PLZ` – RVAR PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAR_Ort` – RVAR Ort" } } }, "RVAV": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAV.", "properties": { "landlord": { "type": "string", "description": "fsg3: `RVAV_Vermieter` – RVAV Vermieter" }, "street": { "type": "string", "description": "fsg3: `RVAV_Straße` – RVAV Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAV_PLZ` – RVAV PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAV_Ort` – RVAV Ort" }, "phoneNumber": { "type": "string", "description": "fsg3: `RVAV_Telefonnummer` – RVAV Telefonnummer" } } }, "RSET": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSET.", "properties": { "phoneNumber": { "type": "string", "description": "fsg3: `RSET_Telefonnummer` – RSET Telefonnummer" } } }, "RSEE": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSEE.", "properties": { "email": { "type": "string", "description": "fsg3: `RSEE_EMail` – RSEE EMail" } } }, "RSES": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSES.", "properties": { "dateOfDeath": { "type": [ "integer", "string" ], "description": "fsg3: `RSES_Sterbedatum` – RSES Sterbedatum" } } }, "RSEI": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSEI.", "properties": { "insolvencyDate": { "type": [ "integer", "string" ], "description": "fsg3: `RSEI_Insolvenzdatum` – RSEI Insolvenzdatum" }, "localCourt": { "type": "string", "description": "fsg3: `RSEI_Amtsgericht` – RSEI Amtsgericht" }, "caseReference": { "type": "string", "description": "fsg3: `RSEI_Aktenzeichen` – RSEI Aktenzeichen" } } }, "BBFS": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung BBFS.", "properties": { "answer": { "type": "string", "description": "fsg3: `BBFS_Antwort` – BBFS Antwort" } } }, "VNA": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung VNA.", "properties": { "street": { "type": "string", "description": "fsg3: `VNA_Straße` – VNA Straße" }, "postalCode": { "type": "string", "description": "fsg3: `VNA_Postleitzahl` – VNA Postleitzahl" }, "city": { "type": "string", "description": "fsg3: `VNA_Ort` – VNA Ort" } } }, "3ADP": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung 3ADP.", "properties": { "visit1Date": { "type": [ "integer", "string" ], "description": "fsg3: `3ADP_Besuchsdatum1` – 3ADP Besuchsdatum1" }, "metAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_angetroffen1_JN` – 3ADP angetroffen1_JN" }, "agreementAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Vereinbarung1_JN` – 3ADP Vereinbarung1_JN" }, "disputedPrincipalClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_HF1_JN` – 3ADP bestritten_HF1_JN" }, "disputedAncillaryClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_NF1_JN` – 3ADP bestritten_NF1_JN" }, "notificationCardVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Benachrichtigungskarte1_JN` – 3ADP Benachrichtigungskarte1_JN" }, "visit2Date": { "type": [ "integer", "string" ], "description": "fsg3: `3ADP_Besuchsdatum2` – 3ADP Besuchsdatum2" }, "metAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Angetroffen2_JN` – 3ADP Angetroffen2_JN" }, "agreementAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Vereinbarung2_JN` – 3ADP Vereinbarung2_JN" }, "disputedPrincipalClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_HF2_JN` – 3ADP bestritten_HF2_JN" }, "disputedAncillaryClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_NF2_JN` – 3ADP bestritten_NF2_JN" }, "notificationCardVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Benachrichtigungskarte2_JN` – 3ADP Benachrichtigungskarte2_JN" }, "successProspect": { "type": "string", "description": "fsg3: `3ADP_Erfolgsaussicht` – 3ADP Erfolgsaussicht" } } } } }, "modified": { "type": "integer", "description": "Letzte Änderung, Millisekunden seit 1970." } } } } }, "example": { "assignment": { "id": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "ref": "100036", "tenantId": "tenant-demo1", "moduleId": "module/fsg", "lifecycleState": "active", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "clientRef": "IADB-4201", "clientDisplayName": "DEBICO AG", "partnerId": "b1c2d3e4-0000-4000-8000-000000000001", "partnerRef": "IADB-5001", "partnerDisplayName": "Anton Aus GmbH", "subjectDisplayName": "Petra Beispiel", "assignee": { "id": "account-toni", "displayName": "Anton Ausführender" }, "status": { "status": "processed", "statusLabel": "Bearbeitet", "deliveryDate": 1790222260000, "confirmationDate": 1790308660000, "processedDate": 1790913460000 }, "order": { "serviceIds": [ "AD340" ], "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "claimDescription": "Adressermittlung", "principalClaim": 100, "totalClaim": 100, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" }, "results": { "AD340": { "visit1Date": "2026-09-30", "metAtVisit1": true, "livingSituation": "Einfamilienhaus", "mailbox": "Name am Briefkasten", "idNumber": "L01X00T47" } }, "modified": 1790913460000 } }, "examples": { "read": { "summary": "Auftrag mit Ergebnissen", "value": { "assignment": { "id": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "ref": "100036", "tenantId": "tenant-demo1", "moduleId": "module/fsg", "lifecycleState": "active", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "clientRef": "IADB-4201", "clientDisplayName": "DEBICO AG", "partnerId": "b1c2d3e4-0000-4000-8000-000000000001", "partnerRef": "IADB-5001", "partnerDisplayName": "Anton Aus GmbH", "subjectDisplayName": "Petra Beispiel", "assignee": { "id": "account-toni", "displayName": "Anton Ausführender" }, "status": { "status": "processed", "statusLabel": "Bearbeitet", "deliveryDate": 1790222260000, "confirmationDate": 1790308660000, "processedDate": 1790913460000 }, "order": { "serviceIds": [ "AD340" ], "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "claimDescription": "Adressermittlung", "principalClaim": 100, "totalClaim": 100, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" }, "results": { "AD340": { "visit1Date": "2026-09-30", "metAtVisit1": true, "livingSituation": "Einfamilienhaus", "mailbox": "Name am Briefkasten", "idNumber": "L01X00T47" } }, "modified": 1790913460000 } } } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" }, "404": { "$ref": "#/components/responses/ErrorResponse" }, "409": { "$ref": "#/components/responses/ErrorResponse" }, "500": { "$ref": "#/components/responses/ErrorResponse" } } }, "patch": { "operationId": "patchApiDtoFsg3Ref", "tags": [ "public" ], "summary": "Change an assignment (FSG, fsg3)", "description": "Schritt 5 des Standardablaufs: einen Auftrag ändern.\n\nNur die genannten Felder ändern sich, `null` leert ein Feld, `status.status` wechselt den Status – sofern das Konto das in der App darf. Der Aufruf gilt ganz oder gar nicht: ein unbekanntes, nicht änderbares oder nicht erlaubtes Feld weist ihn ab, bevor etwas geschrieben wird. Löschen gibt es nicht; storniert wird per Statuswechsel. Die Antwort ist der Auftrag nach der Änderung.", "parameters": [ { "name": "ref", "in": "path", "required": true, "description": "Aktenzeichen des Auftrags; die Auftrags-ID geht ebenso.", "schema": { "type": "string" }, "example": "100036" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Nur die genannten Felder ändern sich; `null` leert ein Feld.", "properties": { "order": { "type": "object", "additionalProperties": true, "properties": { "creditorReference": { "type": "string", "description": "fsg3: `AktenzeichenDesGlaeubigers` – Aktenzeichen Gläubiger" }, "clientReference": { "type": "string", "description": "fsg3: `AktenzeichenEinspeisender` – Aktenzeichen Einspeisender" }, "comment": { "type": "string", "description": "fsg3: `Bemerkung` – Kommentar" }, "settlementLimit": { "type": "string", "description": "fsg3: `Vergleichsgrenze` – Vergleichsgrenze" }, "installmentLimit": { "type": [ "number", "string" ], "description": "fsg3: `Ratenzahlungsgrenze` – Ratenzahlungsgrenze" }, "installmentLabel": { "type": "string", "description": "fsg3: `BezeichnungRatenzahlungsvereinbarung` – Bezeichnung Ratenzahlung" }, "installmentFee": { "type": [ "number", "string" ], "description": "fsg3: `GebuehrRatenzahlungsvereinbarung` – Gebühr Ratenzahlung" }, "showVatToSubject": { "type": [ "boolean", "string" ], "description": "fsg3: `MwStGegenueberDemSchuldnerAusweisen` – MwSt gegenüber Schuldner ausweisen" }, "principalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Hauptforderung` – Hauptforderung" }, "costs": { "type": [ "number", "string" ], "description": "fsg3: `Kosten` – Kosten" }, "interest": { "type": [ "number", "string" ], "description": "fsg3: `Zinsen` – Zinsen" }, "payments": { "type": [ "number", "string" ], "description": "fsg3: `Zahlungen` – Zahlungen" }, "totalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Gesamtforderung` – Gesamtforderung" }, "dailyInterest": { "type": [ "number", "string" ], "description": "fsg3: `Tageszinsen` – Tageszinsen" }, "claimDescription": { "type": "string", "description": "fsg3: `Forderungsbegründung` – Forderungsbegründung" }, "bankName": { "type": "string", "description": "fsg3: `eBank` – Bank (Einspeiser)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `eKontoinhaber` – Kontoinhaber (Einspeiser)" }, "bankBic": { "type": "string", "description": "fsg3: `eBIC` – BIC (Einspeiser)" }, "bankIban": { "type": "string", "description": "fsg3: `eIBAN` – IBAN (Einspeiser)" }, "BBFS_question": { "type": "string", "description": "fsg3: `BBFS_Fragestellung` – BBFS Fragestellung" } } }, "subject": { "type": "object", "additionalProperties": true, "properties": { "salutation": { "type": "string", "description": "fsg3: `sAnrede` – Schuldner Anrede" }, "firstName": { "type": "string", "description": "fsg3: `sVorname` – Schuldner Vorname" }, "name1": { "type": "string", "description": "fsg3: `sName1` – Schuldner Name" }, "name2": { "type": "string", "description": "fsg3: `sName2` – Schuldner Namenszusatz" }, "street": { "type": "string", "description": "fsg3: `sStrasse` – Schuldner Straße" }, "postalCode": { "type": "string", "description": "fsg3: `sPLZ` – PLZ" }, "city": { "type": "string", "description": "fsg3: `sOrt` – Ort" }, "previousAddresses": { "type": "string", "description": "fsg3: `sVoradressen` – Voradressen" }, "birthDate": { "type": [ "integer", "string" ], "description": "fsg3: `sGeburtsdatum` – Geburtsdatum" }, "birthName": { "type": "string", "description": "fsg3: `sGeburtsname` – Geburtsname" }, "phone": { "type": "string", "description": "fsg3: `sTelefon` – Telefon" }, "email": { "type": "string", "description": "fsg3: `sEmail` – E-Mail" }, "maritalStatus": { "type": "string", "description": "fsg3: `sFamilienstand` – Familienstand" }, "evDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumEV` – Datum EV" }, "arrestWarrantDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumHaftbefehl` – Datum Haftbefehl" }, "bankName": { "type": "string", "description": "fsg3: `sBank` – Bank (Schuldner)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `sKontoinhaber` – Kontoinhaber (Schuldner)" }, "bankBic": { "type": "string", "description": "fsg3: `sBIC` – BIC (Schuldner)" }, "bankIban": { "type": "string", "description": "fsg3: `sIBAN` – IBAN (Schuldner)" }, "children": { "type": "string", "description": "fsg3: `sKinder` – Kinder" }, "income": { "type": "string", "description": "fsg3: `sEinkommen` – Einkommen" }, "employer": { "type": "string", "description": "fsg3: `sArbeitgeber` – Arbeitgeber" }, "lifeInsurance": { "type": "string", "description": "fsg3: `sLebensversicherung` – Lebensversicherung" }, "buildingSociety": { "type": "string", "description": "fsg3: `sBausparer` – Bausparvertrag" }, "car": { "type": "string", "description": "fsg3: `sPKW` – PKW" }, "landlord": { "type": "string", "description": "fsg3: `sVermieter` – Vermieter" }, "otherAttachableAssets": { "type": "string", "description": "fsg3: `sSonstigesPfaendbaresVermoegen` – Sonstiges pfändbares Vermögen" } } }, "status": { "type": "object", "additionalProperties": true, "properties": { "status": { "type": "string", "description": "Neuer Bearbeitungsstand, z. B. `cancelled`." } } }, "results": { "type": "object", "additionalProperties": true, "properties": { "RZV101": { "type": "object", "additionalProperties": true, "properties": { "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_Unterschriftsdatum` – RZV101 Unterschriftsdatum" }, "bankName": { "type": "string", "description": "fsg3: `RZV101_Bank` – RZV101 Bank" }, "settlementAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Vergleichsbetrag` – RZV101 Vergleichsbetrag" }, "fullTransferDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_ÜberweisungsdatumVoll` – RZV101 ÜberweisungsdatumVoll" }, "acknowledgedDebtAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Schuldanerkenntnis` – RZV101 Schuldanerkenntnis" }, "costs": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Kosten` – RZV101 Kosten" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Ratenhöhe` – RZV101 Ratenhöhe" }, "firstInstallmentDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_ersteRate` – RZV101 ersteRate" }, "monthlyDueDay": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_monatlichzum` – RZV101 monatlichzum" }, "deadline": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_Befristung` – RZV101 Befristung" }, "cashCollectionAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Barinkasso` – RZV101 Barinkasso" }, "receipt": { "type": "string", "description": "fsg3: `RZV101_Quittung` – RZV101 Quittung" } } }, "SEE301": { "type": "object", "additionalProperties": true, "properties": { "healthInsurerKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Krankenkasse_JN` – SEE301 Krankenkasse_JN" }, "healthInsurer": { "type": "string", "description": "fsg3: `SEE301_Krankenkasse` – SEE301 Krankenkasse" }, "pensionInsurerKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Rentenversicherungsträger_JN` – SEE301 Rentenversicherungsträger_JN" }, "pensionInsurer": { "type": "string", "description": "fsg3: `SEE301_Rentenversicherungsträger` – SEE301 Rentenversicherungsträger" }, "pensionInsuranceNumber": { "type": "string", "description": "fsg3: `SEE301_Rentenversicherungsnummer` – SEE301 Rentenversicherungsnummer" }, "bankKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Kreditinstitut_JN` – SEE301 Kreditinstitut_JN" }, "bankName": { "type": "string", "description": "fsg3: `SEE301_Kreditinstitut` – SEE301 Kreditinstitut" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `SEE301_Unterschriftsdatum` – SEE301 Unterschriftsdatum" } } }, "DA320": { "type": "object", "additionalProperties": true, "properties": { "subjectName": { "type": "string", "description": "fsg3: `DA320_sName` – DA320 sName" }, "subjectAddress": { "type": "string", "description": "fsg3: `DA320_sAdresse` – DA320 sAdresse" }, "subjectBankName": { "type": "string", "description": "fsg3: `DA320_sBank` – DA320 sBank" }, "subjectBankCode": { "type": "string", "description": "fsg3: `DA320_sBLZ` – DA320 sBLZ" }, "subjectAccountNumber": { "type": "string", "description": "fsg3: `DA320_sKto` – DA320 sKto" }, "subjectIban": { "type": "string", "description": "fsg3: `DA320_sIBAN` – DA320 sIBAN" }, "subjectBic": { "type": "string", "description": "fsg3: `DA320_sBIC` – DA320 sBIC" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `DA320_Ratenbetrag` – DA320 Ratenbetrag" }, "startDate": { "type": [ "integer", "string" ], "description": "fsg3: `DA320_Beginn` – DA320 Beginn" }, "interval": { "type": "string", "description": "fsg3: `DA320_Intervall` – DA320 Intervall" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `DA320_Unterschriftsdatum` – DA320 Unterschriftsdatum" } } }, "LS321": { "type": "object", "additionalProperties": true, "properties": { "subjectName": { "type": "string", "description": "fsg3: `LS321_sName` – LS321 sName" }, "subjectAddress": { "type": "string", "description": "fsg3: `LS321_sAdresse` – LS321 sAdresse" }, "subjectBankName": { "type": "string", "description": "fsg3: `LS321_sBank` – LS321 sBank" }, "subjectBankCode": { "type": "string", "description": "fsg3: `LS321_sBLZ` – LS321 sBLZ" }, "subjectAccountNumber": { "type": "string", "description": "fsg3: `LS321_sKto` – LS321 sKto" }, "subjectIban": { "type": "string", "description": "fsg3: `LS321_sIBAN` – LS321 sIBAN" }, "subjectBic": { "type": "string", "description": "fsg3: `LS321_sBIC` – LS321 sBIC" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `LS321_Ratenbetrag` – LS321 Ratenbetrag" }, "startDate": { "type": [ "integer", "string" ], "description": "fsg3: `LS321_Beginn` – LS321 Beginn" }, "interval": { "type": "string", "description": "fsg3: `LS321_Intervall` – LS321 Intervall" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `LS321_Unterschriftsdatum` – LS321 Unterschriftsdatum" } } }, "MSA330": { "type": "object", "additionalProperties": true, "properties": { "salutation": { "type": "string", "description": "fsg3: `MSA330_Anrede` – MSA330 Anrede" }, "firstName": { "type": "string", "description": "fsg3: `MSA330_Vorname` – MSA330 Vorname" }, "name1": { "type": "string", "description": "fsg3: `MSA330_Name1` – MSA330 Name1" }, "name2": { "type": "string", "description": "fsg3: `MSA330_Name2` – MSA330 Name2" }, "street": { "type": "string", "description": "fsg3: `MSA330_Strasse` – MSA330 Strasse" }, "houseNumber": { "type": "string", "description": "fsg3: `MSA330_Hausnummer` – MSA330 Hausnummer" }, "postalCode": { "type": "string", "description": "fsg3: `MSA330_PLZ` – MSA330 PLZ" }, "city": { "type": "string", "description": "fsg3: `MSA330_Ort` – MSA330 Ort" }, "previousAddress": { "type": "string", "description": "fsg3: `MSA330_Voradresse` – MSA330 Voradresse" }, "birthDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_Geburtsdatum` – MSA330 Geburtsdatum" }, "birthName": { "type": "string", "description": "fsg3: `MSA330_Geburtsname` – MSA330 Geburtsname" }, "phoneNumber": { "type": "string", "description": "fsg3: `MSA330_Telefonnummer` – MSA330 Telefonnummer" }, "email": { "type": "string", "description": "fsg3: `MSA330_Email` – MSA330 Email" }, "maritalStatus": { "type": "string", "description": "fsg3: `MSA330_Familienstand` – MSA330 Familienstand" }, "evDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_DatumEV` – MSA330 DatumEV" }, "arrestWarrantDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_DatumHaftbefehl` – MSA330 DatumHaftbefehl" }, "bankName": { "type": "string", "description": "fsg3: `MSA330_Bank` – MSA330 Bank" }, "bankCode": { "type": "string", "description": "fsg3: `MSA330_BLZ` – MSA330 BLZ" }, "accountNumber": { "type": "string", "description": "fsg3: `MSA330_KontoNr` – MSA330 KontoNr" }, "accountHolder": { "type": "string", "description": "fsg3: `MSA330_Kontoinhaber` – MSA330 Kontoinhaber" }, "bic": { "type": "string", "description": "fsg3: `MSA330_BIC` – MSA330 BIC" }, "iban": { "type": "string", "description": "fsg3: `MSA330_IBAN` – MSA330 IBAN" }, "children": { "type": [ "number", "string" ], "description": "fsg3: `MSA330_Kinder` – MSA330 Kinder" }, "income": { "type": "string", "description": "fsg3: `MSA330_Einkommen` – MSA330 Einkommen" }, "employer": { "type": "string", "description": "fsg3: `MSA330_Arbeitgeber` – MSA330 Arbeitgeber" }, "lifeInsurance": { "type": "string", "description": "fsg3: `MSA330_Lebensversicherung` – MSA330 Lebensversicherung" }, "buildingSociety": { "type": "string", "description": "fsg3: `MSA330_Bausparer` – MSA330 Bausparer" }, "car": { "type": "string", "description": "fsg3: `MSA330_PKW` – MSA330 PKW" }, "landlord": { "type": "string", "description": "fsg3: `MSA330_Vermieter` – MSA330 Vermieter" }, "otherAttachableAssets": { "type": "string", "description": "fsg3: `MSA330_sonstiges pfändbare Vermögen` – MSA330 sonstiges pfändbare Vermögen" }, "notes": { "type": "string", "description": "fsg3: `MSA330_Notizen` – MSA330 Notizen" } } }, "AD340": { "type": "object", "additionalProperties": true, "properties": { "idNumber": { "type": "string", "description": "fsg3: `AD340_Ausweisnummer` – AD340 Ausweisnummer" }, "deceased": { "type": "string", "description": "fsg3: `AD340_verstorben` – AD340 verstorben" }, "livingSituation": { "type": "string", "description": "fsg3: `AD340_Wohnsituation` – AD340 Wohnsituation" }, "floor": { "type": "string", "description": "fsg3: `AD340_Etage` – AD340 Etage" }, "door": { "type": "string", "description": "fsg3: `AD340_Tür` – AD340 Tür" }, "remarks": { "type": "string", "description": "fsg3: `AD340_Sonstiges` – AD340 Sonstiges" }, "mailbox": { "type": "string", "description": "fsg3: `AD340_Briefkasten` – AD340 Briefkasten" }, "visit1Date": { "type": [ "integer", "string" ], "description": "fsg3: `AD340_Besuchsdatum1` – AD340 Besuchsdatum1" }, "metAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_angetroffen1_JN` – AD340 angetroffen1_JN" }, "agreementAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Vereinbarung1_JN` – AD340 Vereinbarung1_JN" }, "disputedPrincipalClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_HF1_JN` – AD340 bestritten_HF1_JN" }, "disputedAncillaryClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_NF1_JN` – AD340 bestritten_NF1_JN" }, "notificationCardVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Benachrichtigungskarte1_JN` – AD340 Benachrichtigungskarte1_JN" }, "visit1Remarks": { "type": "string", "description": "fsg3: `AD340_SonstigesBesuch1` – AD340 SonstigesBesuch1" }, "visit2Date": { "type": [ "integer", "string" ], "description": "fsg3: `AD340_Besuchsdatum2` – AD340 Besuchsdatum2" }, "metAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Angetroffen2_JN` – AD340 Angetroffen2_JN" }, "agreementAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Vereinbarung2_JN` – AD340 Vereinbarung2_JN" }, "disputedPrincipalClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_HF2_JN` – AD340 bestritten_HF2_JN" }, "disputedAncillaryClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_NF2_JN` – AD340 bestritten_NF2_JN" }, "notificationCardVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Benachrichtigungskarte2_JN` – AD340 Benachrichtigungskarte2_JN" }, "visit2Remarks": { "type": "string", "description": "fsg3: `AD340_SonstigesBesuch2` – AD340 SonstigesBesuch2" }, "callback": { "type": "string", "description": "fsg3: `AD340_Rückruf` – AD340 Rückruf" }, "successProspect": { "type": "string", "description": "fsg3: `AD340_Erfolgsaussicht` – AD340 Erfolgsaussicht" }, "recommendation": { "type": "string", "description": "fsg3: `AD340_Empfehlung` – AD340 Empfehlung" } } }, "VZ350": { "type": "object", "additionalProperties": true, "properties": { "fullPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `VZ350_VollzahlungBetrag` – VZ350 VollzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `VZ350_Datum` – VZ350 Datum" }, "receipt": { "type": "string", "description": "fsg3: `VZ350_Quittung` – VZ350 Quittung" } } }, "TZ351": { "type": "object", "additionalProperties": true, "properties": { "partialPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `TZ351_TeilzahlungBetrag` – TZ351 TeilzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `TZ351_Datum` – TZ351 Datum" }, "receipt": { "type": "string", "description": "fsg3: `TZ351_Quittung` – TZ351 Quittung" } } }, "TZ352": { "type": "object", "additionalProperties": true, "properties": { "partialPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `TZ352_TeilzahlungBetrag` – TZ352 TeilzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `TZ352_Datum` – TZ352 Datum" }, "receipt": { "type": "string", "description": "fsg3: `TZ352_Quittung` – TZ352 Quittung" } } }, "SAR401": { "type": "object", "additionalProperties": true, "properties": { "date": { "type": [ "integer", "string" ], "description": "fsg3: `SAR401_SARDatum` – SAR401 SARDatum" }, "specialRemarks": { "type": "string", "description": "fsg3: `SAR401_SARBesonderes` – SAR401 SARBesonderes" } } }, "RVAA": { "type": "object", "additionalProperties": true, "properties": { "employer": { "type": "string", "description": "fsg3: `RVAA_Arbeitgeber` – RVAA Arbeitgeber" }, "street": { "type": "string", "description": "fsg3: `RVAA_Straße` – RVAA Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAA_Postleitzahl` – RVAA Postleitzahl" }, "city": { "type": "string", "description": "fsg3: `RVAA_Ort` – RVAA Ort" }, "earnings": { "type": [ "number", "string" ], "description": "fsg3: `RVAA_Verdienst` – RVAA Verdienst" } } }, "RVAB": { "type": "object", "additionalProperties": true, "properties": { "bankName": { "type": "string", "description": "fsg3: `RVAB_Bank` – RVAB Bank" }, "iban": { "type": "string", "description": "fsg3: `RVAB_IBAN` – RVAB IBAN" } } }, "RVAK": { "type": "object", "additionalProperties": true, "properties": { "healthInsurer": { "type": "string", "description": "fsg3: `RVAK_Krankenkasse` – RVAK Krankenkasse" }, "street": { "type": "string", "description": "fsg3: `RVAK_Straße` – RVAK Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAK_PLZ` – RVAK PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAK_Ort` – RVAK Ort" }, "phoneNumber": { "type": "string", "description": "fsg3: `RVAK_Telefonnummer` – RVAK Telefonnummer" }, "email": { "type": "string", "description": "fsg3: `RVAK_EMail` – RVAK EMail" }, "fax": { "type": "string", "description": "fsg3: `RVAK_Fax` – RVAK Fax" }, "website": { "type": "string", "description": "fsg3: `RVAK_Homepage` – RVAK Homepage" }, "contactForm": { "type": "string", "description": "fsg3: `RVAK_Kontaktformular` – RVAK Kontaktformular" } } }, "RVAR": { "type": "object", "additionalProperties": true, "properties": { "pensionInsurer": { "type": "string", "description": "fsg3: `RVAR_Rentenversicherung` – RVAR Rentenversicherung" }, "street": { "type": "string", "description": "fsg3: `RVAR_Straße` – RVAR Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAR_PLZ` – RVAR PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAR_Ort` – RVAR Ort" } } }, "RVAV": { "type": "object", "additionalProperties": true, "properties": { "landlord": { "type": "string", "description": "fsg3: `RVAV_Vermieter` – RVAV Vermieter" }, "street": { "type": "string", "description": "fsg3: `RVAV_Straße` – RVAV Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAV_PLZ` – RVAV PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAV_Ort` – RVAV Ort" }, "phoneNumber": { "type": "string", "description": "fsg3: `RVAV_Telefonnummer` – RVAV Telefonnummer" } } }, "RSET": { "type": "object", "additionalProperties": true, "properties": { "phoneNumber": { "type": "string", "description": "fsg3: `RSET_Telefonnummer` – RSET Telefonnummer" } } }, "RSEE": { "type": "object", "additionalProperties": true, "properties": { "email": { "type": "string", "description": "fsg3: `RSEE_EMail` – RSEE EMail" } } }, "RSES": { "type": "object", "additionalProperties": true, "properties": { "dateOfDeath": { "type": [ "integer", "string" ], "description": "fsg3: `RSES_Sterbedatum` – RSES Sterbedatum" } } }, "RSEI": { "type": "object", "additionalProperties": true, "properties": { "insolvencyDate": { "type": [ "integer", "string" ], "description": "fsg3: `RSEI_Insolvenzdatum` – RSEI Insolvenzdatum" }, "localCourt": { "type": "string", "description": "fsg3: `RSEI_Amtsgericht` – RSEI Amtsgericht" }, "caseReference": { "type": "string", "description": "fsg3: `RSEI_Aktenzeichen` – RSEI Aktenzeichen" } } }, "BBFS": { "type": "object", "additionalProperties": true, "properties": { "answer": { "type": "string", "description": "fsg3: `BBFS_Antwort` – BBFS Antwort" } } }, "VNA": { "type": "object", "additionalProperties": true, "properties": { "street": { "type": "string", "description": "fsg3: `VNA_Straße` – VNA Straße" }, "postalCode": { "type": "string", "description": "fsg3: `VNA_Postleitzahl` – VNA Postleitzahl" }, "city": { "type": "string", "description": "fsg3: `VNA_Ort` – VNA Ort" } } }, "3ADP": { "type": "object", "additionalProperties": true, "properties": { "visit1Date": { "type": [ "integer", "string" ], "description": "fsg3: `3ADP_Besuchsdatum1` – 3ADP Besuchsdatum1" }, "metAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_angetroffen1_JN` – 3ADP angetroffen1_JN" }, "agreementAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Vereinbarung1_JN` – 3ADP Vereinbarung1_JN" }, "disputedPrincipalClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_HF1_JN` – 3ADP bestritten_HF1_JN" }, "disputedAncillaryClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_NF1_JN` – 3ADP bestritten_NF1_JN" }, "notificationCardVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Benachrichtigungskarte1_JN` – 3ADP Benachrichtigungskarte1_JN" }, "visit2Date": { "type": [ "integer", "string" ], "description": "fsg3: `3ADP_Besuchsdatum2` – 3ADP Besuchsdatum2" }, "metAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Angetroffen2_JN` – 3ADP Angetroffen2_JN" }, "agreementAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Vereinbarung2_JN` – 3ADP Vereinbarung2_JN" }, "disputedPrincipalClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_HF2_JN` – 3ADP bestritten_HF2_JN" }, "disputedAncillaryClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_NF2_JN` – 3ADP bestritten_NF2_JN" }, "notificationCardVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Benachrichtigungskarte2_JN` – 3ADP Benachrichtigungskarte2_JN" }, "successProspect": { "type": "string", "description": "fsg3: `3ADP_Erfolgsaussicht` – 3ADP Erfolgsaussicht" } } } } } } }, "example": { "order": { "claimDescription": "Adressermittlung, dringend" } }, "examples": { "field": { "summary": "Ein Feld ändern", "value": { "order": { "claimDescription": "Adressermittlung, dringend" } } }, "status": { "summary": "Status wechseln (stornieren)", "value": { "status": { "status": "cancelled" } } } } } } }, "security": [ { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Der geänderte Auftrag", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "required": [ "assignment" ], "properties": { "assignment": { "type": "object", "additionalProperties": true, "description": "Ein FSG-Auftrag in der fsg3-Form mit englischen Feldnamen. Felder ohne Wert fehlen; Bereiche ohne Leserecht fehlen ganz. Weitere Felder können hinzukommen; die hier genannten bleiben.", "required": [ "id", "ref", "status", "modified" ], "properties": { "id": { "type": "string", "description": "Auftrags-ID." }, "ref": { "type": "string", "description": "fsg3: `IADB-Auftrag` – Auftragsnummer" }, "tenantId": { "type": [ "string", "null" ], "description": "Mandant." }, "moduleId": { "type": [ "string", "null" ] }, "lifecycleState": { "type": [ "string", "null" ], "description": "`active`, `archived` oder `removed`." }, "clientId": { "type": [ "string", "null" ], "description": "Einspeisender (Organisation)." }, "partnerId": { "type": [ "string", "null" ], "description": "Ausführender (Organisation), per PLZ zugeordnet." }, "subjectDisplayName": { "type": [ "string", "null" ], "description": "Anzeigename des Schuldners." }, "phone": { "type": "string", "description": "fsg3: `Telefon`" }, "clientRef": { "type": "string", "description": "fsg3: `EinspeisenderNr` – Einspeisender-Nr." }, "clientDisplayName": { "type": "string", "description": "fsg3: `Einspeisender`" }, "partnerRef": { "type": "string", "description": "fsg3: `AusführenderNr` – Ausführender-Nr." }, "partnerDisplayName": { "type": "string", "description": "fsg3: `Ausführender`" }, "assignee": { "type": [ "object", "null" ], "description": "Bearbeiter beim Ausführenden.", "properties": { "id": { "type": "string" }, "displayName": { "type": [ "string", "null" ] } } }, "status": { "type": "object", "additionalProperties": true, "description": "Status und Datumswerte. Die Datumswerte setzt der Ablauf; beim Schreiben werden sie ignoriert.", "required": [ "status", "statusLabel" ], "properties": { "status": { "type": "string", "description": "fsg3: `Auftragsstatus` – Status" }, "statusLabel": { "type": [ "string", "null" ], "description": "Bearbeitungsstand als Anzeigetext." }, "deliveryDate": { "type": [ "integer", "string" ], "description": "fsg3: `Einstelldatum` – Einstelldatum" }, "confirmationDate": { "type": [ "integer", "string" ], "description": "fsg3: `Bestätigungsdatum` – Bestätigungsdatum" }, "dueDate": { "type": [ "integer", "string" ], "description": "fsg3: `Bearbeitungsende` – Fälligkeitsdatum" }, "returnDate": { "type": [ "integer", "string" ], "description": "fsg3: `Rückgabedatum` – Rückgabedatum" }, "invoiceDate": { "type": [ "integer", "string" ], "description": "fsg3: `Rechnungsdatum` – Rechnungsdatum" }, "processedDate": { "type": [ "integer", "string" ], "description": "fsg3: `Abschlussdatum` – Bearbeitungsdatum" } } }, "order": { "type": "object", "additionalProperties": true, "description": "Auftragsdaten.", "properties": { "serviceIds": { "type": "array", "items": { "type": "string" }, "description": "Beauftragte Leistungen, z. B. `AD340`." }, "creditorReference": { "type": "string", "description": "fsg3: `AktenzeichenDesGlaeubigers` – Aktenzeichen Gläubiger" }, "clientReference": { "type": "string", "description": "fsg3: `AktenzeichenEinspeisender` – Aktenzeichen Einspeisender" }, "stage": { "type": "string", "description": "fsg3: `Stadium` – Stadium" }, "private": { "type": [ "boolean", "string" ], "description": "fsg3: `private` – Privater Auftrag" }, "comment": { "type": "string", "description": "fsg3: `Bemerkung` – Kommentar" }, "settlementLimit": { "type": "string", "description": "fsg3: `Vergleichsgrenze` – Vergleichsgrenze" }, "installmentLimit": { "type": [ "number", "string" ], "description": "fsg3: `Ratenzahlungsgrenze` – Ratenzahlungsgrenze" }, "installmentLabel": { "type": "string", "description": "fsg3: `BezeichnungRatenzahlungsvereinbarung` – Bezeichnung Ratenzahlung" }, "installmentFee": { "type": [ "number", "string" ], "description": "fsg3: `GebuehrRatenzahlungsvereinbarung` – Gebühr Ratenzahlung" }, "showVatToSubject": { "type": [ "boolean", "string" ], "description": "fsg3: `MwStGegenueberDemSchuldnerAusweisen` – MwSt gegenüber Schuldner ausweisen" }, "typeLabel": { "type": "string", "description": "fsg3: `Auftragsart` – Auftragsart" }, "principalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Hauptforderung` – Hauptforderung" }, "costs": { "type": [ "number", "string" ], "description": "fsg3: `Kosten` – Kosten" }, "interest": { "type": [ "number", "string" ], "description": "fsg3: `Zinsen` – Zinsen" }, "payments": { "type": [ "number", "string" ], "description": "fsg3: `Zahlungen` – Zahlungen" }, "totalClaim": { "type": [ "number", "string" ], "description": "fsg3: `Gesamtforderung` – Gesamtforderung" }, "dailyInterest": { "type": [ "number", "string" ], "description": "fsg3: `Tageszinsen` – Tageszinsen" }, "claimDescription": { "type": "string", "description": "fsg3: `Forderungsbegründung` – Forderungsbegründung" }, "bankName": { "type": "string", "description": "fsg3: `eBank` – Bank (Einspeiser)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `eKontoinhaber` – Kontoinhaber (Einspeiser)" }, "bankBic": { "type": "string", "description": "fsg3: `eBIC` – BIC (Einspeiser)" }, "bankIban": { "type": "string", "description": "fsg3: `eIBAN` – IBAN (Einspeiser)" }, "BBFS_question": { "type": "string", "description": "fsg3: `BBFS_Fragestellung` – BBFS Fragestellung" } } }, "subject": { "type": "object", "additionalProperties": true, "description": "Schuldner (die gesuchte Person).", "properties": { "salutation": { "type": "string", "description": "fsg3: `sAnrede` – Schuldner Anrede" }, "firstName": { "type": "string", "description": "fsg3: `sVorname` – Schuldner Vorname" }, "name1": { "type": "string", "description": "fsg3: `sName1` – Schuldner Name" }, "name2": { "type": "string", "description": "fsg3: `sName2` – Schuldner Namenszusatz" }, "street": { "type": "string", "description": "fsg3: `sStrasse` – Schuldner Straße" }, "postalCode": { "type": "string", "description": "fsg3: `sPLZ` – PLZ" }, "city": { "type": "string", "description": "fsg3: `sOrt` – Ort" }, "previousAddresses": { "type": "string", "description": "fsg3: `sVoradressen` – Voradressen" }, "birthDate": { "type": [ "integer", "string" ], "description": "fsg3: `sGeburtsdatum` – Geburtsdatum" }, "birthName": { "type": "string", "description": "fsg3: `sGeburtsname` – Geburtsname" }, "phone": { "type": "string", "description": "fsg3: `sTelefon` – Telefon" }, "email": { "type": "string", "description": "fsg3: `sEmail` – E-Mail" }, "maritalStatus": { "type": "string", "description": "fsg3: `sFamilienstand` – Familienstand" }, "evDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumEV` – Datum EV" }, "arrestWarrantDate": { "type": [ "integer", "string" ], "description": "fsg3: `sDatumHaftbefehl` – Datum Haftbefehl" }, "bankName": { "type": "string", "description": "fsg3: `sBank` – Bank (Schuldner)" }, "bankAccountHolder": { "type": "string", "description": "fsg3: `sKontoinhaber` – Kontoinhaber (Schuldner)" }, "bankBic": { "type": "string", "description": "fsg3: `sBIC` – BIC (Schuldner)" }, "bankIban": { "type": "string", "description": "fsg3: `sIBAN` – IBAN (Schuldner)" }, "children": { "type": "string", "description": "fsg3: `sKinder` – Kinder" }, "income": { "type": "string", "description": "fsg3: `sEinkommen` – Einkommen" }, "employer": { "type": "string", "description": "fsg3: `sArbeitgeber` – Arbeitgeber" }, "lifeInsurance": { "type": "string", "description": "fsg3: `sLebensversicherung` – Lebensversicherung" }, "buildingSociety": { "type": "string", "description": "fsg3: `sBausparer` – Bausparvertrag" }, "car": { "type": "string", "description": "fsg3: `sPKW` – PKW" }, "landlord": { "type": "string", "description": "fsg3: `sVermieter` – Vermieter" }, "otherAttachableAssets": { "type": "string", "description": "fsg3: `sSonstigesPfaendbaresVermoegen` – Sonstiges pfändbares Vermögen" } } }, "creditor": { "type": "object", "additionalProperties": true, "description": "Gläubiger.", "properties": { "firstName": { "type": "string", "description": "fsg3: `gVorname` – Gläubiger Vorname" }, "name1": { "type": "string", "description": "fsg3: `gName1` – Gläubiger" }, "name2": { "type": "string", "description": "fsg3: `gName2` – Gläubiger Namenszusatz" }, "postalCode": { "type": "string", "description": "fsg3: `gPLZ` – Gläubiger PLZ" }, "city": { "type": "string", "description": "fsg3: `gOrt` – Gläubiger Ort" }, "street": { "type": "string", "description": "fsg3: `gStrasse` – Gläubiger Straße" }, "originalCreditor": { "type": "string", "description": "fsg3: `gUrsprungsglaeubiger` – Ursprungsgläubiger" }, "sepaMandateReference": { "type": "string", "description": "fsg3: `gSepaMandateReference` – SEPA-Mandatsreferenz" }, "sepaClientIdentificationNumber": { "type": "string", "description": "fsg3: `gSepaClientIdentificationNumber` – SEPA-Gläubiger-ID" } } }, "results": { "type": "object", "additionalProperties": true, "description": "Ergebnisse je Leistung: `results..`. Nur mit dem Leserecht für Ergebnisse.", "properties": { "RZV101": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RZV101.", "properties": { "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_Unterschriftsdatum` – RZV101 Unterschriftsdatum" }, "bankName": { "type": "string", "description": "fsg3: `RZV101_Bank` – RZV101 Bank" }, "settlementAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Vergleichsbetrag` – RZV101 Vergleichsbetrag" }, "fullTransferDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_ÜberweisungsdatumVoll` – RZV101 ÜberweisungsdatumVoll" }, "acknowledgedDebtAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Schuldanerkenntnis` – RZV101 Schuldanerkenntnis" }, "costs": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Kosten` – RZV101 Kosten" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Ratenhöhe` – RZV101 Ratenhöhe" }, "firstInstallmentDate": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_ersteRate` – RZV101 ersteRate" }, "monthlyDueDay": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_monatlichzum` – RZV101 monatlichzum" }, "deadline": { "type": [ "integer", "string" ], "description": "fsg3: `RZV101_Befristung` – RZV101 Befristung" }, "cashCollectionAmount": { "type": [ "number", "string" ], "description": "fsg3: `RZV101_Barinkasso` – RZV101 Barinkasso" }, "receipt": { "type": "string", "description": "fsg3: `RZV101_Quittung` – RZV101 Quittung" } } }, "SEE301": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung SEE301.", "properties": { "healthInsurerKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Krankenkasse_JN` – SEE301 Krankenkasse_JN" }, "healthInsurer": { "type": "string", "description": "fsg3: `SEE301_Krankenkasse` – SEE301 Krankenkasse" }, "pensionInsurerKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Rentenversicherungsträger_JN` – SEE301 Rentenversicherungsträger_JN" }, "pensionInsurer": { "type": "string", "description": "fsg3: `SEE301_Rentenversicherungsträger` – SEE301 Rentenversicherungsträger" }, "pensionInsuranceNumber": { "type": "string", "description": "fsg3: `SEE301_Rentenversicherungsnummer` – SEE301 Rentenversicherungsnummer" }, "bankKnown": { "type": [ "boolean", "string" ], "description": "fsg3: `SEE301_Kreditinstitut_JN` – SEE301 Kreditinstitut_JN" }, "bankName": { "type": "string", "description": "fsg3: `SEE301_Kreditinstitut` – SEE301 Kreditinstitut" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `SEE301_Unterschriftsdatum` – SEE301 Unterschriftsdatum" } } }, "DA320": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung DA320.", "properties": { "subjectName": { "type": "string", "description": "fsg3: `DA320_sName` – DA320 sName" }, "subjectAddress": { "type": "string", "description": "fsg3: `DA320_sAdresse` – DA320 sAdresse" }, "subjectBankName": { "type": "string", "description": "fsg3: `DA320_sBank` – DA320 sBank" }, "subjectBankCode": { "type": "string", "description": "fsg3: `DA320_sBLZ` – DA320 sBLZ" }, "subjectAccountNumber": { "type": "string", "description": "fsg3: `DA320_sKto` – DA320 sKto" }, "subjectIban": { "type": "string", "description": "fsg3: `DA320_sIBAN` – DA320 sIBAN" }, "subjectBic": { "type": "string", "description": "fsg3: `DA320_sBIC` – DA320 sBIC" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `DA320_Ratenbetrag` – DA320 Ratenbetrag" }, "startDate": { "type": [ "integer", "string" ], "description": "fsg3: `DA320_Beginn` – DA320 Beginn" }, "interval": { "type": "string", "description": "fsg3: `DA320_Intervall` – DA320 Intervall" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `DA320_Unterschriftsdatum` – DA320 Unterschriftsdatum" } } }, "LS321": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung LS321.", "properties": { "subjectName": { "type": "string", "description": "fsg3: `LS321_sName` – LS321 sName" }, "subjectAddress": { "type": "string", "description": "fsg3: `LS321_sAdresse` – LS321 sAdresse" }, "subjectBankName": { "type": "string", "description": "fsg3: `LS321_sBank` – LS321 sBank" }, "subjectBankCode": { "type": "string", "description": "fsg3: `LS321_sBLZ` – LS321 sBLZ" }, "subjectAccountNumber": { "type": "string", "description": "fsg3: `LS321_sKto` – LS321 sKto" }, "subjectIban": { "type": "string", "description": "fsg3: `LS321_sIBAN` – LS321 sIBAN" }, "subjectBic": { "type": "string", "description": "fsg3: `LS321_sBIC` – LS321 sBIC" }, "installmentAmount": { "type": [ "number", "string" ], "description": "fsg3: `LS321_Ratenbetrag` – LS321 Ratenbetrag" }, "startDate": { "type": [ "integer", "string" ], "description": "fsg3: `LS321_Beginn` – LS321 Beginn" }, "interval": { "type": "string", "description": "fsg3: `LS321_Intervall` – LS321 Intervall" }, "signatureDate": { "type": [ "integer", "string" ], "description": "fsg3: `LS321_Unterschriftsdatum` – LS321 Unterschriftsdatum" } } }, "MSA330": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung MSA330.", "properties": { "salutation": { "type": "string", "description": "fsg3: `MSA330_Anrede` – MSA330 Anrede" }, "firstName": { "type": "string", "description": "fsg3: `MSA330_Vorname` – MSA330 Vorname" }, "name1": { "type": "string", "description": "fsg3: `MSA330_Name1` – MSA330 Name1" }, "name2": { "type": "string", "description": "fsg3: `MSA330_Name2` – MSA330 Name2" }, "street": { "type": "string", "description": "fsg3: `MSA330_Strasse` – MSA330 Strasse" }, "houseNumber": { "type": "string", "description": "fsg3: `MSA330_Hausnummer` – MSA330 Hausnummer" }, "postalCode": { "type": "string", "description": "fsg3: `MSA330_PLZ` – MSA330 PLZ" }, "city": { "type": "string", "description": "fsg3: `MSA330_Ort` – MSA330 Ort" }, "previousAddress": { "type": "string", "description": "fsg3: `MSA330_Voradresse` – MSA330 Voradresse" }, "birthDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_Geburtsdatum` – MSA330 Geburtsdatum" }, "birthName": { "type": "string", "description": "fsg3: `MSA330_Geburtsname` – MSA330 Geburtsname" }, "phoneNumber": { "type": "string", "description": "fsg3: `MSA330_Telefonnummer` – MSA330 Telefonnummer" }, "email": { "type": "string", "description": "fsg3: `MSA330_Email` – MSA330 Email" }, "maritalStatus": { "type": "string", "description": "fsg3: `MSA330_Familienstand` – MSA330 Familienstand" }, "evDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_DatumEV` – MSA330 DatumEV" }, "arrestWarrantDate": { "type": [ "integer", "string" ], "description": "fsg3: `MSA330_DatumHaftbefehl` – MSA330 DatumHaftbefehl" }, "bankName": { "type": "string", "description": "fsg3: `MSA330_Bank` – MSA330 Bank" }, "bankCode": { "type": "string", "description": "fsg3: `MSA330_BLZ` – MSA330 BLZ" }, "accountNumber": { "type": "string", "description": "fsg3: `MSA330_KontoNr` – MSA330 KontoNr" }, "accountHolder": { "type": "string", "description": "fsg3: `MSA330_Kontoinhaber` – MSA330 Kontoinhaber" }, "bic": { "type": "string", "description": "fsg3: `MSA330_BIC` – MSA330 BIC" }, "iban": { "type": "string", "description": "fsg3: `MSA330_IBAN` – MSA330 IBAN" }, "children": { "type": [ "number", "string" ], "description": "fsg3: `MSA330_Kinder` – MSA330 Kinder" }, "income": { "type": "string", "description": "fsg3: `MSA330_Einkommen` – MSA330 Einkommen" }, "employer": { "type": "string", "description": "fsg3: `MSA330_Arbeitgeber` – MSA330 Arbeitgeber" }, "lifeInsurance": { "type": "string", "description": "fsg3: `MSA330_Lebensversicherung` – MSA330 Lebensversicherung" }, "buildingSociety": { "type": "string", "description": "fsg3: `MSA330_Bausparer` – MSA330 Bausparer" }, "car": { "type": "string", "description": "fsg3: `MSA330_PKW` – MSA330 PKW" }, "landlord": { "type": "string", "description": "fsg3: `MSA330_Vermieter` – MSA330 Vermieter" }, "otherAttachableAssets": { "type": "string", "description": "fsg3: `MSA330_sonstiges pfändbare Vermögen` – MSA330 sonstiges pfändbare Vermögen" }, "notes": { "type": "string", "description": "fsg3: `MSA330_Notizen` – MSA330 Notizen" } } }, "AD340": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung AD340.", "properties": { "idNumber": { "type": "string", "description": "fsg3: `AD340_Ausweisnummer` – AD340 Ausweisnummer" }, "deceased": { "type": "string", "description": "fsg3: `AD340_verstorben` – AD340 verstorben" }, "livingSituation": { "type": "string", "description": "fsg3: `AD340_Wohnsituation` – AD340 Wohnsituation" }, "floor": { "type": "string", "description": "fsg3: `AD340_Etage` – AD340 Etage" }, "door": { "type": "string", "description": "fsg3: `AD340_Tür` – AD340 Tür" }, "remarks": { "type": "string", "description": "fsg3: `AD340_Sonstiges` – AD340 Sonstiges" }, "mailbox": { "type": "string", "description": "fsg3: `AD340_Briefkasten` – AD340 Briefkasten" }, "visit1Date": { "type": [ "integer", "string" ], "description": "fsg3: `AD340_Besuchsdatum1` – AD340 Besuchsdatum1" }, "metAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_angetroffen1_JN` – AD340 angetroffen1_JN" }, "agreementAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Vereinbarung1_JN` – AD340 Vereinbarung1_JN" }, "disputedPrincipalClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_HF1_JN` – AD340 bestritten_HF1_JN" }, "disputedAncillaryClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_NF1_JN` – AD340 bestritten_NF1_JN" }, "notificationCardVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Benachrichtigungskarte1_JN` – AD340 Benachrichtigungskarte1_JN" }, "visit1Remarks": { "type": "string", "description": "fsg3: `AD340_SonstigesBesuch1` – AD340 SonstigesBesuch1" }, "visit2Date": { "type": [ "integer", "string" ], "description": "fsg3: `AD340_Besuchsdatum2` – AD340 Besuchsdatum2" }, "metAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Angetroffen2_JN` – AD340 Angetroffen2_JN" }, "agreementAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Vereinbarung2_JN` – AD340 Vereinbarung2_JN" }, "disputedPrincipalClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_HF2_JN` – AD340 bestritten_HF2_JN" }, "disputedAncillaryClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_bestritten_NF2_JN` – AD340 bestritten_NF2_JN" }, "notificationCardVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `AD340_Benachrichtigungskarte2_JN` – AD340 Benachrichtigungskarte2_JN" }, "visit2Remarks": { "type": "string", "description": "fsg3: `AD340_SonstigesBesuch2` – AD340 SonstigesBesuch2" }, "callback": { "type": "string", "description": "fsg3: `AD340_Rückruf` – AD340 Rückruf" }, "successProspect": { "type": "string", "description": "fsg3: `AD340_Erfolgsaussicht` – AD340 Erfolgsaussicht" }, "recommendation": { "type": "string", "description": "fsg3: `AD340_Empfehlung` – AD340 Empfehlung" } } }, "VZ350": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung VZ350.", "properties": { "fullPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `VZ350_VollzahlungBetrag` – VZ350 VollzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `VZ350_Datum` – VZ350 Datum" }, "receipt": { "type": "string", "description": "fsg3: `VZ350_Quittung` – VZ350 Quittung" } } }, "TZ351": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung TZ351.", "properties": { "partialPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `TZ351_TeilzahlungBetrag` – TZ351 TeilzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `TZ351_Datum` – TZ351 Datum" }, "receipt": { "type": "string", "description": "fsg3: `TZ351_Quittung` – TZ351 Quittung" } } }, "TZ352": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung TZ352.", "properties": { "partialPaymentAmount": { "type": [ "number", "string" ], "description": "fsg3: `TZ352_TeilzahlungBetrag` – TZ352 TeilzahlungBetrag" }, "date": { "type": [ "integer", "string" ], "description": "fsg3: `TZ352_Datum` – TZ352 Datum" }, "receipt": { "type": "string", "description": "fsg3: `TZ352_Quittung` – TZ352 Quittung" } } }, "SAR401": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung SAR401.", "properties": { "date": { "type": [ "integer", "string" ], "description": "fsg3: `SAR401_SARDatum` – SAR401 SARDatum" }, "specialRemarks": { "type": "string", "description": "fsg3: `SAR401_SARBesonderes` – SAR401 SARBesonderes" } } }, "RVAA": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAA.", "properties": { "employer": { "type": "string", "description": "fsg3: `RVAA_Arbeitgeber` – RVAA Arbeitgeber" }, "street": { "type": "string", "description": "fsg3: `RVAA_Straße` – RVAA Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAA_Postleitzahl` – RVAA Postleitzahl" }, "city": { "type": "string", "description": "fsg3: `RVAA_Ort` – RVAA Ort" }, "earnings": { "type": [ "number", "string" ], "description": "fsg3: `RVAA_Verdienst` – RVAA Verdienst" } } }, "RVAB": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAB.", "properties": { "bankName": { "type": "string", "description": "fsg3: `RVAB_Bank` – RVAB Bank" }, "iban": { "type": "string", "description": "fsg3: `RVAB_IBAN` – RVAB IBAN" } } }, "RVAK": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAK.", "properties": { "healthInsurer": { "type": "string", "description": "fsg3: `RVAK_Krankenkasse` – RVAK Krankenkasse" }, "street": { "type": "string", "description": "fsg3: `RVAK_Straße` – RVAK Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAK_PLZ` – RVAK PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAK_Ort` – RVAK Ort" }, "phoneNumber": { "type": "string", "description": "fsg3: `RVAK_Telefonnummer` – RVAK Telefonnummer" }, "email": { "type": "string", "description": "fsg3: `RVAK_EMail` – RVAK EMail" }, "fax": { "type": "string", "description": "fsg3: `RVAK_Fax` – RVAK Fax" }, "website": { "type": "string", "description": "fsg3: `RVAK_Homepage` – RVAK Homepage" }, "contactForm": { "type": "string", "description": "fsg3: `RVAK_Kontaktformular` – RVAK Kontaktformular" } } }, "RVAR": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAR.", "properties": { "pensionInsurer": { "type": "string", "description": "fsg3: `RVAR_Rentenversicherung` – RVAR Rentenversicherung" }, "street": { "type": "string", "description": "fsg3: `RVAR_Straße` – RVAR Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAR_PLZ` – RVAR PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAR_Ort` – RVAR Ort" } } }, "RVAV": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RVAV.", "properties": { "landlord": { "type": "string", "description": "fsg3: `RVAV_Vermieter` – RVAV Vermieter" }, "street": { "type": "string", "description": "fsg3: `RVAV_Straße` – RVAV Straße" }, "postalCode": { "type": "string", "description": "fsg3: `RVAV_PLZ` – RVAV PLZ" }, "city": { "type": "string", "description": "fsg3: `RVAV_Ort` – RVAV Ort" }, "phoneNumber": { "type": "string", "description": "fsg3: `RVAV_Telefonnummer` – RVAV Telefonnummer" } } }, "RSET": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSET.", "properties": { "phoneNumber": { "type": "string", "description": "fsg3: `RSET_Telefonnummer` – RSET Telefonnummer" } } }, "RSEE": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSEE.", "properties": { "email": { "type": "string", "description": "fsg3: `RSEE_EMail` – RSEE EMail" } } }, "RSES": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSES.", "properties": { "dateOfDeath": { "type": [ "integer", "string" ], "description": "fsg3: `RSES_Sterbedatum` – RSES Sterbedatum" } } }, "RSEI": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung RSEI.", "properties": { "insolvencyDate": { "type": [ "integer", "string" ], "description": "fsg3: `RSEI_Insolvenzdatum` – RSEI Insolvenzdatum" }, "localCourt": { "type": "string", "description": "fsg3: `RSEI_Amtsgericht` – RSEI Amtsgericht" }, "caseReference": { "type": "string", "description": "fsg3: `RSEI_Aktenzeichen` – RSEI Aktenzeichen" } } }, "BBFS": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung BBFS.", "properties": { "answer": { "type": "string", "description": "fsg3: `BBFS_Antwort` – BBFS Antwort" } } }, "VNA": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung VNA.", "properties": { "street": { "type": "string", "description": "fsg3: `VNA_Straße` – VNA Straße" }, "postalCode": { "type": "string", "description": "fsg3: `VNA_Postleitzahl` – VNA Postleitzahl" }, "city": { "type": "string", "description": "fsg3: `VNA_Ort` – VNA Ort" } } }, "3ADP": { "type": "object", "additionalProperties": true, "description": "Ergebnisse der Leistung 3ADP.", "properties": { "visit1Date": { "type": [ "integer", "string" ], "description": "fsg3: `3ADP_Besuchsdatum1` – 3ADP Besuchsdatum1" }, "metAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_angetroffen1_JN` – 3ADP angetroffen1_JN" }, "agreementAtVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Vereinbarung1_JN` – 3ADP Vereinbarung1_JN" }, "disputedPrincipalClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_HF1_JN` – 3ADP bestritten_HF1_JN" }, "disputedAncillaryClaimVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_NF1_JN` – 3ADP bestritten_NF1_JN" }, "notificationCardVisit1": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Benachrichtigungskarte1_JN` – 3ADP Benachrichtigungskarte1_JN" }, "visit2Date": { "type": [ "integer", "string" ], "description": "fsg3: `3ADP_Besuchsdatum2` – 3ADP Besuchsdatum2" }, "metAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Angetroffen2_JN` – 3ADP Angetroffen2_JN" }, "agreementAtVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Vereinbarung2_JN` – 3ADP Vereinbarung2_JN" }, "disputedPrincipalClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_HF2_JN` – 3ADP bestritten_HF2_JN" }, "disputedAncillaryClaimVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_bestritten_NF2_JN` – 3ADP bestritten_NF2_JN" }, "notificationCardVisit2": { "type": [ "boolean", "string" ], "description": "fsg3: `3ADP_Benachrichtigungskarte2_JN` – 3ADP Benachrichtigungskarte2_JN" }, "successProspect": { "type": "string", "description": "fsg3: `3ADP_Erfolgsaussicht` – 3ADP Erfolgsaussicht" } } } } }, "modified": { "type": "integer", "description": "Letzte Änderung, Millisekunden seit 1970." } } }, "dataVersion": { "type": [ "integer", "null" ] } } }, "example": { "assignment": { "id": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "ref": "100036", "tenantId": "tenant-demo1", "moduleId": "module/fsg", "lifecycleState": "active", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "clientRef": "IADB-4201", "clientDisplayName": "DEBICO AG", "partnerId": "b1c2d3e4-0000-4000-8000-000000000001", "partnerRef": "IADB-5001", "partnerDisplayName": "Anton Aus GmbH", "subjectDisplayName": "Petra Beispiel", "assignee": null, "status": { "status": "to_confirm", "statusLabel": "Zu bestätigen", "deliveryDate": 1790222260000 }, "order": { "serviceIds": [ "AD340" ], "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "claimDescription": "Adressermittlung, dringend", "principalClaim": 100, "totalClaim": 100, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" }, "results": {}, "modified": 1790222290000 }, "dataVersion": 1790222290000 }, "examples": { "changed": { "summary": "Geändert", "value": { "assignment": { "id": "3f6d2c1e-7b4a-4c1e-9a53-2b8e0c4d7f10", "ref": "100036", "tenantId": "tenant-demo1", "moduleId": "module/fsg", "lifecycleState": "active", "clientId": "a403fc5a-0213-485a-95f1-091a5daf51f7", "clientRef": "IADB-4201", "clientDisplayName": "DEBICO AG", "partnerId": "b1c2d3e4-0000-4000-8000-000000000001", "partnerRef": "IADB-5001", "partnerDisplayName": "Anton Aus GmbH", "subjectDisplayName": "Petra Beispiel", "assignee": null, "status": { "status": "to_confirm", "statusLabel": "Zu bestätigen", "deliveryDate": 1790222260000 }, "order": { "serviceIds": [ "AD340" ], "clientReference": "ERP-4711", "creditorReference": "GL-2026-0815", "claimDescription": "Adressermittlung, dringend", "principalClaim": 100, "totalClaim": 100, "bankAccountHolder": "DEBICO AG", "bankBic": "GENODEF1M04", "bankIban": "DE02120300000000202051" }, "subject": { "firstName": "Petra", "name1": "Beispiel", "street": "Musterweg 1", "postalCode": "33106", "city": "Paderborn" }, "creditor": { "name1": "Gläubiger GmbH", "street": "Gläubigerweg 1", "postalCode": "33613", "city": "Bielefeld" }, "results": {}, "modified": 1790222290000 }, "dataVersion": 1790222290000 } } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" }, "404": { "$ref": "#/components/responses/ErrorResponse" }, "409": { "$ref": "#/components/responses/ErrorResponse" }, "500": { "$ref": "#/components/responses/ErrorResponse" } } } } } }