API - finvue GmbH

Inhalt

Authentifizierung
- Login
- Logout
Reporting
Datenübermittlung

Authentifizierung

Die IP-Adresse des Rechners, von dem auf die API zugegriffen wird, muss zuerst freigeschaltet werden. Danach erfolgt die Authentifizierung per eMail und Passwort. War die Authentifizierung erfolgreich, wird ein Token zurückgegeben, mit dem für einen bestimmten Zeitraum (TTL) Zugriffe durchgeführt werden können.

Request	POST
URL	/auth/login
Header	Content-Type: application/x-www-form-urlencoded
Parameter	email, password

curl --location --request POST '[API-Endpoint]/auth/login' --header 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'email=info@finvue.at' --data-urlencode 'password=traritrara'

{"access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3Q6ODA4MFwvcmVzdGFwaVwvYXV0aFwvbG9naW4iLCJpYXQiOjE2NjAyMTQ3NDIsImV4cCI6MTY2MDIxODM0MiwibmJmIjoxNjYwMjE0NzQyLCJqdGkiOiJzVXpocHpFVk84TjFzNXlCIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIiwiY2xpZW50aWQiOjF9.Dn5JAk3m0D2PW6SEVNpxnQdhgsXHBV1jwnZZw5rZNNA","token_type":"bearer","expires_in":7200}

Logout

Request	POST
URL	/auth/logout
Header	Authorization: Bearer [Token]

curl --location --request POST 'https://[API-Endpoint]/auth/logout' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvZmludnVlLm5ldFwvcmVzdGFwaVwvYXV0aFwvbG9naW4iLCJpYXQiOjE2Njc5MDk2MzMsImV4cCI6MTY2NzkxMzIzMywibmJmIjoxNjY3OTA5NjMzLCJqdGkiOiJoUXFPYk5manFwNE4wbERLIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIiwiY2xpZW50aWQiOjF9.Bq_ws_4mEM1ZuCNdCOpI-lFy2ZbrN2TUvrZL4z4HpLg'

{
    "message": "Successfully logged out"
}

Reporting

Online-Zahlungen

Request	GET
URL	/reporting/onlinePayments/[datum]
Header	Authorization: Bearer [Token]
Parameter	In der URL wird [datum] als Parameter übergeben. Mögliche Werte: last24h – Letzte 24 Stunden last48h – Letzte 48 Stunden yesterday – Gestern today – Heute YYYY-MM-DD – Spezifisches Datum (z.B. 2022-10-20)

curl --location --request GET 'https://[API-Endpoint]/reporting/onlinePayments/2022-09-02' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvZmludnVlLm5ldFwvcmVzdGFwaVwvYXV0aFwvbG9naW4iLCJpYXQiOjE2Njc5MTA2MzEsImV4cCI6MTY2NzkxNDIzMSwibmJmIjoxNjY3OTEwNjMxLCJqdGkiOiJkSHFuQXo0N1poUEZPT2JiIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIiwiY2xpZW50aWQiOjF9.ZHuFu3XonZO0mJ-dqoTVB33V3Sz_cvY3xzlo3NTKGoo'

[
    {
        "ID": 2024,
        "RefNo": "2020-201079",
        "Subcase": null,
        "DebtorID": "23482394",
        "Timestamp": "2022-09-02T16:39:31.783387",
        "Amount": 429.00,
        "Type": "paypal",
        "Status": "success",
        "ExternalTransactionID": "2394823948"
    }
]

Bemerkungen	Beispielwert	Bemerkungen
ID	2024	finvue-interne ID
RefNo	2020-201079	Aktenzeichen
Subcase	null	Unteraktennummer (bei gesamtschuldnerischen Akten)
DebtorID	23482394	ID des Schuldners
Timestamp	2022-09-02T16:39:31.783387	Zeitpunkt
Amount	429.00	Betrag
Type	paypal	Zahlungsmittel
Status	success	Status der Online-Zahlung (nur relevant, sofern auch andere als erfolgreiche Zahlungen übermittelt werden sollen)
ExternalTransactionID	2394823948	ID der Transaktion bei einem externen Zahlungsanbieter

Ratenpläne

Request	GET
URL	/reporting/instalmentApplications/[datum]
Header	Authorization: Bearer [Token]
Parameter	In der URL wird [datum] als Parameter übergeben. Mögliche Werte: last24h – Letzte 24 Stunden last48h – Letzte 48 Stunden yesterday – Gestern today – Heute YYYY-MM-DD – Spezifisches Datum (z.B. 2022-10-20)

