DOWNLOAD VON AUFTRÄGEN
Herunterladen von Aufträgen: [GET] https://app.erpxt.de/api2/public/proformas
| Parameter | Beschreibung |
| $id | Sequenznummer innerhalb der JSON-Antwort |
|
PurchasingPartyId
|
ID Kunde/Lieferant auf dem Dokument |
|
PaymentTypeId
|
Zahlungsform ID |
|
BankAccountId
|
Bankkontonummer ID |
| Items | Dokumentposition |
| $id | Sequenznummer innerhalb der JSON-Antwort |
| ProductId | Produkt ID |
| Quantity | Menge |
| ProductCurrencyNetPrice | Nettoverkaufspreis |
|
ProductDescription
|
Produktbeschreibung |
| Id | ID des Dokumenteintrags in der Datenbank |
| IssueDate | Ausstellungsdatum des Dokuments |
| Number | Dokumentnummer |
| Status | Dokumentstatus: 0 – gespeichert / 1 – bestätigt (konvertiert) |
| Id | Dokument-ID in der Datenbank |
Beschreibung der Antwort-JSON-Struktur:
Es ist auch möglich, Daten zu einem bestimmten Auftrag herunterzuladen:
[GET] https://app.erpxt.de/api2/public/proformas/XXX (wobei XXX die Auftrag-ID in der Datenbank ist)
Beispielabfrage: [GET] https://app.erpxt.de/api2/public/proformas/12
Beispiel für eine JSON-Antwort:
HINZUFÜGEN EINES NEUEN AUFTRAGES
Hinzufügen eines Auftrages: [POST] https://app.erpxt.de/api2/public/proformas
HINWEIS
Aufträge, die über die API zu Comarch ERP XT hinzugefügt wurden, haben immer den Status „Gespeichert“. Alle weiteren Transformationen sollten nach der Anmeldung bei der Anwendung durchgeführt werden.
Beschreibung der JSON-Struktur Abfrage:
| Parameter | Beschreibung | Ist der Parameter obligatorisch? |
| PurchasingPartyId | ID des Kune/Lieferant auf dem Dokument | Ja |
| PaymentTypeId | Zahlungsform ID | Ja |
| BankAccountId | ID Bankkontonummer | Nein |
| Items | Dokumentposition | Nein1 |
| ProductId | Produkt ID | Ja |
| Quantity | Menge | Ja |
|
ProductCurrencyNetPrice
|
Nettoverkaufspreis | Ja |
|
ProductDescription
|
Produktbeschreibung | Nein |
| IssueDate | Ausstellungsdatum des Dokuments im Format JJJJ-MM-TT | Nein2 |
1) Es kann ein Dokument ohne hinzugefügte Elemente ausgestellt werden. Wenn sich der Benutzer jedoch für die Verwendung des Abschnitts „Elemente“ entscheidet, müssen die Pflichtfelder ausgefüllt werden.
2) Wenn die Parameter kein Datum enthalten, wird das aktuelle Datum eingestellt.
Beispiel für eine JSON-Abfrage:
Als Antwort wird die ID des hinzugefügten Auftrages gesendet.
Beispielantwort:
BEARBEITUNG DES AUFTRAGES
Bearbeiten eines Auftrages: [PUT] https://app.erpxt.de/api2/public/proformas
Beschreibung der JSON-Struktur Abfrage:
| Parameter | Beschreibung | Ist der Parameter obligatorisch? |
| PurchasingPartyId | ID des Kunden/Lieferanten auf dem Dokument | Ja |
| PaymentTypeId | Zahlungsform ID | Ja |
| BankAccountId | ID Bankkontonummer | Nein |
| Items | Dokumentpositionen | Ja1 |
| ProductId | Produkt ID | Ja |
| Quantity | Menge | Ja |
|
ProductCurrencyNetPrice
|
Nettoverkaufspreis | Ja |
|
ProductDescription
|
Produktbeschreibung | Nein |
|
Id
|
ID des Dokumenteintrags in der Datenbank | Nein2 |
| IssueDate | Ausstellungsdatum des Dokuments im Format JJJJ-MM-TT | Nein |
| Id | Dokument-ID in der Datenbank | Ja |
1) Wenn die bearbeitete Rechnung Artikel enthält.
2) Wenn die ID-Nummer eines Elements während des Bearbeitungsvorgangs weggelassen wird, wird dem Dokument ein weiteres Element mit den angegebenen Parametern hinzugefügt.
HINWEIS
Wenn optionale Parameter weggelassen werden, werden sie mit Standard- oder Leerwerten überschrieben.
HINWEIS
Nur Rechnungen ohne Transformationen können über die API bearbeitet werden (Status = 0).
Die Antwort erhält den Status und möglicherweise die JSON-Antwort.
Beispiel für eine JSON-Abfrage (Änderung der Zahlungsweise auf einem Auftrag mit Id = 13):
Beispiel für eine JSON-Antwort – Status 204 No Content – Vorgang erfolgreich abgeschlossen:
AUFTRAG LÖSCHUNG
Löschung eines Auftrages: [DEL] https://app.erpxt.de/api2/public/proformas/XXX (wobei XXX die ID des Auftrages in der Datenbank ist)
Beispielabfrage: [DEL] https://app.erpxt.de/api2/public/proformas/14
Beispiel für eine JSON-Antwort – Status 204 No Content – Vorgang erfolgreich abgeschlossen:
HINWEIS
Die Option zum Löschen eines Auftrages ist nur für Dokumente ohne Transformationen verfügbar.
Um zu erfahren, wie einen Ausdruck eines Auftrages über die API heruntergeladen werden kann – hier klicken.
