Inhalt der Dokumentation

Standard-Ressourcen

Unter /api/resource/<Belegtyp> stehen alle Belegtypen zur Verfügung, für die der Benutzer Rechte hat. Der Belegtyp wird mit seinem Namen angegeben, zum Beispiel Customer oder Sales Invoice.

Aufrufe

Methode	Pfad	Wirkung
GET	`/api/resource/<Belegtyp>`	Liste
POST	`/api/resource/<Belegtyp>`	Beleg anlegen
GET	`/api/resource/<Belegtyp>/<Name>`	einen Beleg lesen
PUT	`/api/resource/<Belegtyp>/<Name>`	Felder ändern
DELETE	`/api/resource/<Belegtyp>/<Name>`	Beleg löschen

Gebuchte und stornierte Belege lassen sich nicht löschen. Die Antwort enthält das Ergebnis im Feld data.

Felder, Filter, Sortierung

Parameter	Bedeutung	Beispiel
`fields`	JSON-Liste der gewünschten Felder	`["name","customer_name"]`
`filters`	JSON-Liste von `[Feld, Operator, Wert]`	`[["status","=","Unpaid"]]`
`order_by`	Sortierung	`modified desc`
`limit_start`	Zahl der übersprungenen Zeilen	`0`
`limit_page_length`	Zeilen je Seite	`20`

Operatoren sind =, !=, >, <, >=, <=, like, in, not in, between.

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode 'fields=["name","grand_total"]' \
  --data-urlencode 'filters=[["status","=","Unpaid"]]' \
  --data-urlencode 'order_by=modified desc' \
  --data-urlencode 'limit_page_length=50' \
  "https://ihre-instanz.example.com/api/resource/Sales%20Invoice"

Seitenweiser Abruf

Ohne Angabe liefert die Liste 20 Zeilen. Rufen Sie mit limit_start=0, dann limit_start=50, dann limit_start=100 weiter ab, bis weniger Zeilen als limit_page_length zurückkommen.

Rechte

Die Liste enthält nur Belege, die der Benutzer lesen darf. Fehlt das Recht, antwortet der Server mit Status 403.