curl --location --request GET 'https://[API-Endpoint]/reporting/instalmentApplications/2022-06-17' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvZmludnVlLm5ldFwvcmVzdGFwaVwvYXV0aFwvbG9naW4iLCJpYXQiOjE2Njc5MTA2MzEsImV4cCI6MTY2NzkxNDIzMSwibmJmIjoxNjY3OTEwNjMxLCJqdGkiOiJkSHFuQXo0N1poUEZPT2JiIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIiwiY2xpZW50aWQiOjF9.ZHuFu3XonZO0mJ-dqoTVB33V3Sz_cvY3xzlo3NTKGoo'

[
    {
        "ID": 3395,
        "RefNo": "2020-201079",
        "Subcase": null,
        "DebtorID": "23482394",
        "Timestamp": "2022-06-17T10:36:15.087335",
        "InstalmentFrom": "2022-06-20",
        "InstalmentAmount": 429.00,
        "Fee": 40.00,
        "Comment": "",
        "Decision": "approved"
    }
]

Feldname	Beispielwert	Bemerkungen
ID	3395	finvue-interne ID
RefNo	2020-201079	Aktenzeichen
Subcase	null	Unteraktennummer (bei gesamtschuldnerischen Akten)
DebtorID	23482394	ID des Schuldners
Timestamp	2022-09-02T16:39:31.783387	Zeitpunkt
InstalmentFrom	2022-06-20	Start des Ratenplans
InstalmentAmount	429.00	Ratenhöhe
Fee	40.00	Gebühr
Comment		Ergänzende Bemerkungen
Decision	approved	Entscheidung im Portal (approved, declined, acknowledged)

SEPA-Einzugsermächtigungen

Request	GET
URL	/reporting/sepaMandatePermissions/[datum]
Header	Authorization: Bearer [Token]
Parameter	In der URL wird [datum] als Parameter übergeben. Mögliche Werte: last24h – Letzte 24 Stunden last48h – Letzte 48 Stunden yesterday – Gestern today – Heute YYYY-MM-DD – Spezifisches Datum (z.B. 2022-10-20)

curl --location --request GET 'https://[API-Endpoint]/reporting/sepaMandatePermissions/all' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvZmludnVlLm5ldFwvcmVzdGFwaVwvYXV0aFwvbG9naW4iLCJpYXQiOjE2Njc5MTA2MzEsImV4cCI6MTY2NzkxNDIzMSwibmJmIjoxNjY3OTEwNjMxLCJqdGkiOiJkSHFuQXo0N1poUEZPT2JiIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIiwiY2xpZW50aWQiOjF9.ZHuFu3XonZO0mJ-dqoTVB33V3Sz_cvY3xzlo3NTKGoo'

[
    {
        "ID": 29,
        "RefNo": "2020-290980",
        "Subcase": null,
        "DebtorID": "12342394",
        "Timestamp": "2022-07-14T09:46:04.439603",
        "IBAN": "AT39 1200 0100 3246 9396",
        "Acknowledged": "false"
    }
]

Feldname	Beispielwert	Bemerkungen
ID	29	finvue-interne ID
RefNo	2020-201080	Aktenzeichen
Subcase	Null	Unteraktennummer (bei gesamtschuldnerischen Akten)
DebtorID	12342394	ID des Schuldners
Timestamp	2022-07-14T09:46:04.439603	Zeitpunkt
IBAN	AT39 1200 0100 3246 9396	IBAN für Bankeinzug
Acknowledged	false	Wurde der Antrag bereits auf „Erledigt“ gestellt

Bestreitungen

Request	GET
URL	/reporting/disputes/[datum]
Header	Authorization: Bearer [Token]
Parameter	In der URL wird [datum] als Parameter übergeben. Mögliche Werte: last24h – Letzte 24 Stunden last48h – Letzte 48 Stunden yesterday – Gestern today – Heute YYYY-MM-DD – Spezifisches Datum (z.B. 2022-10-20)

curl --location --request GET 'https://[API-Endpoint]/reporting/disputes/all' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvZmludnVlLm5ldFwvcmVzdGFwaVwvYXV0aFwvbG9naW4iLCJpYXQiOjE2Njc5MTA2MzEsImV4cCI6MTY2NzkxNDIzMSwibmJmIjoxNjY3OTEwNjMxLCJqdGkiOiJkSHFuQXo0N1poUEZPT2JiIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIiwiY2xpZW50aWQiOjF9.ZHuFu3XonZO0mJ-dqoTVB33V3Sz_cvY3xzlo3NTKGoo'

