Herunterladen der Ausgangsrechnungen
Herunterladen der Ausgangsrechnungen: [GET] https://app.erpxt.de/api2/public/invoices
Beschreibung der Struktur, JSON-Antwort:
| Parameter | Beschreibung |
| $id | Sequenznummer innerhalb der JSON-Antwort |
| PaymentStatus | Zahlungsstatus (0 – unbezahlt, 1 – voll bezahlt, 2 – teilweise bezahlt) |
|
PurchasingPartyId
|
ID des Auftragnehmers auf dem Dokument |
|
PaymentTypeId
|
Zahlungsmethode ID |
|
BankAccountId
|
ID Bankkontonummer |
| SalesDate | Verkaufsdatum |
| 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 – Dokument gespeichert / 1 – Dokument bestätigt) |
| Id | Dokument-ID in der Datenbank |
Beispiel für eine JSON-Antwort:
Es ist auch möglich, Daten zu einem bestimmten Verkaufsbeleg herunterzuladen:
[GET] https://app.erpxt.de/api2/public/invoices/XXX (wobei XXX die ID des Verkaufsdokuments in der Datenbank ist)
Beispielanfrage: [GET] https://app.erpxt.de/api2/public/invoices/11
Beispiel für eine JSON-Antwort:
HINWEIS
Die API verarbeitet gespeicherte Ausgangsrechnungen. Darüber hinaus können Sie Daten und Ausdrucke für bereits bestätigte Rechnungen herunterladen. Proformarechnungen, Schlussrechnungen, stornierte Dokumente und Korrekturen werden nicht unterstützt.
HINWEIS
Die API verarbeitet Rechnungen in EUR. Rechnungen in Fremdwährung werden nicht unterstützt.
HINZUFÜGEN EINER NEUEN AUSGANGSRECHNUNG
Hinzufügen einer Ausgangsrechnung: [POST] https://app.erpxt.de/api2/public/invoices
Beschreibung der Struktur, JSON-Antwort:
| Parameter | Beschreibung | Ist der Parameter obligatorisch? |
| PaymentStatus | Zahlungsstatus (0 – unbezahlt, 1 – voll bezahlt)1 | Nein1 |
| PurchasingPartyId | ID des Auftragnehmers auf dem Dokument | Ja |
| PaymentTypeId | Zahlungsmethode ID | Ja |
| BankAccountId | Bankkontonummer ID | Nein |
| SalesDate | Verkaufsdatum im Format JJJJ-MM-TT | Nein2 |
| Items | Dokumentelemente | Nein3 |
| ProductId | Produkt ID | Ja |
| Quantity | Menge | Ja |
|
ProductCurrencyNetPrice
|
Nettoverkaufspreis | Ja |
|
ProductDescription
|
Produktbeschreibung | Nein |
| IssueDate | Ausstellungsdatum des Dokuments im Format JJJJ-MM-TT | Nein2 |
1) Der Zahlungsstatus beim Hinzufügen einer Ausgangsrechnung kann nur den folgenden Wert haben: 0 – unbezahlt oder Wert: 1 – vollständig bezahlt. Status 2 – teilweise bezahlt kann nur auf der Ebene der Comarch ERP XT-Anwendung aufgezeichnet werden. Wenn der Zahlungsstatus nicht markiert ist, wird das Dokument standardmäßig als keine Zahlung markiert (0) angezeigt.
2) Wenn die Parameter kein Datum enthalten, wird das aktuelle Datum eingestellt.
3) Sie können ein Dokument ohne hinzugefügte Elemente ausstellen. Wenn sich der Benutzer jedoch für die Verwendung des Abschnitts „Elemente“ entscheidet, müssen die Pflichtfelder ausgefüllt werden.
Beispiel für eine JSON-Abfrage:
Als Antwort wird die ID der hinzugefügten Ausgangsrechnung gesendet.
Beispielantwort:
HINWEIS
Wenn Sie eine neue Ausgangsrechnung über die API hinzufügen, wird das Dokument gemäß dem in Comarch ERP XT festgelegten Standardnummerierungsschemata nummeriert.
HINWEIS
Ausgangsrechnungen, die über die API zu Comarch ERP XT hinzugefügt wurden, haben immer den Status „Gespeichert“ (im Puffer). Alle weiteren Vorgänge – z. B. Bestätigung und Veröffentlichung von Dokumenten – sollten nach der Anmeldung bei der Anwendung ausgeführt werden.
AUSGANGSRECHNUNG BEARBEITEN
Ausgangsrechnungausgabe: [PUT] https://app.erpxt.de/api2/public/invoices
Beschreibung der Struktur, JSON-Abfrage:
| Parameter | Beschreibung | Ist der Parameter obligatorisch? |
| PaymentStatus | Zahlungsstatus (0 – unbezahlt, 1 – voll bezahlt) | Ja |
| PurchasingPartyId | ID des Auftragnehmers auf dem Dokument | Ja |
| PaymentTypeId | Zahlungsmethode ID | Ja |
| BankAccountId | Bankkontonummer ID | Nein |
| SalesDate | Verkaufsdatum im Format JJJJ-MM-TT | Nein |
| Items | Dokumentposition | 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 im Puffer gespeicherte Rechnungen können über die API bearbeitet werden. Bestätigte Rechnungen können nicht über die API bearbeitet werden.
Die Antwortnachricht erhält den Status und möglicherweise die JSON Antwort.
Beispiel für eine JSON-Abfrage (Änderung der Zahlungsmethode und der Menge der Produkte):
Beispiel für eine JSON-Antwort – Status 204 No Content – Vorgang erfolgreich abgeschlossen:
Beispiel
Entfernen eines Artikels aus einer Ausgangsrechnung durch bearbeiten des Dokuments: [PUT] https://app.erpxt.de/api2/public/invoices
Beispielanfrage:
Beispiel für eine JSON-Antwort – Status 204 No Content – Vorgang erfolgreich abgeschlossen: Folgt in Kürze!
HINWEIS
Die Option zur Bearbeitung der Ausgangsrechnung ist nur für gespeicherte Dokumente verfügbar.
LÖSCHUNG EINER AUSGANGSRECHNUNG
Löschen einer Ausgangsrechnung: [DEL] https://app.erpxt.de/api2/public/invoices/XXX (wobei XXX die ID des Ausgangsrechnung in der Datenbank ist)
Beispielabfrage: [DEL] https://app.erpxt.de/api2/public/invoices/12
Beispiel für eine JSON-Antwort – Status 204 No Content – Vorgang erfolgreich abgeschlossen:
HINWEIS
Die Option zur Bearbeitung der Ausgangsrechnung ist nur für gespeicherte Dokumente verfügbar.
Um herauszufinden, wie ein Ausdruck einer Ausgangsrechnung über die API heruntergeladen werden kann – hier klicken.
