MonKey Office Connect JSON-API Referenz

Version: 18.1.0 / 30.07.21

Changelog

Wichtige Änderungen/Ergänzungen/Fehlerbeseitigungen API Version 18

• Allgemein

  • [18.1.0] Unterstützung cubeSQL-Server 5.7, 5.8
  • [18.0.0] Änderung DB/API Schema auf Version 91

• Firmen

  • [18.0.0] Datentyp FirmaItem alle Angaben zu Kontonummer,BLZ entfallen, Ausgabe von IBAN und BIC

• Adressen

  • [18.1.0] Filterparameter matchcode in adresseList ohne Funktion - korrigiert
  • [18.0.0] Unterstützung RA_Strasse, RA_StrasseNr in adresseList

• Artikel und Leistungen

  • [18.0.0] Fehler Artikelbilder werden in artikelModify gelöscht -- beseitigt

• Verkaufsbelege

  • [18.0.0] Neuer (optionaler) Parameter SepaBankeinzug in VerkaufbelegItem,VerkaufbelegAddItem

• Buchungen

  • [18.1.0] Ausgabe Journalzeilen in Funktion buchungGet

Überblick

MonKey Office Connect (nachfolgend Connect genannt) ermöglicht dir als Entwickler oder Betreiber einer externen Software den Zugriff auf MonKey Office-Funktionen unter Umgehung der MonKey Office-Benutzeroberfläche. Connect kommuniziert dafür direkt mit der MonKey Office-Datenbank auf einem cubeSQL-Server. Der Zugriff über Connect erlaubt die Abfrage von Daten, das Filtern bestimmter Informationen, das Ändern bestehender Datensätze und das Anlegen neuer Datensätze.

Connect verwendet zur Sicherung der Datenbankkonsistenz die gleiche Geschäftslogik wie MonKey Office. Welche Bereiche von MonKey Office über Connect zugänglich sind, ist vordefiniert und wird in der Dokumentation beschrieben. Der Zugriff auf Connect erfolgt über das Übertragungsprotokoll HTTP bzw. HTTPS.

Somit kannst du selbst Anwendungen oder Middleware-Lösungen entwickeln, welche über Connect mit einer MonKey Office-Datenbank interagieren. Dabei lassen sich Daten neu anlegen, ändern oder löschen, ebenso kannst du Daten abfragen, um sie in der anderen Software auszuwerten oder an bestehende Softwaresysteme (z. B. Webanwendungen, mobile Anwendungen, Shop- oder Kassensoftware) weiterzuleiten.

Was ist es nicht

MonKey Office Connect ist keine Anwendung, welche mit wenigen Klicks in bestehende Shopsysteme, Kassensoftware oder Webapplikationen integriert werden kann. ProSaldo liefert also keine fertige Kommunikationslösung für bestimmte externe Tools.

Die konkrete Implementierung einer Schnittstelle zu einem sonstigen System bleibt dem Anwender vorbehalten (bzw. muss extern beauftragt werden). Die Funktionalität von Connect kann vom Anwender nicht erweitert werden. Diesbezügliche Wünsche und Anregungen werden von uns gern entgegengenommen, diskutiert und eventuell in neuere Versionen integriert.

Wie funktioniert das

Ein kleines Beispiel: Du möchtest Adressen für MonKey Office über ein Webformular erfassen und bestehende Adressen ändern. Dazu implementierst du eine kleine Webanwendung, welche z. B. über die von ProSaldo mitgelieferte PHP-Bibliothek auf MonKey Office Connect zugreift.

Die Webanwendung ruft die PHP-Funktion auf, welche eine Liste von Adressen für eine bestimmte Firma aus der MonKey Office-Datenbank abruft. Die PHP-Funktion sendet eine entsprechende Anfrage zu Connect. Dieses prüft die übermittelten Login- und Firmeninformationen der Webanwendung und lädt die angeforderte Adressliste aus der MonKey Office-Datenbank. Anschließend sendet Connect die Adressliste als Ergebnis zur Webanwendung. Diese könnte nun die Adressliste darstellen. In einem nächsten Schritt kann die Webanwendung zu einzelnen Adressen Detailinformationen abrufen, Daten modifizieren, löschen oder hinzufügen.

Einleitung API Referenz

Für den Zugriff muss ein Benutzer mit Passwort in Monkey Office angelegt und mit entsprechenden Zugriffsrechten versehen werden.

Funktionsaufruf erfolgt via http(s)://ipdresse:port/monkeyOfficeConnectJSON. Die Daten werden per POST übertragen. Alle Zugriffe erfolgen zustandsfrei. Es können beliebige Programmiersprachen, welche Kommunikationsmöglichkeiten via HTTP/HTTPS unterstützen, genutzt werden. Für eine vereinfachte Benutzung steht eine PHP-Library für den Zugriff via PHP zur Verfügung. Diese kapselt die eigentliche Kommunikation.

Die meisten Funktionen arbeiten nur mit einem definierten Firma-Key. Dieser wird beim Aufruf der Funktion im HTTP-Header (Bezeichner ist mbl-ident) übermittelt. Informationen zur Verwendung findet man in den mitgelieferten Beispiel-Anwendungen. Der Firma-Key wird über die API-Funktion firmaList im Modul Firmen ermittelt.

Im Allgemeinen ist der Ablauf der Benutzung in allen Modulen gleich. Es stehen Funktionen zum Anlegen, Löschen, Auflisten (optional gefiltert) von Datensätzen zur Verfügung. Zum vereinfachten Anlegen von Datensätzen können Templates abgerufen und mit den gewünschten Daten gefüllt werden. Einige Bereiche besitzen auch Funktionen zum modifizieren von Datensätzen bzw. zur Erzeugung von Vorschauansichten. Stellvertretend sind diese Abläufe im Modul Verkaufsbelege genauer beschrieben. (Siehe zum Beispiel Verkaufsbelege->verkaufbelegAdd).

Mit Hilfe des integrierten Testclient können alle Funktionen simuliert werden. Das ist, gerade für den Einstieg, sehr hilfreich. Der Testclient zeigt die Datenstrukturen für Funktionsaufrufe, und die resultierenden Response-Werte. Bei Problemen kann so der Datenfluss analysiert werden. Bei einigen Funktionen werden auch Testdaten generiert um die Einarbeitung zu vereinfachen.

Um diese Referenz im Browser zu öffnen diese URL verwenden: http://127.0.0.1:8084/jsonhelp

Weiterführende Informationen finden Sie in der Onlinehilfe MonKey_Office Connect

Globale Datenstrukturen

ReturnStatus

Statuscode

StatustextItem

Firmen

Datenstrukturen von Firmen

FirmaItem

FirmaListItem

Funktionsliste von Firmen

firmaList

Listet verfügbare Firmen

Aufruf:

{
  "firmaList":""
}

Rückgabe:

{
  "firmaListResponse": {
    "ReturnData": {
      "FirmaListItem": [ {}, ... ]
    }
  }
}

curl -X "POST" "https://ipdresse:port/monkeyOfficeConnectJSON" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -u 'user:password' \
     -d $'{ "firmaList": "" }'

The above command returns JSON structured like this:

{
  "firmaListResponse": {
    "ReturnData": {
      "FirmaListItem": [
        {
          "Firma_ID": "02406B7F374E1C9F0D8E2A85",
          "Bezeichnung": "ACME",
          "Zusatz": "Inc."
        },
        {
          "Firma_ID": "3D6D193C3E8F27D4E8805B91",
          "Bezeichnung": "FooBarBaz",
          "Zusatz": "GmbH"
        }
      ]
    }
  }
}

firmaGet

Infos zur aktuell selektierten Firma