[
    {
        "ID": 330,
        "RefNo": "2020-290980",
        "Subcase": null,
        "DebtorID": "12342394",
        "Timestamp": "2022-07-14T10:16:34.277699",
        "Reason": "Ich habe eine Warensendung fristgerecht zurückgeschickt.",
        "Comment": "Erste Zeile,\r\nZweite Zeile,\r\n\"Dritte Zeile\"",
        "Decision": null
    }
]

Feldname	Beispielwert	Bemerkungen
ID	330	finvue-interne ID
RefNo	2020-201080	Aktenzeichen
Subcase	null	Unteraktennummer (bei gesamtschuldnerischen Akten)
DebtorID	12342394	ID des Schuldners
Timestamp	2022-07-14T10:16:34.277699	Zeitpunkt
Reason	Ich habe eine Warensendung fristgerecht zurückgeschickt.	Ausgewählter Bestreitungsgrund
Comment	Erste Zeile,\r\nZweite Zeile,\r\n\“Dritte Zeile\““	Ergänzende Bemerkungen
Decision	null	Entscheidung im Portal (approved, rejected, null)

Datenänderungen

Request	GET
URL	/reporting/dataChanges/[datum]
Header	Authorization: Bearer [Token]
Parameter	In der URL wird [datum] als Parameter übergeben. Mögliche Werte: last24h – Letzte 24 Stunden last48h – Letzte 48 Stunden yesterday – Gestern today – Heute YYYY-MM-DD – Spezifisches Datum (z.B. 2022-10-20)

curl --location --request GET 'https://[API-Endpoint]/reporting/dataChanges/2022-07-14' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvZmludnVlLm5ldFwvcmVzdGFwaVwvYXV0aFwvbG9naW4iLCJpYXQiOjE2Njc5MTA2MzEsImV4cCI6MTY2NzkxNDIzMSwibmJmIjoxNjY3OTEwNjMxLCJqdGkiOiJkSHFuQXo0N1poUEZPT2JiIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIiwiY2xpZW50aWQiOjF9.ZHuFu3XonZO0mJ-dqoTVB33V3Sz_cvY3xzlo3NTKGoo'

[
    {
        "ID": 145,
        "RefNo": "2020-290980",
        "Subcase": null,
        "DebtorID": "12342394",
        "Name": "Edlinger",
        "Firstname": "Karl",
        "Street": "Hauptstr. 4/9",
        "PostalCode": "2540",
        "City": "Bad Vöslau",
        "Country": "A",
        "Phone": "067612345671",
        "eMail": "karl.edlinger@email.com",
        "Timestamp": "2022-07-14T10:44:30.05281",
        "Acknowledged": "false"
    }
]

Feldname	Beispielwert	Bemerkungen
ID	145	finvue-interne ID
RefNo	2020-201080	Aktenzeichen
Subcase	null	Unteraktennummer (bei gesamtschuldnerischen Akten)
DebtorID	12342394	ID des Schuldners
Timestamp	2022-07-21T16:34:23.352514	Zeitpunkt
Name	Edlinger	Nachname
Firstname	Karl	Vorname
Street	Hauptstr. 4/9	Straße
PostalCode	2540	Postleitzahl
City	Bad Vöslau	Ort
Country	A	Land
Phone	06761234567	Telefon
eMail	karl.edlinger@email.com	eMail
Timestamp	2022-07-14T10:44:30.05281	Zeitpunkt
Acknowledged	false	Wurde der Antrag bereits auf „Erledigt“ gestellt

Nachrichten

Request	GET
URL	/reporting/messages/[datum]
Header	Authorization: Bearer [Token]
Parameter	In der URL wird [datum] als Parameter übergeben. Mögliche Werte: last24h – Letzte 24 Stunden last48h – Letzte 48 Stunden yesterday – Gestern today – Heute YYYY-MM-DD – Spezifisches Datum (z.B. 2022-10-20)

