| Info |
|---|
Die hier referenzierte PEIQ Ad API (Beta) befindet sich noch im Modus Beta und ist teilweise noch “work in progress” |
Inhaltsverzeichnis
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Anlegen und Ändern von Geschäftspartnern
...
| Note |
|---|
Eine Ausnahme gibt es bei Adressen:
|
Nummernvergabe beim Anlegen
Die Anlage von Geschäftspartnern kann sowohl direkt in PEIQ, als auch durch verschiedene externe Systeme über die AdAPI erfolgen. Da die Geschäftspartnernummer das Merkmal zur eindeutigen Identifizierung ist, wird empfohlen, diese Nummer bei neuen Geschäftspartnern von PEIQ aus einem dort definierten Nummernkreis vergeben zu lassen.
...
Die Daten der Geschäftspartner können dann jeweils mit Hilfe der ID ("number") mittels GET /businesspartners/{number} abgefragt werden.
Abrufen von bekannten Geschäftspartnern
Die Geschäftspartnernummer wird beim Anlegen eines Geschäftspartners über die AdAPI von PEIQ automatisch angelegt und an das externe System übermittelt, sofern sie beim Anlegen nicht im Element "number" definiert wurde, siehe Nummernvergabe beim Anlegen.
...
Die Suche nach Geschäftspartnern erfolgt als GET über folgenden Endpunkt :
...
Parameter - Suchkriterien
...
Detaillierte Informationen zu den gefundenen Geschäftspartnern können über den Endpunkt
...
...
...
abgefragt werden (siehe Absatz “Abrufen von bekannten Geschäftspartnern”).
Bankverbindungen abfragen, anlegen und aktualisieren
Bankverbindungen sind als eigenständige Cluster mit Geschäftspartnern verknüpft.
| Info |
|---|
Der Endpunkt |
Abrufen von Bankdaten(-Nummern) eines Geschäftspartners
Über den Endpunkt GET /businesspartners/{number} kann sich ein externes System die eindeutige Nummer der Bankdaten, welche bereits mit einem Geschäftspartner verknüpft ist, ausgeben lassen:
| Code Block |
|---|
{
"number": 1110002077,
...
}
"account_details": [
{
"number": "204-4996543"
}
]
}
|
Abrufen der Bankverbindung
Bei der Abfrage der Bankverbindung ist die aus dem Endpunkt GET /businesspartners/{number} erhaltene number aus den account_details anzugeben (ID der Bankverbindung). Nun kann sich ein externes System über den Endpunkt GET /accountdetails/{number} die Daten der Bankverbindung des Geschäftspartners abrufen.
Anlage der Bankverbindung
Über den Endpunkt POST /accountdetails können Bankverbindungen neu angelegt werden. Der Rückgabewert des POST ist die ID der Bankverbindung (“account_details” → “number”: “204-4996543”).
Prüfungen bei Neuanlage oder Update
Bei Neuanlage oder Update einer Bankverbindung finden folgende Prüfungen statt:
Ungültige deutsche IBAN → Fehlermeldung “IBAN is not valid”
Gültige deutsche IBAN → BLZ wird aus IBAN ermittelt und die entsprechende Bank aus der Datenbank zugeordnet, keine BIC notwendig
IBAN fehlt bei Neuanlage oder soll bei Update geleert werden → Fehlermeldung
BIC fehlt bei ausländischr IBAN → Fehlermeldung
Ausländische IBAN → wird ohne Prüfung übernommen und Bank (sofern die BIC noch nicht bekannt ist) mit den angegebenen Daten angelegt
Rechnungsmandant fehlt bei Neuanlage oder soll bei Update geleert werden → Fehlermeldung
Aktualisierung der Bankverbindung
Über den Endpunkt PUT /accountdetails/{number} können Bankverbindungen aktualisiert werden.
Bankverbindung zu Geschäftspartner hinzufügen
Um eine neue Bankverbindung zu einem Geschäftspartner hinzuzufügen muss der Rückgabewert des Endpunktes POST /accountdetails via Endpunkt PUT /accountdetails/{number} am Geschäftspartner hinzugefügt werden. Dabei ist es möglich, ausschließlich die accountdetails zum Geschäftspartner zu übermitteln:
| Code Block |
|---|
{
"account_details": [
{
"number": "204-4996543"
},
{
"number": "204-4996770"
},
{
"number": "204-4996780"
}
]
}
|