Inhalt der Dokumentation

Assistent

Fragen zu Aufträgen und Kunden, Datenqualität und tägliche Vorschläge.

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

ask
confirm_comment
customer_summary
explain_order
get_context
quality_check
abweisen
heute
rueckmeldung

`vm_erp.vm_erp.assistent.api.ask`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Free question about the open document. Returns a proposal, nothing is executed.

Rollen: Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Systemverwalter.

Parameter	Typ	Pflicht
`doctype`	string	ja
`name`	string	ja
`question`	string	ja

Felder der Antwort (message): hinweis, text, vorschlag

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "doctype=<DOCTYPE>" \
  --data-urlencode "name=<NAME>" \
  --data-urlencode "question=<QUESTION>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.assistent.api.ask"

{"message": ...}

`vm_erp.vm_erp.assistent.api.confirm_comment`

GET
POST
Schreibend, rollengeschützt
Fehlernummer bei unerwarteten Fehlern

The only action with write effect: a comment on the document, only after a human confirmed it (the sidebar sends confirmed=1 on the button click).

Rollen: Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

Parameter	Typ	Pflicht
`doctype`	string	ja
`name`	string	ja
`text`	string	ja
`confirmed`	integer	nein, Standard `0`

Felder der Antwort (message): ok

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "doctype=<DOCTYPE>" \
  --data-urlencode "name=<NAME>" \
  --data-urlencode "text=<TEXT>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.assistent.api.confirm_comment"

{"message": ...}

`vm_erp.vm_erp.assistent.api.customer_summary`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Rollen: Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Systemverwalter.

Parameter	Typ	Pflicht	Beschreibung
`customer`	string	ja

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "customer=<CUSTOMER>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.assistent.api.customer_summary"

{"message": ...}

`vm_erp.vm_erp.assistent.api.explain_order`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Rollen: Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Systemverwalter.

Parameter	Typ	Pflicht	Beschreibung
`name`	string	ja

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "name=<NAME>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.assistent.api.explain_order"

{"message": ...}

`vm_erp.vm_erp.assistent.api.get_context`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Rollen: Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Systemverwalter.

Parameter	Typ	Pflicht	Beschreibung
`doctype`	string	ja
`name`	string	ja

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "doctype=<DOCTYPE>" \
  --data-urlencode "name=<NAME>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.assistent.api.get_context"

{"message": ...}

`vm_erp.vm_erp.assistent.api.quality_check`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Rollen: Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Systemverwalter.

Parameter	Typ	Pflicht	Beschreibung
`doctype`	string	nein

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.assistent.api.quality_check"

{"message": ...}

`vm_erp.vm_erp.assistent.vorschlaege_api.abweisen`

GET
POST
Schreibend, rollengeschützt

Rollen: Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

Parameter	Typ	Pflicht	Beschreibung
`vorschlag_id`	string	ja
`grund`	string	ja

Felder der Antwort (message): ok

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "vorschlag_id=<VORSCHLAG_ID>" \
  --data-urlencode "grund=<GRUND>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.assistent.vorschlaege_api.abweisen"

{"message": ...}

`vm_erp.vm_erp.assistent.vorschlaege_api.heute`

GET
POST
Lesend

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

Parameter	Typ	Pflicht	Beschreibung
`abgewiesen`	string	nein

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.assistent.vorschlaege_api.heute"

{"message": ...}

`vm_erp.vm_erp.assistent.vorschlaege_api.rueckmeldung`

GET
POST
Schreibend, rollengeschützt

Rollen: Vertrieb, Vertrieb (Leitung), Lager, Lager (Leitung), Buchhaltung, Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

Parameter	Typ	Pflicht	Beschreibung
`vorschlag_id`	string	ja
`bewertung`	string	ja

Felder der Antwort (message): ok

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "vorschlag_id=<VORSCHLAG_ID>" \
  --data-urlencode "bewertung=<BEWERTUNG>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.assistent.vorschlaege_api.rueckmeldung"

{"message": ...}