curl --location --request GET 'https://[API-Endpoint]/reporting/messages/2022-07-21' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvZmludnVlLm5ldFwvcmVzdGFwaVwvYXV0aFwvbG9naW4iLCJpYXQiOjE2Njc5MTA2MzEsImV4cCI6MTY2NzkxNDIzMSwibmJmIjoxNjY3OTEwNjMxLCJqdGkiOiJkSHFuQXo0N1poUEZPT2JiIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIiwiY2xpZW50aWQiOjF9.ZHuFu3XonZO0mJ-dqoTVB33V3Sz_cvY3xzlo3NTKGoo'

[
    {
        "ID": 1550,
        "RefNo": "2020-201079",
        "Subcase": null,
        "DebtorID": "23482394",
        "Timestamp": "2022-07-21T16:34:23.352514",
        "Sender": "Debtor",
        "Message": "Hallo!",
        "Filename": null
    },
    {
        "ID": 1548,
        "RefNo": "2020-201079",
        "Subcase": null,
        "DebtorID": "23482394",
        "Timestamp": "2022-07-21T14:24:24.593933",
        "Sender": "Agency",
        "Message": "Guten Tag!",
        "Filename": null
    }
]

Feldname	Beispielwert	Bemerkungen
ID	1550	finvue-interne ID
RefNo	2020-201079	Aktenzeichen
Subcase	null	Unteraktennummer (bei gesamtschuldnerischen Akten)
DebtorID	23482394	ID des Schuldners
Timestamp	2022-07-21T16:34:23.352514	Zeitpunkt
Sender	Debtor	Absender der Nachricht (Debtor, Agency)
Message	Guten Tag!	Ergänzende Bemerkungen
Filename	foto1234.jpg	Dateiname wenn es sich um eine gesendete Datei handelt, ansonsten null.

Download von Dateien aus Nachrichten

Request	GET
URL	/reporting/messages/retrieveFile/[id]
Header	Authorization: Bearer [Token]
Parameter	In der URL wird [id] als Parameter übergeben. Dabei handelt es sich um die ID einer Nachricht, die eine Datei enthält.

curl --location --request GET 'https://[API-Endpoint]/reporting/messages/retrieveFile/1547' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvZmludnVlLm5ldFwvcmVzdGFwaVwvYXV0aFwvbG9naW4iLCJpYXQiOjE2NzM4NTM0MjQsImV4cCI6MTY3Mzg1NzAyNCwibmJmIjoxNjczODUzNDI0LCJqdGkiOiI5Y1k2dG1IRXpreDlKSVZ0Iiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIiwiY2xpZW50aWQiOjF9.Sv86Mlhh_OkLMFZw-4zpfDcaVZq4khUbsFpmcY-IEPk'

Als Response wird der Inhalt der Datei zurückgegeben.

Datenübermittlung

Forderung übermitteln

Request	POST
URL	/debt/upsert/
Header	Authorization: Bearer [Token] Content-Type: application/json

{ 
    "Client" : { 
        "ID" : "101", 
        "Name" : "Salamander Consumer Bank GmbH2",
        "Street" : "Wagramer Str. 111",
        "PostalCode" : "1220",
        "City" : "Wien",
        "Country" : "A",
        "VATDeductable" : true,
        "InstalmentPolicy" : "",
        "AssignedAgentName" : "",
        "AssignedAgentPhone" : "",
        "AssignedAdgentEMail" : ""
    },
    "Debt": {
        "ClientID" : "101",
        "RefNo" : "2020-201079", 
        "ClientCustomerRefNo" : "19788858",
        "AcceptanceDate" : "2020-01-01",
        "ClosingDate" : null,
        "ExpirationDate" : "2023-10-20",
        "Stage" : "vorgerichtlich",
        "TotalPClaim" : "7800",
        "TotalCost" : "244",
        "TotalInterest" : "1250.27",
        "TotalPayment" : "5000",
        "OutstandingAmount" : "4294.27",
        "CustomInstalmentPlanFee" : "40.00",
        "YearlyInterestRateOnPClaim" : "7.4",
        "PaymentAllocationOrder" : "PIC",
        "Availability" : "locked",
        "AssignedAgentName" : "Heinz Berger",
        "AssignedAgentPhone" : "01/8974244-52",
        "AssignedAgentEmail" : "heinz.berger@abc-inkasso.at",
        "CustomIBAN" : "FL35 3455 4355 3455 554",
        "CustomBIC" : "KBAHZTAGG",
        "CustomBankRecipient" : "Salamander Consumer Bank"
    },
    "Debtors" : [{
        "ID" : "23482394",
        "PersonType" : "1",
        "Subcase" : null,
        "Name" : "Edlinger",
        "Firstname" : "Karl",
        "Birthdate" : "1979-11-20",
        "Street" : "Hauptstr. 4/9",
        "PostalCode" : "2540",
        "City" : "Bad Vöslau",
        "Country" : "A",
        "eMail" : "karl.edlinger@email.com",
        "Phone" : "06761234567"
    }],
    "Transactions" : [
        {
            "ID" : "10000001",
            "Type" : "PClaim",
            "Date" : "2020-09-01",
            "Designation" : "Darlehen",
            "Amount" : "7800.00"
        },
        {
            "ID" : "10000002",
            "Type" : "Cost",
            "Date" : "2020-11-01",
            "Designation" : "Inkassokosten",
            "Amount" : "244.00"
        },
        {
            "ID" : "10000003",
            "Type" : "Interest",
            "Date" : "2020-11-15",
            "Designation" : "Zinsen",
            "Amount" : "1250.27"
        },
        {
            "ID" : "10000004",
            "Type" : "Payment",
            "Date" : "2020-11-15",
            "Designation" : "Zahlung",
            "Amount" : "2500.00"
        },
        {
            "ID" : "10000005",
            "Type" : "Payment",
            "Date" : "2020-11-30",
            "Designation" : "Zahlung",
            "Amount" : "2500.00"
        }
    ]
}