Aufruf:

{
  "firmaGet":""
}

Rückgabe:

{
  "firmaGetResponse": {
    "ReturnData": {
      "FirmaItem": {...}
    }
  }
}

curl -X "POST" "https://ipdresse:port/monkeyOfficeConnectJSON" \
     -H 'mbl-ident: 02406B7F374E1C9F0D8E2A85' \
     -H 'Content-Type: text/plain; charset=utf-8' \
     -u 'user:password' \
     -d $'{"firmaGet": ""}'

The above command returns JSON structured like this:

{
  "firmaGetResponse": {
    "ReturnData": {
      "FirmaItem": {
        "Firma_Name": "ACME",
        "Firma_Zusatz": "Inc.",
        "Firma_Geschaeftsfuehrer": "Road Runner",
        "Firma_Strasse": "",
        "Firma_Plz": "12345",
        "Firma_Ort": "Musterstadt",
        "Firma_Telefon": "",
        "Firma_Telefax": "",
        "Firma_Email": "info@acme.com",
        "Firma_Internet": "acme.com",
        "Firma_RegisterGericht": "",
        "Firma_RegisterNummer": "",
        "Firma_BankIBAN": "DE75 5121 0800 1245 1261 99",
        "Firma_BankBIC": "JAGUDE31",
        "Firma_BankName": "Geschäftskonto",
        "Firma_UStPflicht": true,
        "Firma_UStIDNummer": "DE111111111",
        "Firma_Kontenplan": "DATEV SKR 04 (EÜ)",
        "Firma_GEArt": 2,
        "Firma_FALand": "Deutschland",
        "Firma_FANummer": "0000",
        "Firma_FAName": "Musterstadt",
        "Firma_FAZusatz": "",
        "Firma_FAStrasse": "Musterstadt Str. 101",
        "Firma_FAPlz": "12345",
        "Firma_FAOrt": "Musterstadt",
        "Firma_FABundesland": "Bremen",
        "Firma_FAStNrPrefix": "00",
        "Firma_FASteuernummer": "00 000 00000",
        "Firma_FAStNrPostfix": "00",
        "Firma_FATelefon": "0000 000-0",
        "Firma_FATelefax": "0000 000-0",
        "Firma_FABankName": "Bundesbank",
        "Firma_FABankIBAN": "",
        "Firma_FABankBIC": "",
        "Firma_FAMemo": "",
        "Firma_SBName": "",
        "Firma_SBZusatz": "",
        "Firma_SBStrasse": "",
        "Firma_SBPlz": "",
        "Firma_SBOrt": "",
        "Firma_SBTelefon": "",
        "Firma_SBTelefax": "",
        "Firma_SBEmail": "",
        "Firma_SBBankName": "",
        "Firma_SBBankIBAN": "",
        "Firma_SBBankBIC": "",
        "Firma_SBMemo": "",
        "Firma_FALandLSt": "Deutschland",
        "Firma_FANummerLSt": "0000",
        "Firma_FANameLSt": "Musterstadt",
        "Firma_FAZusatzLSt": "",
        "Firma_FAStrasseLSt": "Musterstadt Str. 101",
        "Firma_FAPlzLSt": "12345",
        "Firma_FAOrtLSt": "Musterstadt",
        "Firma_FABundeslandLSt": "Bremen",
        "Firma_FAStNrPrefixLSt": "00",
        "Firma_FASteuernummerLSt": "00 000 00000",
        "Firma_FAStNrPostfixLSt": "00",
        "Firma_FATelefonLSt": "0000 000-0",
        "Firma_FATelefaxLSt": "0000 000-0",
        "Firma_FABankNameLSt": "",
        "Firma_FABankIBANLSt": "",
        "Firma_FABankBICLSt": "",
        "Firma_FAMemoLSt": "",
        "Firma_LGName": "",
        "Firma_LGZusatz": "",
        "Firma_LGVerwalter": "",
        "Firma_LGStrasse": "",
        "Firma_LGPlz": "",
        "Firma_LGOrt": "",
        "Firma_LGTelefon": "",
        "Firma_LGTelefax": "",
        "Firma_LGEmail": "",
        "DatumVon": "1970-01-01",
        "DatumBis": "1999-12-31"
      }
    }
  }
}

Die ID der Firma kann über die Funktion firmaList bezogen werden und wird im Header als mbl-ident übergeben.

Vorgaben

Datenstrukturen von Vorgaben

Zahlungsart

Zahlungstatus

Steuergebiet

KostenstelleListItem

NummernkreisListItem

SteuersatzListItem

WaehrungListItem

VerkaufpreislisteListItem

ZahlungsBedingungEinkaufListItem

ZahlungsBedingungVerkaufListItem

NummernkreisIdents

DruckFormularGruppen

DruckFormularFilter

DruckFormularListItem

EtikettTags

FestschreibStatus

Funktionsliste von Vorgaben

kostenstellenList

Liefert definierte Kostenstellen

Aufruf:

{
  "kostenstellenList": ""
}

Rückgabe:

{
  "kostenstellenListResponse": {
    "ReturnData": {
      "KostenstelleListItem": [{}, ...]
    }
  }
}

nummernkreisList

Liefert definierte Nummerkreise

Aufruf:

{
  "nummernkreisList":""
}

Rückgabe:

{
  "nummernkreisListResponse": {
    "ReturnData": {
      "NummernkreisListItem": [ {}, ... ]
    }
  }
}

steuersatzList

Liefert definierte Steuersätze

Aufruf:

{
  "steuersatzList":""
}

Rückgabe:

{
  "steuersatzListResponse": {
    "ReturnData": {
      "SteuersatzListItem": [ {}, ... ]
    }
  }
}

waehrungList

Liefert definierte Währungen

Aufruf:

{
  "waehrungList":""
}

Rückgabe:

{
  "waehrungListResponse": {
    "ReturnData": {
      "WaehrungListItem": [ {}, ... ]
    }
  }
}

preislisteVerkaufList

Liefert definierte VK-Preisliste

Aufruf:

{
  "preislisteVerkaufList":""
}

Rückgabe:

{
  "preislisteVerkaufListResponse": {
    "ReturnData": {
      "VerkaufpreislisteListItem": [ {}, ... ]
    }
  }
}

zahlungsbedingungEinkaufList

Liefert definierte Zahlungsbedingungen Einkauf

Aufruf:

{
  "zahlungsbedingungEinkaufList":""
}

Rückgabe:

{
  "zahlungsbedingungEinkaufListResponse": {
    "ReturnData": {
      "ZahlungsBedingungEinkaufListItem": [ {}, ... ]
    }
  }
}

zahlungsbedingungVerkaufList

Liefert definierte Zahlungsbedingungen Verkauf

Aufruf:

{
  "zahlungsbedingungVerkaufList":""
}

Rückgabe:

{
  "zahlungsbedingungVerkaufListResponse": {
    "ReturnData": {
      "ZahlungsBedingungVerkaufListItem": [ {}, ... ]
    }
  }
}

druckformularFilterTemplate

Liefert Filter für Druckformulare

Aufruf:

{
  "druckformularFilterTemplate":""
}

Rückgabe:

{
  "druckformularFilterTemplateResponse": {
    "ReturnData": {
      "DruckFormularFilter": {...}
    }
  }
}

druckformularList

Liefert definierte Druckformulare

Aufruf:

{
  "druckformularList": {
    "DruckFormularFilter": {} // (optional)
  }
}

Rückgabe:

{
  "druckformularListResponse": {
    "ReturnData": {
      "DruckFormularListItem": [ {}, ... ]
    }
  }
}

Adressen

Datenstrukturen von Adressen

KontaktRolle

KontaktRolleItem

