Inhalt der Dokumentation

Adressen

Adressbericht, Dublettenprüfung und Anlegen von Kunden und Lieferanten.

2 Funktionen. Aufruf unter /api/method/<Pfad>, Anmeldung und Fehlerformat stehen unter Authentifizierung und Fehlermodell.

check_duplicates
create_adresse

`vm_erp.vm_erp.adressen.api.check_duplicates`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Same name + postcode or same e-mail. Returns title and number only.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

Parameter	Typ	Pflicht	Beschreibung
`data`	string	ja

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "data=<DATA>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.adressen.api.check_duplicates"

{"message": ...}

`vm_erp.vm_erp.adressen.api.create_adresse`

POST
Schreibend, rollengeschützt
Fehlernummer bei unerwarteten Fehlern

Create the party/parties. Refuses when a duplicate exists unless force=1 (user confirmed).

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

Parameter	Typ	Pflicht	Beschreibung
`data`	string	ja
`force`	integer	nein, Standard `0`

Felder der Antwort (message): duplicates

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"data": "<DATA>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.adressen.api.create_adresse"

{"message": ...}