In diesem Beispiel wird eine gesamte Akte inklusive aller Stammdaten von Gläubiger und Schuldner sowie aller Transaktionen übergeben.

Anstelle der Gläubiger-Stammdaten kann, wenn diese bereits angelegt wurden, auch die eindeutige ID des Gläubigers übergeben werden:

{ 
    "Debt": {
        "ClientID" : "101",
        "RefNo" : "2020-201079", 
        "ClientCustomerRefNo" : "19788858",
        "AcceptanceDate" : "2020-01-01",
        "ClosingDate" : null,
        "ExpirationDate" : "2023-10-20",
        "Stage" : "vorgerichtlich",
        "TotalPClaim" : "7800",
        "TotalCost" : "244",
        "TotalInterest" : "1250.27",
        "TotalPayment" : "5000",
        "OutstandingAmount" : "4294.27",
        "CustomInstalmentPlanFee" : "40.00",
        "YearlyInterestRateOnPClaim" : "7.4",
        "PaymentAllocationOrder" : "PIC",
        "Availability" : "locked",
        "AssignedAgentName" : "Heinz Berger",
        "AssignedAgentPhone" : "01/8974244-52",
        "AssignedAgentEmail" : "heinz.berger@abc-inkasso.at",
        "CustomIBAN" : "FL35 3455 4355 3455 554",
        "CustomBIC" : "KBAHZTAGG",
        "CustomBankRecipient" : "Salamander Consumer Bank"
    },
    "Debtors" : [{
        "ID" : "23482394",
        "PersonType" : "1",
        "Subcase" : null,
        "Name" : "Edlinger",
        "Firstname" : "Karl",
        "Birthdate" : "1979-11-20",
        "Street" : "Hauptstr. 4/9",
        "PostalCode" : "2540",
        "City" : "Bad Vöslau",
        "Country" : "A",
        "eMail" : "karl.edlinger@email.com",
        "Phone" : "06761234567"
        }
    ],
    "Transactions" : [
        {
            "ID" : "10000001",
            "Type" : "PClaim",
            "Date" : "2020-09-01",
            "Designation" : "Darlehen",
            "Amount" : "7800.00"
        },
        {
            "ID" : "10000002",
            "Type" : "Cost",
            "Date" : "2020-11-01",
            "Designation" : "Inkassokosten",
            "Amount" : "244.00"
        },
        {
            "ID" : "10000003",
            "Type" : "Interest",
            "Date" : "2020-11-15",
            "Designation" : "Zinsen",
            "Amount" : "1250.27"
        },
        {
            "ID" : "10000004",
            "Type" : "Payment",
            "Date" : "2020-11-15",
            "Designation" : "Zahlung",
            "Amount" : "2500.00"
        },
        {
            "ID" : "10000005",
            "Type" : "Payment",
            "Date" : "2020-11-30",
            "Designation" : "Zahlung",
            "Amount" : "2500.00"
        }
    ]
}

{
    "client": "UPSERTED",
    "debt": "UPSERTED",
    "debtor": "UPSERTED",
    "directUrl": {
        "2020-201079": "https://[Portal-Domain]/XYSDDTZU-V"
    },
    "transaction": "UPSERTED"
}