AdresseStatus

AdressePreisAngabe

AdresseItem

AdresseAddItem

AdresseListItem

AdresseKategorieItem

AdresseFilter

AnsprechpartnerListItem

AnsprechpartnerAddItem

AnsprechpartnerItem

BankdatenItem

SepaMandatArt

neu ab Version 17.0

SepaMandatTyp

neu ab Version 17.0

SepaMandatStatus

neu ab Version 17.0

SepaMandatAddItem

neu ab Version 17.0

SepaMandatListItem

neu ab Version 17.0

SepaMandatItem

neu ab Version 17.0

SepaMandatPrintItem

Funktionsliste von Adressen

adresseFilterTemplate

Vorlage für Adressen-Filter

Aufruf:

{
  "adresseFilterTemplate":""
}

Rückgabe:

{
  "adresseFilterTemplateResponse": {
    "ReturnData": {
      "AdresseFilter": {...}
    }
  }
}

curl -X "POST" "http://127.0.0.1:8084/monkeyOfficeConnectJSON" \
     -H 'mbl-ident: 4F01644397CE0566C14498B2' \
     -H 'Content-Type: text/plain; charset=utf-8' \
     -u 'user:password' \
     -d $'{ "adresseFilterTemplate": "" }'

{
  "adresseFilterTemplateResponse": {
    "ReturnData": {
      "AdresseFilter": {
        "Suchtext": "",
        "Matchcode": "",
        "AdresseKategorie": "",
        "LieferantenStatus": "-2",
        "KundenStatus": "-2"
      }
    }
  }
}

adresseList

Liefert alle Adressen als Liste

Aufruf:

{
  "adresseList": {
    "AdresseFilter": {} // (optional)
  }
}

Rückgabe:

{
  "adresseListResponse":
  {
    "ReturnData": {
      "AdresseListItem": [{}, {}, ...]
    }
  }
}

curl -X "POST" "https://ipdresse:port/monkeyOfficeConnectJSON" \
     -H 'mbl-ident: 02406B7F374E1C9F0D8E2A85' \
     -H 'Content-Type: text/plain; charset=utf-8' \
     -u 'user:password' \
     -d $'{
            "adresseList":{
              "AdresseFilter":{
                "Suchtext":"",
                "Matchcode":"",
                "AdresseKategorie":"",
                "LieferantenStatus":"-2",
                "KundenStatus":"-2"
              }
            }
          }'

{
  "adresseListResponse": {
    "ReturnData": {
      "AdresseListItem": [
        {
          "Adresse_ID": "480C644B85E2297DB23598B243130C",
          "Matchcode": "LIEFERANT",
          "AdressNr": "ADR-00001",
          "Kategorie": "",
          "KundenStatus": 0,
          "LieferantenStatus": 1,
          "RA_Firma1": "Lieferant",
          "RA_Vorname": "",
          "RA_Nachname": "",
          "RA_Plz": "",
          "RA_Ort": "",
          "RA_Strasse": "",
          "RA_StrasseNr": ""
        },
        {
          "Adresse_ID": "480C644B85E2297DB23598B147130C",
          "Matchcode": "KUNDE",
          "AdressNr": "ADR-IT-00002",
          "Kategorie": "",
          "KundenStatus": 1,
          "LieferantenStatus": 0,
          "RA_Firma1": "Kunde",
          "RA_Vorname": "",
          "RA_Nachname": "",
          "RA_Plz": "",
          "RA_Ort": "",
          "RA_Strasse": "",
          "RA_StrasseNr": ""
        }
      ]
    }
  }
}

adresseGet

Liefert Details einer Adresse

Aufruf:

{
  "adresseGet": {
    "Adresse_ID": "..."     // string
  }
}

Rückgabe:

{
  "adresseGetResponse": {
    "ReturnData": {
      "AdresseItem": {...}
    }
  }
}

adresseAdd

Fügt eine Adresse hinzu

Aufruf:

{
  "adresseAdd": {
    "AdresseAddItem": {}
  }
}

Rückgabe:

