System-API: Rechnungen: Unterschied zwischen den Versionen

Aus sourceDESK Wiki
Wechseln zu: Navigation, Suche
(Die Seite wurde neu angelegt: „Der nachfolgend beschriebene API-Endpoint hat die URL <code>/invoice</code>. Zur Verwendung der System-API konsultieren Sie bitte die Grundsätze der System-…“)
 
 
Zeile 1: Zeile 1:
 +
<html>
 +
<div style="border: 1px solid red; padding: 10px; color: red; font-weight: bold;">Diese Dokumentation ist veraltet. Bitte nutzen Sie <a href="https://admin-api.sourcedesk.de" target="_blank">die dedizierte API-Dokumentation</a>.</div>
 +
</html>
 +
 
Der nachfolgend beschriebene API-Endpoint hat die URL <code>/invoice</code>. Zur Verwendung der System-API konsultieren Sie bitte die [[Grundsätze der System-API]].
 
Der nachfolgend beschriebene API-Endpoint hat die URL <code>/invoice</code>. Zur Verwendung der System-API konsultieren Sie bitte die [[Grundsätze der System-API]].
  

Aktuelle Version vom 13. Januar 2019, 17:31 Uhr

Diese Dokumentation ist veraltet. Bitte nutzen Sie die dedizierte API-Dokumentation.

Der nachfolgend beschriebene API-Endpoint hat die URL /invoice. Zur Verwendung der System-API konsultieren Sie bitte die Grundsätze der System-API.

GET (alle Rechnungen)

Erwartete Parameter

Keine

Rückgabe

JSON-Array mit allen Rechnungen und jeweils den folgenden Elementen:

  • ID
  • client
  • date
  • duedate
  • customno
  • status

GET (eine Rechnung)

URL

/invoice/INVOICE_ID

Erwartete Parameter

Keine

Rückgabe

JSON-Array mit allen Daten der Rechnung und den Rechnungspositionen

POST (Rechnung anlegen)

Erwartete Parameter

  • client
  • date (optional, ansonsten aktuelles Datum)
  • duedate (optional, ansonsten Standard)
  • items[]
    • description
    • amount
    • tax = 0|1

Rückgabe

JSON-Array mit Element "id", der ID der neuen Rechnung

PUT (Rechnung bearbeiten)

URL

/invoice/INVOICE_ID

Erwartete Parameter

Es können alle Spalten aus der Tabelle invoices als Key verwendet werden. Als Value ist der gewünschte neue Wert zu übergeben.

Zusätzlich können Rechnungspositionen angelegt/bearbeitet werden:

  • items[]
    • id (nur für Bearbeitung, ID der Rechnungsposition)
    • description
    • amount
    • tax = 0|1

Rückgabe

JSON-Array mit "status" = "ok"