Verfügbarkeit ändern

Mit diesem Aufruf kann sofort die Verfügbarkeit einer Akte verändert werden. Dadurch sind beispielsweise Löschungen schnell und einfach möglich.

Request	POST
URL	/debt/toggleAvailability/
Header	Authorization: Bearer [Token] Content-Type: application/json
Parameter	Im Body des Requests werden Parameter übergeben: RefNo – Aktenzeichen Availability – Verfügbarkeit (active, deleted, locked, invisible, expired)

{ 
   "RefNo" : "2020-201079",
   "Availability" : "deleted"
}

{
    "RefNo": "2020-201079",
    "Availability": "deleted"
}

Zur Bestätigung werden Aktenzeichen und Verfügbarkeit im Response zurückgemeldet.

Nachricht senden

Request	POST
URL	/debt/sendMessage/
Header	Authorization: Bearer [Token] Content-Type: application/json
Parameter	Im Body des Requests werden Parameter übergeben: RefNo – Aktenzeichen DebtorID – ID des Schuldners SendingUserEMail – eMail-Adresse des Benutzers (in der Administrationsoberfläche), der als Absender eingetragen wird

{ 
   "RefNo" : "2020-201079",
   "DebtorID" : "23482394",
   "SendingUserEMail" : "k.edlinger@abc-inkasso.com",
   "Message" : "Hallo\nZweite Zeile"
}

{
    "message": "SENT",
    "MessageID": "9987"
}

Status eines Ratenantrags aktualisieren

Request	POST
URL	/setStatus/instalmentApplication
Header	Authorization: Bearer [Token] Content-Type: application/json
Parameter	Im Body des Requests werden Parameter übergeben: InstalmentApplicationID – ID des Ratenantrags Decision – Entscheidung/Status – approved – denied – acknowledged (keine Entscheidung, aber erledigt)

{ 
   "InstalmentApplicationID" : "33",
   "Decision" : "approved"
}

{
    "InstalmentApplicationID": "33",
    "Decision": "approved"
}

Bei Erfolg liefert der Response die Daten des Requests zurück.

Status einer SEPA-Einzugsermächtigung aktualisieren

Request	POST
URL	/setStatus/sepaMandatePermission
Header	Authorization: Bearer [Token] Content-Type: application/json
Parameter	Im Body des Requests werden Parameter übergeben: SEPAMandatePermissionID – ID der SEPA-Einzugsermächtigung Status (acknowledged)

{ 
   "SEPAMandatePermissionID" : "7",
   "Status" : "acknowledged"
}

{
    "SEPAMandatePermissionID": "7",
    "Status": "acknowledged"
}

Bei Erfolg liefert der Response die Daten des Requests zurück.

Status einer Bestreitung aktualisieren

Request	POST
URL	/setStatus/dispute
Header	Authorization: Bearer [Token] Content-Type: application/json
Parameter	Im Body des Requests werden Parameter übergeben: DisputeID – ID des Ratenantrags Decision – Entscheidung/Status – approved – rejected – acknowledged (keine Entscheidung, aber erledigt)

{ 
   "DisputeID" : "16",
   "Decision" : "rejected"
}

{
    "DisputeID": "16",
    "Decision": "rejected"
}

Bei Erfolg liefert der Response die Daten des Requests zurück.

Status einer Datenänderung aktualisieren

Request	POST
URL	/setStatus/dataChange
Header	Authorization: Bearer [Token] Content-Type: application/json
Parameter	Im Body des Requests werden Parameter übergeben: DataChangeID – ID der Datenänderung Status (acknowledged)

{ 
   "DataChangeID" : "33",
   "Status" : "acknowledged"
}

{
    "DataChangeID": "33",
    "Status": "acknowledged"
}

Bei Erfolg liefert der Response die Daten des Requests zurück.

Inhalt

Authentifizierung

Login

Logout

Reporting

Online-Zahlungen

Ratenpläne

SEPA-Einzugsermächtigungen

Bestreitungen

Datenänderungen

Nachrichten

Download von Dateien aus Nachrichten

Datenübermittlung

Forderung übermitteln

Verfügbarkeit ändern

Nachricht senden

Status eines Ratenantrags aktualisieren

Status einer SEPA-Einzugsermächtigung aktualisieren

Status einer Bestreitung aktualisieren

Status einer Datenänderung aktualisieren