{
  "adresseAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseModify

Modifiziert vorhandene Adresse

Ablauf:

1. Struktur AdresseItem über adresseGet abrufen.Es wird ein gültiger VersionKey geliefert.
2. Daten von AdresseItem bei Bedarf anpassen.
3. Funktion adresseModify ausführen.

Es wird ein Status über Erfolg/Fehler der Operation zurückgeliefert. Hinweis: Es sind nicht alle Daten von AdresseItem modifizierbar. Es sollten nur die Parameter übergeben werden, welche auch geändert werden sollen. Alle anderen sollten aus AdresseItem entfernt werden.

Beispielaufruf:
Änderung des Vornamens (Adresse_ID, VersionKey beispielhaft)

{
 "adresseModify": {
    "AdresseItem": {
     "Adresse_ID":"481A62479DF4207DB23598B6461308",
     "VersionKey":"99276D86013D6FE47EFB22572D96B63624",
     "RA_Vorname":"Paul"
   }
  }
}

Rückgabe:

{
  "adresseModifyResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseDelete

Löscht vorhandene Adresse

Aufruf:

{
  "adresseDelete": {
    "Adresse_ID": "..."
  }
}

Rückgabe:

{
  "adresseDeleteResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseTemplate

Liefert AdresseAddItem als Vorlage

Aufruf:

{
  "adresseTemplate":""
}

Rückgabe:

{
  "adresseTemplateResponse": {
    "ReturnData": {
      "AdresseAddItem": {...}
    }
  }
}

adresseKategorieList

Ermittelt alle Adress-Kategorien

Aufruf:

{
  "adresseKategorieList":""
}

Rückgabe:

{
  "adresseKategorieListResponse": {
    "ReturnData": {
      "AdresseKategorieItem": [
        {},
        {},
        ...
      ]
    }
  }
}

adresseAddAttachment

Fügt ein Attachment einer Adresse hinzu

Aufruf:

{
  "adresseAddAttachment": {
    "Adresse_ID": "..." ,   // string
    "AttachmentAddItem":  ...
  }
}

Rückgabe:

{
  "adresseAddAttachmentResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseAnsprechpartnerTemplate

Liefert AnsprechpartnerAddItem als Vorlage

Aufruf:

{
  "adresseAnsprechpartnerTemplate": {
    "Adresse_ID": "..."     // string (optional)
  }
}

Rückgabe:

{
  "adresseAnsprechpartnerTemplateResponse": {
    "ReturnData": {
      "AnsprechpartnerAddItem": {...}
    }
  }
}

adresseAnsprechpartnerList

Liefert alle Ansprechpartner einer Adresse

Aufruf:

{
  "adresseAnsprechpartnerList": {
    "Adresse_ID": "..."     // string
  }
}

Rückgabe:

{
  "adresseAnsprechpartnerListResponse": {
    "ReturnData": {
      "AnsprechpartnerListItem": [ {}, ... ]
    }
  }
}

adresseAnsprechpartnerAdd

Fügt Ansprechpartner zu Adresse hinzu

Aufruf:

{
  "adresseAnsprechpartnerAdd": {
    "AnsprechpartnerAddItem": {}
  }
}

Rückgabe:

{
  "adresseAnsprechpartnerAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseAnsprechpartnerGet

Liefert Details eines einzelnen Ansprechpartner

Aufruf:

{
  "adresseAnsprechpartnerGet": {
    "Ansprechpartner_ID": "..."     // string
  }
}

Rückgabe:

{
  "adresseAnsprechpartnerGetResponse": {
    "ReturnData": {
      "AnsprechpartnerItem": {...}
    }
  }
}

adresseAnsprechpartnerModify

Modifiziert vorhandenen Ansprechpartner

Ablauf:

1. Struktur AnsprechpartnerItem über adresseAnsprechpartnerGet abrufen. Es wird ein gültiger VersionKey geliefert.
2. Daten von AnsprechpartnerItem bei Bedarf anpassen.
3. Funktion adresseAnsprechpartnerModify ausführen.

Es wird ein Status über Erfolg/Fehler der Operation zurückgeliefert. Hinweis: Es sind nicht alle Daten von AnsprechpartnerItem modifizierbar. Es sollten nur die Parameter übergeben werden, welche auch geändert werden sollen. Alle anderen sollten aus AnsprechpartnerItem entfernt werden.

Beispielaufruf:
Änderung des Nachnamens (Adresse_ID, Ansprechpartner_ID, VersionKey beispielhaft)

{
 "adresseAnsprechpartnerModify": {
    "AnsprechpartnerItem": {
     "Adresse_ID": "480C644B85E2297DB23598B04C18",
     "Ansprechpartner_ID": "4806655E84F42F4A8B10D0F3184C4BC98F057A8BEFAE",
     "VersionKey": "067EF8D83D7912D08D53C8CDD06A7E0D73",
     "Nachname": "Mustermann"
   }
  }
}

Rückgabe:

{
  "adresseAnsprechpartnerModifyResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseAnsprechpartnerDelete

Löscht eine Ansprechpartner

Aufruf:

{
  "adresseAnsprechpartnerDelete": {
    "Ansprechpartner_ID": "..."
  }
}

Rückgabe:

{
  "adresseAnsprechpartnerDeleteResponse":
  {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseSepaMandatList

Auflistung angelegter SEPA-Mandate für Adresse

Aufruf:

{
  "adresseSepaMandatList": {
    "Adresse_ID": "..."     // string
  }
}

Rückgabe:

{
  "adresseSepaMandatListResponse": {
    "ReturnData": {
      "SepaMandatListItem": [ {}, ... ]
    }
  }
}

adresseSepaMandatTemplate

Vorlage für neues SEPA-Mandat

Aufruf:

{
  "adresseSepaMandatTemplate": {
    "Adresse_ID": "..."     // string (optional)
  }
}

Rückgabe:

{
  "adresseSepaMandatTemplateResponse": {
    "ReturnData": {
      "SepaMandatAddItem": {...}
    }
  }
}

adresseSepaMandatAdd

Anlegen eines SEPA-Mandat für Adresse

Aufruf:

{
  "adresseSepaMandatAdd": {
    "SepaMandatAddItem": {}
  }
}

Rückgabe:

{
  "adresseSepaMandatAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseSepaMandatGet

Liefert Details eines vorhandenen SEPA-Mandat

Aufruf:

{
  "adresseSepaMandatGet": {
    "SepaMandat_ID": "..."  // string
  }
}

Rückgabe:

{
  "adresseSepaMandatGetResponse": {
    "ReturnData": {
      "SepaMandatItem": {...}
    }
  }
}

adresseSepaMandatModify

Modifiziert vorhandenes SEPA-Mandat

Aufruf:

{
  "adresseSepaMandatModify": {
    "SepaMandatItem": {}
  }
}

Rückgabe:

{
  "adresseSepaMandatModifyResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseSepaMandatDelete

Löscht vorhandenes SEPA-Mandat

Aufruf:

{
  "adresseSepaMandatDelete": {
    "SepaMandat_ID": "..."  // string
  }
}

Rückgabe:

{
  "adresseSepaMandatDeleteResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

adresseSepaMandatPrintPDF

Gibt SEPA-Mandat als PDF aus

Aufruf:

{
  "adresseSepaMandatPrintPDF":
  {
    "SepaMandat_ID": "..." ,    // string
    "DruckformularName": "..."  // string
  }
}

Rückgabe:

{
  "adresseSepaMandatPrintPDFResponse": {
    "ReturnData": {
      "SepaMandatPrintItem": {...}
    }
  }
}

Artikel und Leistungen

Datenstrukturen von Artikel und Leistungen

StueckListeTyp

Artikelkalkaufwand

Artikelkalkbasis

Artikelkalkmarge

Artikelpreis

Artikelart

Artikelstatus

Warengruppeart

WarengruppeListItem

WarengruppeItem

WarengruppeAddItem

ArtikelFilter

ArtikelListItem

ArtikelItem

ArtikelAddltem

ArtikelAddPosten

ArtikelBildItem

ArtikelBildAddlItem

Funktionsliste von Artikel und Leistungen

warengruppeTemplate

liefert WarengruppeAddItem als Vorlage

Aufruf:

{
  "warengruppeTemplate":""
}

Rückgabe:

{
  "warengruppeTemplateResponse": {
    "ReturnData": {
      "WarengruppeAddItem": {...}
    }
  }
}

warengruppeList

Auflistung Warengruppen

Aufruf:

{
  "warengruppeList":""
}

Rückgabe:

{
  "warengruppeListResponse": {
    "ReturnData": {
      "WarengruppeListItem": [ {}, ... ]
    }
  }
}

warengruppeGet

Liefert Details einer Warengruppe

Aufruf:

{
  "warengruppeGet": {
    "Warengruppe_ID": "..."     // string
  }
}

Rückgabe:

{
  "warengruppeGetResponse": {
    "ReturnData": {
      "WarengruppeItem": {...}
    }
  }
}

warengruppeAdd

fügt eine Warengruppe hinzu

Aufruf:

{
  "warengruppeAdd": {
    "WarengruppeAddItem":  ...
  }
}

Rückgabe:

{
  "warengruppeAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

warengruppeDelete

löscht eine vorhandene Warengruppe

Aufruf:

{
  "warengruppeDelete": {
    "Warengruppe_ID": "..."     // string
  }
}

Rückgabe:

{
  "warengruppeDeleteResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

artikelTemplate

liefert ArtikelAddltem als Vorlage

Aufruf:

{
  "artikelTemplate":""
}

Rückgabe:

{
  "artikelTemplateResponse": {
    "ReturnData": {
      "ArtikelAddltem": {...}
    }
  }
}

artikelList

Auflistung Artikel

Aufruf:

{
  "artikelList": {
    "ArtikelFilter":  ...   // (optional)
  }
}

Rückgabe:

{
  "artikelListResponse": {
    "ReturnData": {
      "ArtikelListItem": [ {}, ... ]
    }
  }
}

artikelGet

Liefert Details eines Artikel/Leistung

Aufruf:

{
  "artikelGet": {
    "Artikel_ID": "..."     // string
  }
}

Rückgabe:

{
  "artikelGetResponse": {
    "ReturnData": {
      "ArtikelItem": {...}
    }
  }
}

artikelAdd

fügt einen Artikel/Leistung hinzu

Aufruf:

{
  "artikelAdd": {
    "ArtikelAddltem":  ...
  }
}

Rückgabe:

{
  "artikelAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

artikelDelete

löscht einen vorhandene Artikel/Leistung

Aufruf:

{
  "artikelDelete": {
    "Artikel_ID": "..."     // string
  }
}

Rückgabe:

{
  "artikelDeleteResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

artikelModify

ändert einen vorhandenen Artikel/Leistung

Ablauf:

1. Struktur ArtikelItem über artikelGet abrufen.Es wird ein gültiger VersionKey geliefert.
2. Daten von ArtikelItem bei Bedarf anpassen.
3. Funktion artikelModify ausführen.

Es wird ein Status über Erfolg/Fehler der Operation zurückgeliefert. Hinweis: Es sind nicht alle Daten von ArtikelItem modifizierbar.

Wichtig Es sollten nur die Parameter übergeben werden, welche auch geändert werden sollen. Alle anderen sollten aus ArtikelItem entfernt werden.

Beispielaufruf Änderung Artikelbezeichnung (Artikel_ID, VersionKey beispielhaft)

{
 "artikelModify":{
    "ArtikelItem":{
     "Artikel_ID":"481A62479DF4207DB23598B6461308",
     "VersionKey":"99276D86013D6FE47EFB22572D96B63624",
     "Bezeichnung":"Hammerstiel holz"
   }
  }
}

Aufruf:

{
  "artikelModify": {
    "ArtikelItem":  ...
  }
}

Rückgabe:

{
  "artikelModifyResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

artikelFilterTemplate

Vorlage für Filter Artikel/Leistungen

Aufruf:

{
  "artikelFilterTemplate":""
}

Rückgabe:

{
  "artikelFilterTemplateResponse": {
    "ReturnData": {
      "ArtikelFilter": {...}
    }
  }
}

artikelAddAttachment

fügt ein Attachment einem Artikel hinzu

Aufruf:

{
  "artikelAddAttachment": {
    "Artikel_ID": "..." ,   // string
    "AttachmentAddItem":  ...
  }
}

Rückgabe:

{
  "artikelAddAttachmentResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

artikelBildGet

Abrufen eines Artikelbildes

Artikelbilder werden durch ihre Position in der Bildliste des Artikels addressiert. Dabei hat das erste Bild die Bildposition=1,das zweite die Bildposition=2 usw. Das Bild wird als Base64-codierter Datensatz geliefert, in dem im Bildformat definierten Format.

Hinweis: Artikelbilder sind in erster Linie für die Druckausgabe in Einkauf/Verkaufsbelegen vorgesehen. Für eine universellere Verknüpfung von Artikeln mit weiteren Daten sollten Attachments verwendet werden.

Aufruf:

{
  "artikelBildGet": {
    "Artikel_ID": "..." ,   // string
    "Bildposition":  ...    // integer
  }
}

Rückgabe:

{
  "artikelBildGetResponse": {
    "ReturnData": {
      "ArtikelBildItem": {...}
    }
  }
}

artikelBildTemplate

Abrufen einer Datenstruktur ArtikelBildAddlItem

Aufruf:

{
  "artikelBildTemplate":""
}

Rückgabe:

{
  "artikelBildTemplateResponse": {
    "ReturnData": {
      "ArtikelBildAddlItem": {...}
    }
  }
}

artikelBildAdd

fügt ein Artikelbild hinzu

Ablauf:

1. Den Zielartikel über den Parameter Artikel_ID festlegen.
2. Eine Struktur Datenstruktur ArtikelBildAddlItem über artikelBildTemplate abrufen mit folgenden Daten füllen:
   1. Den Namen des Artikebildes in Name festlegen. Dieser muss innerhalb des Artikels eindeutig sein.
   2. Die Einfügeposition über Bildposition festlegen. Dabei wird bei Wert 0 das Bild an die Bildliste des Artikels angehängt, ansonsten das Bild an der Position eingefügt.
   3. Die eigentlichen Bilddaten Base64-codiert in DatenBASE64 setzen. Unterstützt werden die gängien Bildformate.
   4. Eventuelle Notizen können in Notizen gesetzt werden.
3. Funktion artikelBildAdd ausführen.

Es wird dem Artikel das Bild zugeordnet. Bei Erfolg wird der Statuscode = 0 geliefert. Bei einem Fehler wird Statuscode <> 0 und weitere Infos zum aufgetretenen Fehler geliefert.

Hinweis: Weitere Infos zu Artikelbilder finden sie in der Hilfe zur Funktion artikelBildGet. Sie können sich mit Hilfe des Testclient mit den Funktionen vertraut machen. Dort werden Testdaten einem auszuwählenden Artikel zugeordnet.

Aufruf:

{
  "artikelBildAdd": {
    "Artikel_ID": "..." ,   // string
    "ArtikelBildAddlItem":  ...
  }
}

Rückgabe:

{
  "artikelBildAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

Lager

Datenstrukturen von Lager

LagerjournalVorgang

LagerjournalFilter

LagerjournalItem

Funktionsliste von Lager

lagerartikelList

Listet alle Lagerartikel

Aufruf:

{
  "lagerartikelList":""
}

Rückgabe:

{
  "lagerartikelListResponse": {
    "ReturnData": {
      "ArtikelListItem": [ {}, ... ]
    }
  }
}

lagerjournalFilterTemplate

Vorlage für Lagerjournal-Filter

Aufruf:

{
  "lagerjournalFilterTemplate":""
}

Rückgabe:

{
  "lagerjournalFilterTemplateResponse": {
    "ReturnData": {
      "LagerjournalFilter": {...}
    }
  }
}

lagerjournalList

Liefert Lagerjournal(mit filter)

Aufruf:

{
  "lagerjournalList": {
    "LagerjournalFilter": {}    // (optional)
  }
}

Rückgabe:

{
  "lagerjournalListResponse": {
    "ReturnData": {
      "LagerjournalArtikelItem": [ {}, ... ]
    }
  }
}

lagerjournalGet

Liefert Lagerjournal für Artikel (mit ID)

Aufruf:

{
  "lagerjournalGet": {
    "Artikel_ID": "...",    // string
    "NurLetzeBewegung":  ...    // boolean (optional)
  }
}

Rückgabe:

{
  "lagerjournalGetResponse": {
    "ReturnData": {
      "LagerjournalItem": {...}
    }
  }
}

Verkaufsbelege

Datenstrukturen von Verkaufsbelege

VerkaufbelegArt

VerkaufbelegStatus

VerkaufbelegDruckstatus

VerkaufBelegKalkbasis

VerkaufbelegPositionArt

VerkaufbelegFilter

VerkaufbelegListitem

VerkaufbelegItem

VerkaufbelegPositionItem

VerkaufbelegAddItem

VerkaufbelegPositionAddItem

VerkaufbelegPrintItem

Funktionsliste von Verkaufsbelege

verkaufbelegFilterTemplate

Vorlage für Verkaufbeleg-Filter

Dient zur Steuerung von verkaufbelegList.

Aufruf:

{
  "verkaufbelegFilterTemplate":""
}

Rückgabe:

{
  "verkaufbelegFilterTemplateResponse": {
    "ReturnData": {
      "VerkaufbelegFilter": {...}
    }
  }
}

verkaufbelegList

Auflistung Verkaufbelege

Über einen optionalen Filter kann die Ausgabe von verkaufbelegList gesteuert werden. Ablauf:

1. Datenstruktur VerkaufbelegFilter über verkaufbelegFilterTemplate generieren.
2. Daten von VerkaufbelegFilter anpassen.
3. Funktion verkaufbelegList ausführen.

Ergebnis ist eine Liste der vorhandenen Verkaufbelege. Ohne Filterübergabe wird ein Filter mit den Standardwerten verwendet. Als Datumsbereich gilt dann i.d.R. das aktuelle Geschäftsjahr.

Aufruf:

{
  "verkaufbelegList": {
    "VerkaufbelegFilter":  ...  // (optional)
  }
}

Rückgabe:

{
  "verkaufbelegListResponse": {
    "ReturnData": {
      "VerkaufbelegListitem": [ {}, ... ]
    }
  }
}

verkaufbelegGet

Liefert Details eines Verkaufbeleg

Es können Details zu einem Verkaufbeleg abgerufen werden. Der Beleg wird durch Verkaufbeleg_ID adressiert. Diese kann durch verkaufbelegList ermittelt werden.

Aufruf:

{
  "verkaufbelegGet": {
    "Verkaufbeleg_ID": "..."    // string
  }
}

Rückgabe:

{
  "verkaufbelegGetResponse": {
    "ReturnData": {
      "VerkaufbelegItem": {...}
    }
  }
}

verkaufbelegTemplate

liefert VerkaufbelegAddItem als Vorlage

Es wird einen Datenstruktur VerkaufbelegAddItem erzeugt. Entsprechend der übergebenen Parameter wird die Datenstruktur vorbelegt. Diese Datenstruktur wird für verkaufbelegAdd,verkaufbelegPreview verwendet. Zur Ermittelung des Positionspreises wird die Preisliste, welche der Adresse hinterlegt ist, verwendet. Optional kann diese durch VKPreisliste_ID überschrieben werden. Weitere Hinweise zur Verwendung in diesen Funktionen.

Aufruf:

{
  "verkaufbelegTemplate": {
    "VerkaufbelegArt":  ... ,   // integer (optional)
    "Adresse_ID": "..." ,   // string (optional)
    "VKPreisliste_ID": "..." ,  // string (optional)
    "ArtikelAddPostenList": {
      "ArtikelAddPosten": [ {}, ... ]
    }
  }
}

Rückgabe:

{
  "verkaufbelegTemplateResponse": {
    "ReturnData": {
      "VerkaufbelegAddItem": {...}
    }
  }
}

verkaufbelegDuplikatTemplate

Vorlage für einen duplizierten Verkaufbeleg

Es wird einen Datenstruktur VerkaufbelegAddItem erzeugt. Entsprechend der übergebenen Parameter wird die Datenstruktur vorbelegt. Diese Datenstruktur wird für verkaufbelegAdd,verkaufbelegPreview verwendet. Weitere Hinweise zur Verwendung in diesen Funktionen.

Aufruf:

{
  "verkaufbelegDuplikatTemplate": {
    "Verkaufbeleg_ID": "..." ,  // string
    "Adresse_ID": "..."     // string (optional)
  }
}

Rückgabe:

{
  "verkaufbelegDuplikatTemplateResponse": {
    "ReturnData": {
      "VerkaufbelegAddItem": {...}
    }
  }
}

verkaufbelegWeiterleitungTemplate

Vorlage für einen weitergeleiteten Verkaufbeleg

Es wird einen Datenstruktur VerkaufbelegAddItem erzeugt. Entsprechend der übergebenen Parameter wird die Datenstruktur vorbelegt. Diese Datenstruktur wird für verkaufbelegWeiterleitung,verkaufbelegPreview verwendet. Weitere Hinweise zur Verwendung in diesen Funktionen.

Aufruf:

{
  "verkaufbelegWeiterleitungTemplate": {
    "Verkaufbeleg_ID": "..." ,  // string
    "VerkaufbelegArt":  ...     // integer
  }
}

Rückgabe:

{
  "verkaufbelegWeiterleitungTemplateResponse": {
    "ReturnData": {
      "VerkaufbelegAddItem": {...}
    }
  }
}

verkaufbelegPositionTemplate

liefert VerkaufbelegPositionAddItem als Vorlage

Es wird einen Datenstruktur VerkaufbelegPositionAddItem erzeugt. Entsprechend der übergebenen Parameter wird die Datenstruktur vorbelegt. Diese Datenstruktur kann zur Ergänzung von VerkaufbelegAddItem verwendet werden. Zur Ermittelung des Positionspreises wird die Preisliste, welche der Adresse hinterlegt ist, verwendet. Optional kann diese durch VKPreisliste_ID überschrieben werden. Weitere Hinweise zur Verwendung in diesen Funktionen.

Aufruf:

{
  "verkaufbelegPositionTemplate": {
    "Artikel_ID": "..." ,   // string (optional)
    "Adresse_ID": "..." ,   // string (optional)
    "VKPreisliste_ID": "..." ,  // string (optional)
    "Artikelmenge":  ...    // integer (optional)
  }
}

Rückgabe:

{
  "verkaufbelegPositionTemplateResponse": {
    "ReturnData": {
      "VerkaufbelegPositionAddItem": {...}
    }
  }
}

verkaufbelegPreview

berechnet einen Verkaufbeleg ohne ihn zu sichern

Diese Funktion wird für interaktive Clients verwendet um eine Voransicht eines anzulegenden Belegs zu erzeugen. Ablauf:

1. Datenstruktur VerkaufbelegAddItem über verkaufbelegTemplate, verkaufbelegDuplikatTemplate oder verkaufbelegWeiterleitungTemplate generieren.
2. Daten von VerkaufbelegAddItem bei Bedarf anpassen.
3. Funktion verkaufbelegPreview ausführen.

Ergebnis ist eine Datenstruktur VerkaufbelegItem welche einem angelegten Verkaufbeleg entspricht.

Aufruf:

{
  "verkaufbelegPreview": {
    "VerkaufbelegAddItem":  ...
  }
}

Rückgabe:

{
  "verkaufbelegPreviewResponse": {
    "ReturnData": {
      "VerkaufbelegItem": {...}
    }
  }
}

verkaufbelegAdd

fügt einen neuen Verkaufbeleg hinzu

Ablauf:

1. Datenstruktur VerkaufbelegAddItem über verkaufbelegTemplate oder verkaufbelegDuplikatTemplate generieren.
2. Daten von VerkaufbelegAddItem anpassen.
3. Funktion verkaufbelegAdd ausführen.

Es wird ein Verkaufbeleg angelegt. Bei Erfolg werden Statuscode=0 und eine Insert_ID zurückgeliefert. Ein Fehler liefert Statuscode <> 0 und Infos zum aufgetretenen Problem.

Aufruf:

{
  "verkaufbelegAdd": {
    "VerkaufbelegAddItem":  ...
  }
}

Rückgabe:

{
  "verkaufbelegAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

verkaufbelegWeiterleitung

fügt einen Verkaufbeleg als Weiterleitung hinzu

Ablauf:

1. Datenstruktur VerkaufbelegAddItem über verkaufbelegWeiterleitungTemplate generieren.
2. Daten von VerkaufbelegAddItem bei Bedarf anpassen (VerkaufVorbeleg_ID darf nicht geändert werden).
3. Funktion verkaufbelegWeiterleitung ausführen.

Es wird ein Verkaufbeleg angelegt. Bei Erfolg werden Statuscode=0 und eine Insert_ID zurückgeliefert. Bei einem Fehler wird Statuscode <> 0 und weitere Infos zum aufgetretenen Fehler geliefert.

Aufruf:

{
  "verkaufbelegWeiterleitung": {
    "VerkaufbelegAddItem":  ...
  }
}

Rückgabe:

{
  "verkaufbelegWeiterleitungResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

verkaufbelegDelete

löscht einen Verkaufbeleg

Es wird ein Verkaufbeleg gelöscht. Der Beleg wird durch Verkaufbeleg_ID adressiert. Diese kann durch verkaufbelegList ermittelt werden.

Aufruf:

{
  "verkaufbelegDelete": {
    "Verkaufbeleg_ID": "..."    // string
  }
}

Rückgabe:

{
  "verkaufbelegDeleteResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

verkaufbelegAddAttachment

fügt ein Attachment einem Verkaufbeleg hinzu

An den Verkaufbeleg wird ein Dokument oder Link als Attachment angefügt.

Ablauf:

1. Den Beleg durch Verkaufbeleg_ID festlegen.
2. Datenstruktur AttachmentAddItem mit Daten füllen. Es kann entweder DatenBASE64 oder Link gesetzt werden. Die Dokument-Daten DatenBASE64 müssen als Base64 codiert übergeben werden.
3. Funktion verkaufbelegAddAttachment ausführen.

Bei Erfolg werden Statuscode=0 und eine Insert_ID vom Typ Attachment_ID zurückgeliefert. Bei einem Fehler wird Statuscode <> 0 und weitere Infos zum aufgetretenen Fehler geliefert. Die Verwaltung der Attachments erfolgt im Modul Attachment-Verwaltung.

Aufruf:

{
  "verkaufbelegAddAttachment": {
    "Verkaufbeleg_ID": "..." ,  // string
    "AttachmentAddItem":  ...
  }
}

Rückgabe:

{
  "verkaufbelegAddAttachmentResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

verkaufbelegPrintPDF

liefert einen Verkaufbeleg als PDF

Für einen Verkaufbeleg wird ein PDF generiert. Ablauf:

1. Den Beleg durch Verkaufbeleg_ID festlegen.
2. Über DruckformularName das gewünschte Druckformular festlegen.
3. Festlegen ob der Beleg nach erfolgreicher PDF-Ausgabe als gedruckt markiert werden soll .
4. Funktion verkaufbelegPrintPDF ausführen.

Bei Erfolg wird eine Datenstruktur vom Typ VerkaufbelegPrintItem zurückgeliefert, diese enthält das PDF in Base64-Kodierung.

Aufruf:

{
  "verkaufbelegPrintPDF": {
    "Verkaufbeleg_ID": "..." ,  // string
    "DruckformularName": "..." ,    // string
    "MarkAsPrinted":  ...   // boolean (true|false)
  }
}

Rückgabe:

{
  "verkaufbelegPrintPDFResponse": {
    "ReturnData": {
      "VerkaufbelegPrintItem": {...}
    }
  }
}

Einkaufsbelege

Datenstrukturen von Einkaufsbelege

EinkaufbelegArt

EinkaufbelegStatus

EinkaufbelegDruckstatus

EinkaufBelegKalkbasis

EinkaufbelegPositionArt

EinkaufbelegFilter

EinkaufbelegListitem

EinkaufbelegItem

EinkaufbelegPositionItem

EinkaufbelegAddItem

EinkaufbelegPositionAddItem

EinkaufbelegPrintItem

Funktionsliste von Einkaufsbelege

einkaufbelegFilterTemplate

Vorlage für Einkaufbeleg-Filter

Aufruf:

{
  "einkaufbelegFilterTemplate":""
}

Rückgabe:

{
  "einkaufbelegFilterTemplateResponse": {
    "ReturnData": {
      "EinkaufbelegFilter": {...}
    }
  }
}

einkaufbelegList

Auflistung Einkaufbelege

Aufruf:

{
  "einkaufbelegList": {
    "EinkaufbelegFilter":  ...  // (optional)
  }
}

Rückgabe:

{
  "einkaufbelegListResponse": {
    "ReturnData": {
      "EinkaufbelegListitem": [ {}, ... ]
    }
  }
}

einkaufbelegGet

Liefert Details eines Einkaufbeleg

Aufruf:

{
  "einkaufbelegGet": {
    "Einkaufbeleg_ID": "..."    // string
  }
}

Rückgabe:

{
  "einkaufbelegGetResponse": {
    "ReturnData": {
      "EinkaufbelegItem": {...}
    }
  }
}

einkaufbelegTemplate

liefert EinkaufbelegAddItem als Vorlage

Aufruf:

{
  "einkaufbelegTemplate": {
    "EinkaufbelegArt":  ... ,   // integer (optional)
    "Adresse_ID": "..." ,   // string (optional)
    "ArtikelAddPostenList": {
      "ArtikelAddPosten": [ {}, ... ]
    }
  }
}

Rückgabe:

{
  "einkaufbelegTemplateResponse": {
    "ReturnData": {
      "EinkaufbelegAddItem": {...}
    }
  }
}

einkaufbelegDuplikatTemplate

Vorlage für einen duplizierten Einkaufbeleg

Aufruf:

{
  "einkaufbelegDuplikatTemplate": {
    "Einkaufbeleg_ID": "..." ,  // string
    "Adresse_ID": "..."     // string (optional)
  }
}

Rückgabe:

{
  "einkaufbelegDuplikatTemplateResponse": {
    "ReturnData": {
      "EinkaufbelegAddItem": {...}
    }
  }
}

einkaufbelegWeiterleitungTemplate

Vorlage für einen weitergeleiteten Einkaufbeleg

Aufruf:

{
  "einkaufbelegWeiterleitungTemplate": {
    "Einkaufbeleg_ID": "..." ,  // string
    "EinkaufbelegArt":  ...     // integer
  }
}

Rückgabe:

{
  "einkaufbelegWeiterleitungTemplateResponse": {
    "ReturnData": {
      "EinkaufbelegAddItem": {...}
    }
  }
}

einkaufbelegPositionTemplate

liefert EinkaufbelegPositionAddItem als Vorlage

Aufruf:

{
  "einkaufbelegPositionTemplate": {
    "Artikel_ID": "..." ,   // string (optional)
    "Adresse_ID": "..." ,   // string (optional)
    "Artikelmenge":  ...    // integer (optional)
  }
}

Rückgabe:

{
  "einkaufbelegPositionTemplateResponse": {
    "ReturnData": {
      "EinkaufbelegPositionAddItem": {...}
    }
  }
}

einkaufbelegPreview

berechnet einen Einkaufbeleg ohne zu sichern

Aufruf:

{
  "einkaufbelegPreview": {
    "EinkaufbelegAddItem":  ...
  }
}

Rückgabe:

{
  "einkaufbelegPreviewResponse": {
    "ReturnData": {
      "EinkaufbelegItem": {...}
    }
  }
}

einkaufbelegAdd

fügt einen neuen Einkaufbeleg hinzu

Aufruf:

{
  "einkaufbelegAdd": {
    "EinkaufbelegAddItem":  ...
  }
}

Rückgabe:

{
  "einkaufbelegAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

einkaufbelegWeiterleitung

fügt einen weitergeleiteten Einkaufbeleg hinzu

Aufruf:

{
  "einkaufbelegWeiterleitung": {
    "EinkaufbelegAddItem":  ...
  }
}

Rückgabe:

{
  "einkaufbelegWeiterleitungResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

einkaufbelegDelete

löscht einen Einkaufbeleg

Aufruf:

{
  "einkaufbelegDelete": {
    "Einkaufbeleg_ID": "..."    // string
  }
}

Rückgabe:

{
  "einkaufbelegDeleteResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

einkaufbelegAddAttachment

fügt ein Attachment einem Einkaufbeleg hinzu

Aufruf:

{
  "einkaufbelegAddAttachment": {
    "Einkaufbeleg_ID": "..." ,  // string
    "AttachmentAddItem":  ...
  }
}

Rückgabe:

{
  "einkaufbelegAddAttachmentResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

einkaufbelegPrintPDF

liefert einen Einkaufbeleg als PDF

Aufruf:

{
  "einkaufbelegPrintPDF": {
    "Einkaufbeleg_ID": "..." ,  // string
    "DruckformularName": "..." ,    // string
    "MarkAsPrinted":  ...   // boolean (true|false)
  }
}

Rückgabe:

{
  "einkaufbelegPrintPDFResponse": {
    "ReturnData": {
      "EinkaufbelegPrintItem": {...}
    }
  }
}

Buchungen

Datenstrukturen von Buchungen

BuchungStatus

BuchungFilter

BuchungListItem

BuchungItem

BuchungAddItem

BuchungPositionAddItem

BuchungJournalItem

Neu ab Version 18.1.0

Funktionsliste von Buchungen

buchungFilterTemplate

Vorlage für Buchung-Filter

Aufruf:

{
  "buchungFilterTemplate":""
}

Rückgabe:

{
  "buchungFilterTemplateResponse": {
    "ReturnData": {
      "BuchungFilter": {...}
    }
  }
}

buchungList

Listet alle Buchungen

Aufruf:

{
  "buchungList": {
    "BuchungFilter":  ...   // (optional)
  }
}

Rückgabe:

{
  "buchungListResponse": {
    "ReturnData": {
      "BuchungListItem": [ {}, ... ]
    }
  }
}

buchungGet

Liefert Eigenschaften einer Buchung

Aufruf:

{
  "buchungGet": {
    "Buchung_ID": "..."     // string
  }
}

Rückgabe:

{
  "buchungGetResponse": {
    "ReturnData": {
      "BuchungItem": {...}
    }
  }
}

buchungTemplate

liefert BuchungAddItem als Vorlage

Aufruf:

{
  "buchungTemplate": {
    "PositionenAnzahl":  ...    // integer (optional)
  }
}

Rückgabe:

{
  "buchungTemplateResponse": {
    "ReturnData": {
      "BuchungAddItem": {...}
    }
  }
}

buchungAdd

fügt neue Buchung hinzu

Hinweis: Standardbuchungen enthalten ein BuchungPositionAddItem Mehrere BuchungPositionAddItem werden für Splitt-Buchungen verwendet

Aufruf:

{
  "buchungAdd": {
    "BuchungAddItem":  ...
  }
}

Rückgabe:

{
  "buchungAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

buchungAddAttachment

fügt ein Attachment einer Buchung hinzu

Aufruf:

{
  "buchungAddAttachment": {
    "Buchung_ID": "..." ,   // string
    "AttachmentAddItem":  ...
  }
}

Rückgabe:

{
  "buchungAddAttachmentResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

Debitoren

Datenstrukturen von Debitoren

DebitorenRechnungArt

DebitorenRechnungArtAnzeige

DebitorenbelegStatus

neu ab Version 17.0

DebitorenRechnungKalkbasis

DebitorenRechnungListItem

DebitorenRechnungItem

DebitorenRechnungPositionItem

DebitorenRechnungAddItem

DebitorenRechnungPositionAddItem

DebitorenRechnungFilter

DebitorenZahlungListItem

DebitorenZahlungItem

DebitorenZahlungFilter

Funktionsliste von Debitoren

debitorenRechnungFilterTemplate

Vorlage für Filter Debitorenrechnungen

Aufruf:

{
  "debitorenRechnungFilterTemplate":""
}

Rückgabe:

{
  "debitorenRechnungFilterTemplateResponse": {
    "ReturnData": {
      "DebitorenRechnungFilter": {...}
    }
  }
}

debitorenRechnungList

Auflistung Debitorenrechnungen

Aufruf:

{
  "debitorenRechnungList": {
    "DebitorenRechnungFilter":  ...     // (optional)
  }
}

Rückgabe:

{
  "debitorenRechnungListResponse": {
    "ReturnData": {
      "DebitorenRechnungListItem": [ {}, ... ]
    }
  }
}

debitorenRechnungGet

Liefert Details einer Debitorenrechnung

Aufruf:

{
  "debitorenRechnungGet": {
    "Posten_ID": "..."  // string
  }
}

Rückgabe:

{
  "debitorenRechnungGetResponse": {
    "ReturnData": {
      "DebitorenRechnungItem": {...}
    }
  }
}

debitorenRechnungTemplate

liefert DebitorenRechnungAddItem als Vorlage

Aufruf:

{
  "debitorenRechnungTemplate": {
    "Adresse_ID": "..." ,   // string (optional)
    "Datum": "..." ,    // date (yyyy-mm-dd) (optional)
    "PositionenAnzahl":  ...    // integer (optional)
  }
}

Rückgabe:

{
  "debitorenRechnungTemplateResponse": {
    "ReturnData": {
      "DebitorenRechnungAddItem": {...}
    }
  }
}

debitorenRechnungPreview

berechnet eine neue Debitorenrechnung, ohne speichern

Aufruf:

{
  "debitorenRechnungPreview": {
    "DebitorenRechnungAddItem":  ...
  }
}

Rückgabe:

{
  "debitorenRechnungPreviewResponse": {
    "ReturnData": {
      "DebitorenRechnungItem": {...}
    }
  }
}

debitorenRechnungAdd

fügt eine neue Debitorenrechnung hinzu

Aufruf:

{
  "debitorenRechnungAdd": {
    "DebitorenRechnungAddItem":  ...
  }
}

Rückgabe:

{
  "debitorenRechnungAddResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

debitorenRechnungDelete

löscht eine vorhandene Debitorenrechnung

Aufruf:

{
  "debitorenRechnungDelete": {
    "Posten_ID": "..."  // string
  }
}

Rückgabe:

{
  "debitorenRechnungDeleteResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

debitorenRechnungAddAttachment

fügt ein Attachment einer Debitorenrechnung hinzu

Aufruf:

{
  "debitorenRechnungAddAttachment": {
    "Posten_ID": "..." ,    // string
    "AttachmentAddItem":  ...
  }
}

Rückgabe:

{
  "debitorenRechnungAddAttachmentResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

debitorenZahlungFilterTemplate

Vorlage für Filter Debitorenzahlungen

Aufruf:

{
  "debitorenZahlungFilterTemplate":""
}

Rückgabe:

{
  "debitorenZahlungFilterTemplateResponse": {
    "ReturnData": {
      "DebitorenZahlungFilter": {...}
    }
  }
}

debitorenZahlungList

Auflistung Debitorenzahlungen

Aufruf:

{
  "debitorenZahlungList": {
    "DebitorenZahlungFilter":  ...  // (optional)
  }
}

Rückgabe:

{
  "debitorenZahlungListResponse": {
    "ReturnData": {
      "DebitorenZahlungListItem": [ {}, ... ]
    }
  }
}

debitorenZahlungGet

Liefert Details einer Debitorenzahlung

Aufruf:

{
  "debitorenZahlungGet": {
    "Zahlung_ID": "..."     // string
  }
}

Rückgabe:

{
  "debitorenZahlungGetResponse": {
    "ReturnData": {
      "DebitorenZahlungItem": {...}
    }
  }
}

debitorenZahlungCreate

erzeugt Zahlung für Debitorenrechnung

Es wird für einen vorhandenen Debitoren-Rechnung eine Zahlung angelegt. Ablauf:

1. Posten_ID ermitteln für welchen eine Zahlung angelegt werden soll( z.B. über debitorenRechnungList).
2. Funktion debitorenZahlungCreate mit Parameter Posten_ID,Datum,Konto,Zahlungsart ausführen. Es wird eine Zahlung angelegt, Rückgabe InsertID oder Fehlerstatus.

Aufruf:

{
  "debitorenZahlungCreate": {
    "Posten_ID": "..." ,    // string
    "Datum": "..." ,    // date (yyyy-mm-dd)
    "Konto":  ... , // integer
    "Zahlungsart":  ...     // Zahlungsart, optional, default ist Angabe im Posten
  }
}

Rückgabe:

{
  "debitorenZahlungCreateResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

debitorenZahlungDelete

löscht eine vorhandene Debitorenzahlung

Aufruf:

{
  "debitorenZahlungDelete": {
    "Zahlung_ID": "..."     // string
  }
}

Rückgabe:

{
  "debitorenZahlungDeleteResponse": {
    "ReturnData": {
      "ReturnStatus": {...}
    }
  }
}

Kreditoren

Datenstrukturen von Kreditoren

KreditorenRechnungArt

KreditorenRechnungArtAnzeige

KreditorenRechnungKalkbasis

KreditorenRechnungListItem

KreditorenRechnungItem