MonKey Office Connect JSON-API Referenz
Version: 20.4.0 / 22.05.23
Hinweis: Die angegebene IP-Adressen/Ports sind von den aktuellen Einstellungen abhängig. (Siehe Bereich Status bzw. Einstellungen)
Für den Zugriff muss ein Benutzer mit Passwort in Monkey Office angelegt und mit entsprechenden Zugriffsrechten versehen werden. (Wichtig: Admin-User können nicht über die API zugreifen, es empfiehlt sich einen eigenen Nutzer nur für die API anzulegen. Diesem Nutzer ist dann für die gewünschten Firmen über "Eingeschränkter Zugriff" die Benutzung von MonKey Office Connect zu erlauben.)
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.
Wichtig: Diese PHP-Bibliothek ist von der jeweiligen API-Version abhängig. Geänderte Funktionalitäten können zu Inkompatiblitäten mit vorangegangenen Versionen führen.
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 modifzieren 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
Wichtige Änderungen/Ergänzungen/Fehlerbeseitigungen API Version 20
- Allgemein
[20.4.0] Änderungen zur Verbesserung der Stabilität
[20.4.0] Änderung DB/API Schema auf Version 100
- Adressen
[20.4.0] fehlende Erzeugung von Debi/Kredi-Konten bei Statusänderung - korrigiert
[20.3.0] adresseSepaMandatPrintPDF, Unterstütztung DynaPDF (veraltet)
- Verkaufsbelege
[20.4.0] Der Zahlungstext eines bestehenden Belegs ändert sich beim Drucken - behoben.
[20.3.0] verkaufbelegPrintPDF, Unterstütztung DynaPDF (veraltet)
[20.0.0] Unterstützung Ansprechpartner in Verkaufsbelegen
- Einkaufsbelege
[20.4.0] Der Zahlungstext eines bestehenden Belegs ändert sich beim Drucken - behoben.
[20.3.0] einkaufbelegPrintPDF, Unterstütztung DynaPDF (veraltet)
[20.3.0] einkaufbelegWeiterleitung, Positionsbezeichnungen lassen sich aktualisieren
[20.1.0] Neue Parameter um VorbelegBestellNr, VorbelegBestell_ID in Belegpositionen
[20.0.0] Unterstützung Ansprechpartner in Einkaufsbelegen
- Debitoren
[20.1.0] Unterstützung Parameter Text in DebitorenRechnungPositionAddItem beim Anlegen von Debitorenrechnungen mit mehreren Positionen
[20.0.0] Parameter Referenz wird nicht korrekt angezeigt, behoben
- Kreditoren
[20.1.0] Unterstützung Parameter Text in KreditorenRechnungPositionAddItem beim Anlegen von Debitorenrechnungen mit mehreren Positionen
[20.0.0] Parameter Referenz wird nicht korrekt angezeigt, behoben
- Aktivitaet
[20.0.0] Unterstützung Aktivität implementiert
- Attachment-Verwaltung
[20.1.0] Filter um DatumVonParent, DatumBisParent erweitert.
[20.0.0] Fehler bei Anlegen von mehreren Link-Attachments behoben.
Globale Datenstrukturen
-
{ | "Statuscode": ... , | | "StatustextItem": [...] , | | "Insert_ID": "..." |
} |
Firmen
Datenstrukturen von Firmen
-
{ | "Firma_Name": "..." , | | "Firma_Zusatz": "..." , | | "Firma_Geschaeftsfuehrer": "..." , | | "Firma_Strasse": "..." , | | "Firma_Plz": "..." , | | "Firma_Ort": "..." , | | "Firma_Telefon": "..." , | | "Firma_Telefax": "..." , | | "Firma_Email": "..." , | | "Firma_Internet": "..." , | | "Firma_RegisterGericht": "..." , | | "Firma_RegisterNummer": "..." , | | "Firma_BankIBAN": "..." , | | "Firma_BankBIC": "..." , | | "Firma_BankName": "..." , | | "Firma_UStPflicht": "..." , | | "Firma_UStIDNummer": "..." , | | "Firma_Kontenplan": "..." , | | "Firma_GEArt": "..." , | | "Firma_FALand": "..." , | | "Firma_FANummer": "..." , | | "Firma_FAName": "..." , | | "Firma_FAZusatz": "..." , | | "Firma_FAStrasse": "..." , | | "Firma_FAPlz": "..." , | | "Firma_FAOrt": "..." , | | "Firma_FABundesland": "..." , | | "Firma_FAStNrPrefix": "..." , | | "Firma_FASteuernummer": "..." , | | "Firma_FAStNrPostfix": "..." , | | "Firma_FATelefon": "..." , | | "Firma_FATelefax": "..." , | | "Firma_FABankName": "..." , | | "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": "..." , | | "Firma_FANummerLSt": "..." , | | "Firma_FANameLSt": "..." , | | "Firma_FAZusatzLSt": "..." , | | "Firma_FAStrasseLSt": "..." , | | "Firma_FAPlzLSt": "..." , | | "Firma_FAOrtLSt": "..." , | | "Firma_FABundeslandLSt": "..." , | | "Firma_FAStNrPrefixLSt": "..." , | | "Firma_FASteuernummerLSt": "..." , | | "Firma_FAStNrPostfixLSt": "..." , | | "Firma_FATelefonLSt": "..." , | | "Firma_FATelefaxLSt": "..." , | | "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": "..." , | | "DatumBis": "..." |
} |
-
{ | "Firma_ID": "..." , | | "Bezeichnung": "..." , | | "Zusatz": "..." |
} |
Funktionsliste von Firmen
Listet verfügbare Firmen
- Aufruf:
-
{ "firmaList":""}
- Rückgabe:
-
{ "firmaListResponse":
{ | "ReturnData": { "FirmaListItem": [ {}, ... ] } |
} |
}
Infos zur aktuell selektierten Firma
- Aufruf:
-
{ "firmaGet":""}
- Rückgabe:
-
{ "firmaGetResponse":
{ | "ReturnData": { "FirmaItem": {...} } |
} |
}
Vorgaben
Datenstrukturen von Vorgaben
Unterstützung OSS ab Version 18.5
-
-
{ | "Name": "..." , | | "Beschreibung": "..." , | | "Bemerkung": "..." |
} |
-
{ | "NKIdent": ..., | | "Gruppe": "..." , | | "Bereich": "..." , | | "Aktuell": "..." , | | "Nachfolger": "..." |
} |
-
{ | "Name": "..." , | | "Beschreibung": "..." , | | "Steuersatz": "..." , | | "Gesperrt": ... , | | "OSS_Steuersatz": ... |
} |
-
{ | "Name": "..." , | | "Isocode": "..." , | | "Kurs": ... |
} |
-
{ | "VKPreisliste_ID": "..." , | | "Bezeichnung": "..." , | | "Beschreibung": "..." , | | "Standard": ... , | | "BerechnungArt": ..., | | "MargeArt": ... |
} |
ZahlungsBedingungEinkaufListItem
Top
Back
-
{ | "Bezeichnung": "..." , | | "Zahlungsart": ... , | | "TageNetto": ... , | | "TageSkonto": ... , | | "ProzentSkonto": ... |
} |
ZahlungsBedingungVerkaufListItem
Top
Back
-
{ | "Bezeichnung": "..." , | | "Zahlungsart": ... , | | "TageNetto": ... , | | "TageSkonto": ... , | | "ProzentSkonto": ... , | | "NichtMahnen": ... |
} |
-
| { "NummernkreisIdents": ... } |
-
| { "DruckFormularGruppen": ... } |
-
{ | "Suchtext": "..." , | | "DruckformularGruppe": ... |
} |
-
{ | "DruckformularName": "..." , | | "DruckformularGruppe": ... |
} |
-
| { "FestschreibStatus": ... } |
neu ab Version 18.4
-
{ | "Isocode": "..." , | | "Steuersatz": "..." , | | "Typ": ... |
} |
neu ab Version 18.4
-
| { "SteuersatzOSSTyp": ... } |
Funktionsliste von Vorgaben
Liefert definierte Kostenstellen
- Aufruf:
-
{ "kostenstellenList":""}
- Rückgabe:
-
{ "kostenstellenListResponse":
{ | "ReturnData": { "KostenstelleListItem": [ {}, ... ] } |
} |
}
Liefert definierte Nummerkreise
- Aufruf:
-
{ "nummernkreisList":""}
- Rückgabe:
-
{ "nummernkreisListResponse":
{ | "ReturnData": { "NummernkreisListItem": [ {}, ... ] } |
} |
}
Liefert definierte Steuersätze
- Aufruf:
-
{ "steuersatzList":""}
- Rückgabe:
-
{ "steuersatzListResponse":
{ | "ReturnData": { "SteuersatzListItem": [ {}, ... ] } |
} |
}
Liefert definierte Währungen
- Aufruf:
-
{ "waehrungList":""}
- Rückgabe:
-
{ "waehrungListResponse":
{ | "ReturnData": { "WaehrungListItem": [ {}, ... ] } |
} |
}
Liefert definierte VK-Preisliste
- Aufruf:
-
{ "preislisteVerkaufList":""}
- Rückgabe:
-
{ "preislisteVerkaufListResponse":
{ | "ReturnData": { "VerkaufpreislisteListItem": [ {}, ... ] } |
} |
}
zahlungsbedingungEinkaufList
Top
Back
Liefert definierte Zahlungsbedingungen Einkauf
- Aufruf:
-
{ "zahlungsbedingungEinkaufList":""}
- Rückgabe:
-
{ "zahlungsbedingungEinkaufListResponse":
{ | "ReturnData": { "ZahlungsBedingungEinkaufListItem": [ {}, ... ] } |
} |
}
zahlungsbedingungVerkaufList
Top
Back
Liefert definierte Zahlungsbedingungen Verkauf
- Aufruf:
-
{ "zahlungsbedingungVerkaufList":""}
- Rückgabe:
-
{ "zahlungsbedingungVerkaufListResponse":
{ | "ReturnData": { "ZahlungsBedingungVerkaufListItem": [ {}, ... ] } |
} |
}
druckformularFilterTemplate
Top
Back
Liefert Filter für Druckformulare
- Aufruf:
-
{ "druckformularFilterTemplate":""}
- Rückgabe:
-
{ "druckformularFilterTemplateResponse":
{ | "ReturnData": { "DruckFormularFilter": {...} } |
} |
}
Liefert definierte Druckformulare
- Aufruf:
-
{ "druckformularList":
{ | "DruckFormularFilter": ... |
} |
}
- Rückgabe:
-
{ "druckformularListResponse":
{ | "ReturnData": { "DruckFormularListItem": [ {}, ... ] } |
} |
}
Liefert OSS-Steuersatzdaten
Es werden die im Programm hinterlegten Daten der Steuersätze für die Anwendung des OSS-Verfahrens geliefert
Adressiert werden die Daten über den Länderkennzeichen im ISO-Code.
Verwendung finden die Daten bei Verkaufsbelegen, Debitorenrechnungen, Buchungen.
Voraussetzung ist, das dem verwendete Erlöskonto ein OSS-Steuersatz zugewiesen wurde. Anderenfalls werden die Daten ignoriert.
- Aufruf:
-
{ "steuersatzOSSList":}
- Rückgabe:
-
{ "steuersatzOSSListResponse":
{ | "ReturnData": { "OSSDatenItem": {...} } |
} |
}
Adressen
Datenstrukturen von Adressen
-
| { "AdressePreisAngabe": ... } |
-
{ | "Adresse_ID": "..." , | | "VersionKey": "..." , | | "Matchcode": "..." , | | "AdressNr": "..." , | | "Kategorie": "..." , | | "KundenStatus": ..., | | "LieferantenStatus": ..., | | "RA_Firma1": "..." , | | "RA_Firma2": "..." , | | "RA_Anrede": "..." , | | "RA_Zusatz": "..." , | | "RA_Vorname": "..." , | | "RA_Nachname": "..." , | | "RA_Plz": "..." , | | "RA_Ort": "..." , | | "RA_Geschlecht": "..." , | | "RA_Strasse": "..." , | | "RA_StrasseNr": "..." , | | "RA_Land": "..." , | | "RA_LandISO": "..." , | | "RA_PostfachPlz": "..." , | | "RA_PostfachNr": "..." , | | "RA_PfVerwenden": ... , | | "RA_Telefon1": "..." , | | "RA_Telefon2": "..." , | | "RA_Telefon3": "..." , | | "RA_Telefax": "..." , | | "RA_Email": "..." , | | "RA_Internet": "..." , | | "LA_Firma1": "..." , | | "LA_Firma2": "..." , | | "LA_LaVerwenden": ... , | | "LA_Anrede": "..." , | | "LA_Vorname": "..." , | | "LA_Nachname": "..." , | | "LA_Zusatz": "..." , | | "LA_Strasse": "..." , | | "LA_StrasseNr": "..." , | | "LA_Plz": "..." , | | "LA_Ort": "..." , | | "LA_Land": "..." , | | "LA_PostfachPlz": "..." , | | "LA_PostfachNr": "..." , | | "LA_PfVerwenden": ... , | | "LA_Telefon": "..." , | | "LA_Telefax": "..." , | | "LA_Email": "..." , | | "LA_Lieferart": "..." , | | "KF_Konto": ... , | | "KF_Sammelkonto": ... , | | "KF_Zahlungsbedingungen": "..." , | | "KF_Ertragkonto": ... , | | "KF_Waehrung": "..." , | | "KF_FinanzKonto": ... , | | "KF_Preisangabe": ..., | | "KF_KoSt1": "..." , | | "KF_KoSt2": "..." , | | "KF_ExterneNr": "..." , | | "KF_Lieferstopp": ... , | | "KF_Rabatt": "..." , | | "KF_PreislisteID": "..." , | | "KF_Bankdaten": { "BankdatenItem": {...} } , | | "LF_Konto": ... , | | "LF_Sammelkonto": ... , | | "LF_Zahlungsbedingungen": "..." , | | "LF_Aufwandkonto": ... , | | "LF_Waehrung": "..." , | | "LF_FinanzKonto": ... , | | "LF_Preisangabe": ..., | | "LF_KoSt1": "..." , | | "LF_KoSt2": "..." , | | "LF_ExterneNr": "..." , | | "LF_Bestellstopp": ... , | | "LF_Rabatt": "..." , | | "LF_Bankdaten": { "BankdatenItem": {...} } , | | "Steuergebiet": ... , | | "UStID": "..." , | | "Belegsprache": "..." , | | "Briefanrede": "..." , | | "Briefgruss": "..." , | | "Notizen": "..." , | | "Mail_Preferred": ... , | | "AttachmentIDList": [...] |
} |
-
{ | "Matchcode": "..." , | | "AdressNr": "..." , | | "Kategorie": "..." , | | "KundenStatus": ..., | | "LieferantenStatus": ..., | | "RA_Firma1": "..." , | | "RA_Firma2": "..." , | | "RA_Anrede": "..." , | | "RA_Zusatz": "..." , | | "RA_Vorname": "..." , | | "RA_Nachname": "..." , | | "RA_Plz": "..." , | | "RA_Ort": "..." , | | "RA_Geschlecht": "..." , | | "RA_Strasse": "..." , | | "RA_StrasseNr": "..." , | | "RA_Land": "..." , | | "RA_LandISO": "..." , | | "RA_PostfachPlz": "..." , | | "RA_PostfachNr": "..." , | | "RA_PfVerwenden": ... , | | "RA_Telefon1": "..." , | | "RA_Telefon2": "..." , | | "RA_Telefon3": "..." , | | "RA_Telefax": "..." , | | "RA_Email": "..." , | | "RA_Internet": "..." , | | "LA_Firma1": "..." , | | "LA_Firma2": "..." , | | "LA_LaVerwenden": ... , | | "LA_Anrede": "..." , | | "LA_Vorname": "..." , | | "LA_Nachname": "..." , | | "LA_Zusatz": "..." , | | "LA_Strasse": "..." , | | "LA_StrasseNr": "..." , | | "LA_Plz": "..." , | | "LA_Ort": "..." , | | "LA_Land": "..." , | | "LA_PostfachPlz": "..." , | | "LA_PostfachNr": "..." , | | "LA_PfVerwenden": ... , | | "LA_Telefon": "..." , | | "LA_Telefax": "..." , | | "LA_Email": "..." , | | "LA_Lieferart": "..." , | | "KF_Zahlungsbedingungen": "..." , | | "KF_Preisangabe": ..., | | "KF_ExterneNr": "..." , | | "KF_Lieferstopp": ... , | | "KF_Rabatt": "..." , | | "KF_KoSt1": "..." , | | "KF_KoSt2": "..." , | | "KF_PreislisteID": "..." , | | "KF_Ertragkonto": ... , | | "KF_Konto": ... , | | "KF_Sammelkonto": ... , | | "KF_Waehrung": "..." , | | "KF_FinanzKonto": ... , | | "KF_Bankdaten": { "BankdatenItem": {...} } , | | "LF_Zahlungsbedingungen": "..." , | | "LF_Preisangabe": ..., | | "LF_ExterneNr": "..." , | | "LF_Bestellstopp": ... , | | "LF_Rabatt": "..." , | | "LF_KoSt1": "..." , | | "LF_KoSt2": "..." , | | "LF_Aufwandkonto": ... , | | "LF_Konto": ... , | | "LF_Sammelkonto": ... , | | "LF_Waehrung": "..." , | | "LF_FinanzKonto": ... , | | "LF_Bankdaten": { "BankdatenItem": {...} } , | | "Steuergebiet": ... , | | "UStID": "..." , | | "Belegsprache": "..." , | | "Briefanrede": "..." , | | "Briefgruss": "..." , | | "Notizen": "..." , | | "Mail_Preferred": ... |
} |
-
{ | "Adresse_ID": "..." , | | "Matchcode": "..." , | | "AdressNr": "..." , | | "Kategorie": "..." , | | "KundenStatus": ..., | | "LieferantenStatus": ..., | | "RA_Firma1": "..." , | | "RA_Vorname": "..." , | | "RA_Nachname": "..." , | | "RA_Plz": "..." , | | "RA_Ort": "..." , | | "RA_Strasse": "..." , | | "RA_StrasseNr": "..." |
} |
-
{ | "Suchtext": "..." , | | "Matchcode": "..." , | | "AdresseKategorie": "..." , | | "LieferantenStatus": ..., | | "KundenStatus": ... |
} |
-
{ | "Adresse_ID": "..." , | | "Ansprechpartner_ID": "..." , | | "Abteilung": "..." , | | "Position": "..." , | | "Vorname": "..." , | | "Nachname": "..." , | | "EmailFirma": "..." , | | "EmailPrivat": "..." , | | "TelefonFirma": "..." , | | "TelefonMobil": "..." , | | "TelefonPrivat": "..." |
} |
-
{ | "Adresse_ID": "..." , | | "Abteilung": "..." , | | "Position": "..." , | | "Vorname": "..." , | | "Nachname": "..." , | | "EmailFirma": "..." , | | "EmailPrivat": "..." , | | "TelefonFirma": "..." , | | "TelefonMobil": "..." , | | "TelefonPrivat": "..." , | | "Anrede": "..." , | | "Geschlecht": "..." , | | "Geburtsdatum": "..." , | | "Briefanrede": "..." , | | "Zusatz": "..." , | | "Bemerkung": "..." , | | "KontaktRollenList": { "KontaktRolleItem": [ {}, ... ] } |
} |
-
{ | "Adresse_ID": "..." , | | "Ansprechpartner_ID": "..." , | | "VersionKey": "..." , | | "Abteilung": "..." , | | "Position": "..." , | | "Vorname": "..." , | | "Nachname": "..." , | | "EmailFirma": "..." , | | "EmailPrivat": "..." , | | "TelefonFirma": "..." , | | "TelefonMobil": "..." , | | "TelefonPrivat": "..." , | | "Anrede": "..." , | | "Geschlecht": "..." , | | "Geburtsdatum": "..." , | | "Briefanrede": "..." , | | "Zusatz": "..." , | | "Bemerkung": "..." , | | "KontaktRollenList": { "KontaktRolleItem": [ {}, ... ] } |
} |
-
{ | "IBAN": "..." , | | "BIC": "..." , | | "Bank": "..." , | | "Inhaber": "..." |
} |
-
| { "SepaMandatStatus": ... } |
-
{ | "Adresse_ID": "..." , | | "MandatReferenz": "..." , | | "MandatArt": ..., | | "MandatTyp": ..., | | "MandatStatus": ..., | | "Einreichfrist": ... , | | "GueltigAb": "..." , | | "GueltigBis": "..." , | | "AktiviertBis": "..." |
} |
-
{ | "SepaMandat_ID": "..." , | | "Adresse_ID": "..." , | | "MandatReferenz": "..." , | | "MandatStatus": ..., | | "MandatArt": ..., | | "MandatTyp": ... |
} |
-
{ | "SepaMandat_ID": "..." , | | "VersionKey": "..." , | | "Adresse_ID": "..." , | | "MandatReferenz": "..." , | | "MandatStatus": ..., | | "MandatArt": ..., | | "MandatTyp": ..., | | "Einreichfrist": ... , | | "GueltigAb": "..." , | | "GueltigBis": "..." , | | "AktiviertBis": "..." , | | "WiderrufenAm": "..." , | | "LetzteVerwendung": "..." , | | "ErstelltAm": "..." |
} |
-
{ | "Name": "..." , | | "Dateigroesse": ... , | | "Dateityp": "..." , | | "DatenBASE64": "..." |
} |
Funktionsliste von Adressen
Vorlage für Adressen-Filter
- Aufruf:
-
{ "adresseFilterTemplate":""}
- Rückgabe:
-
{ "adresseFilterTemplateResponse":
{ | "ReturnData": { "AdresseFilter": {...} } |
} |
}
liefert alle Adressen als Liste
- Aufruf:
-
{ "adresseList":}
- Rückgabe:
-
{ "adresseListResponse":
{ | "ReturnData": { "AdresseListItem": [ {}, ... ] } |
} |
}
liefert Details einer Adresse
- Aufruf:
-
{ "adresseGet":}
- Rückgabe:
-
{ "adresseGetResponse":
{ | "ReturnData": { "AdresseItem": {...} } |
} |
}
fügt eine Adresse hinzu
- Aufruf:
-
{ "adresseAdd":}
- Rückgabe:
-
{ "adresseAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
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 Vorname (Adresse_ID,VersionKey beispielhaft)
{
"adresseModify":{
"AdresseItem":{
"Adresse_ID":"481A62479DF4207DB23598B6461308",
"VersionKey":"99276D86013D6FE47EFB22572D96B63624",
"RA_Vorname":"Paul"
}
}
}
- Aufruf:
-
{ "adresseModify":}
- Rückgabe:
-
{ "adresseModifyResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht vorhandene Adresse
- Aufruf:
-
{ "adresseDelete":}
- Rückgabe:
-
{ "adresseDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
liefert AdresseAddItem als Vorlage
- Aufruf:
-
{ "adresseTemplate":""}
- Rückgabe:
-
{ "adresseTemplateResponse":
{ | "ReturnData": { "AdresseAddItem": {...} } |
} |
}
ermittelt alle Adress-Kategorien
- Aufruf:
-
{ "adresseKategorieList":""}
- Rückgabe:
-
{ "adresseKategorieListResponse":
{ | "ReturnData": { "AdresseKategorieItem": [ {}, ... ] } |
} |
}
fügt ein Attachment einer Adresse hinzu
- Aufruf:
-
{ "adresseAddAttachment":
{ | "Adresse_ID": "..." , | | "AttachmentAddItem": ... |
} |
}
- Rückgabe:
-
{ "adresseAddAttachmentResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
adresseAnsprechpartnerTemplate
Top
Back
liefert AnsprechpartnerAddItem als Vorlage
- Aufruf:
-
{ "adresseAnsprechpartnerTemplate":}
- Rückgabe:
-
{ "adresseAnsprechpartnerTemplateResponse":
{ | "ReturnData": { "AnsprechpartnerAddItem": {...} } |
} |
}
adresseAnsprechpartnerList
Top
Back
liefert alle Ansprechpartner einer Adresse
- Aufruf:
-
{ "adresseAnsprechpartnerList":}
- Rückgabe:
-
{ "adresseAnsprechpartnerListResponse":
{ | "ReturnData": { "AnsprechpartnerListItem": [ {}, ... ] } |
} |
}
fügt Ansprechpartner zu Adresse hinzu
- Aufruf:
-
{ "adresseAnsprechpartnerAdd":
{ | "AnsprechpartnerAddItem": ... |
} |
}
- Rückgabe:
-
{ "adresseAnsprechpartnerAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
liefert Details eines einzelnen Ansprechpartner
- Aufruf:
-
{ "adresseAnsprechpartnerGet":
{ | "Ansprechpartner_ID": "..." |
} |
}
- Rückgabe:
-
{ "adresseAnsprechpartnerGetResponse":
{ | "ReturnData": { "AnsprechpartnerItem": {...} } |
} |
}
adresseAnsprechpartnerModify
Top
Back
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 Nachname (Adresse_ID,Ansprechpartner_ID,VersionKey beispielhaft)
{
"adresseAnsprechpartnerModify":{
"AnsprechpartnerItem":{
"Adresse_ID":"480C644B85E2297DB23598B04C18",
"Ansprechpartner_ID":"4806655E84F42F4A8B10D0F3184C4BC98F057A8BEFAE",
"VersionKey":"067EF8D83D7912D08D53C8CDD06A7E0D73",
"Nachname":"Mustermann"
}
}
}
- Aufruf:
-
{ "adresseAnsprechpartnerModify":
{ | "AnsprechpartnerItem": ... |
} |
}
- Rückgabe:
-
{ "adresseAnsprechpartnerModifyResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
adresseAnsprechpartnerDelete
Top
Back
löscht eine Ansprechpartner
- Aufruf:
-
{ "adresseAnsprechpartnerDelete":
{ | "Ansprechpartner_ID": "..." |
} |
}
- Rückgabe:
-
{ "adresseAnsprechpartnerDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
Auflistung angelegter SEPA-Mandate für Adresse
- Aufruf:
-
{ "adresseSepaMandatList":}
- Rückgabe:
-
{ "adresseSepaMandatListResponse":
{ | "ReturnData": { "SepaMandatListItem": [ {}, ... ] } |
} |
}
Vorlage für neues SEPA-Mandat
- Aufruf:
-
{ "adresseSepaMandatTemplate":}
- Rückgabe:
-
{ "adresseSepaMandatTemplateResponse":
{ | "ReturnData": { "SepaMandatAddItem": {...} } |
} |
}
Anlegen eines SEPA-Mandat für Adresse
- Aufruf:
-
{ "adresseSepaMandatAdd":}
- Rückgabe:
-
{ "adresseSepaMandatAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
liefert Details eines vorhandenen SEPA-Mandat
- Aufruf:
-
{ "adresseSepaMandatGet":}
- Rückgabe:
-
{ "adresseSepaMandatGetResponse":
{ | "ReturnData": { "SepaMandatItem": {...} } |
} |
}
modifiziert vorhandenes SEPA-Mandat
- Aufruf:
-
{ "adresseSepaMandatModify":}
- Rückgabe:
-
{ "adresseSepaMandatModifyResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht vorhandenes SEPA-Mandat
- Aufruf:
-
{ "adresseSepaMandatDelete":}
- Rückgabe:
-
{ "adresseSepaMandatDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
gibt SEPA-Mandat als PDF aus
- Aufruf:
-
{ "adresseSepaMandatPrintPDF":
{ | "SepaMandat_ID": "..." , | | "DruckformularName": "..." , | | "UseOldPDF": ... |
} |
}
- Rückgabe:
-
{ "adresseSepaMandatPrintPDFResponse":
{ | "ReturnData": { "SepaMandatPrintItem": {...} } |
} |
}
Artikel und Leistungen
Datenstrukturen von Artikel und Leistungen
-
| { "StueckListeTyp": ... } |
-
| { "Artikelkalkaufwand": ... } |
-
| { "Artikelkalkbasis": ... } |
-
| { "Artikelkalkmarge": ... } |
-
| { "Warengruppeart": ... } |
-
{ | "Warengruppe_ID": "..." , | | "WarengruppeArt": ... , | | "Bezeichnung": "..." , | | "Obergruppe": "..." , | | "Obergruppe_ID": "..." |
} |
-
{ | "Warengruppe_ID": "..." , | | "WarengruppeArt": ... , | | "Bezeichnung": "..." , | | "Obergruppe": "..." , | | "Obergruppe_ID": "..." , | | "Beschreibung": "..." , | | "EKontoInland": ... , | | "EKontoEU": ... , | | "EKontoAusland": ... , | | "EKontoSteuerfrei": ... , | | "EKontoAnzInland": ... , | | "EKontoAnzEU": ... , | | "EKontoAnzEUOSS": ... , | | "EKontoAnzAusland": ... , | | "EKontoAnzSteuerfrei": ... , | | "AKontoInland": ... , | | "AKontoEU": ... , | | "AKontoAusland": ... , | | "AKontoSteuerfrei": ... , | | "GesamtRabattGesperrt": ... |
} |
-
{ | "WarengruppeArt": ... , | | "Bezeichnung": "..." , | | "Obergruppe": "..." , | | "Beschreibung": "..." , | | "EKontoInland": ... , | | "EKontoEU": ... , | | "EKontoAusland": ... , | | "EKontoSteuerfrei": ... , | | "EKontoAnzInland": ... , | | "EKontoAnzEU": ... , | | "EKontoAnzEUOSS": ... , | | "EKontoAnzAusland": ... , | | "EKontoAnzSteuerfrei": ... , | | "AKontoInland": ... , | | "AKontoEU": ... , | | "AKontoAusland": ... , | | "AKontoSteuerfrei": ... , | | "GesamtRabattGesperrt": ... |
} |
-
{ | "Suchtext": "..." , | | "Warengruppe": "..." , | | "Matchcode": "..." , | | "Artikelart": ... , | | "Artikelstatus": ... , | | "Bezeichnung": "..." , | | "Hersteller": "..." , | | "GesperrteAusblenden": ... , | | "nurLagerArtikel": ... , | | "nurOnlineshopArtikel": ... , | | "nurVorraetigeArtikel": ... , | | "nurBestellteArtikel": ... , | | "nurStueckartikel": ... , | | "nurStuecklisten": ... , | | "ohneStuecklisten": ... , | | "Stueckliste_Ident": "..." , | | "nurUnterMindestBestand": ... , | | "nurUnterZielBestand": ... |
} |
-
{ | "Artikel_ID": "..." , | | "Matchcode": "..." , | | "ArtikelArt": ... , | | "ArtikelNr": "..." , | | "Warengruppe": "..." , | | "Warengruppe_ID": "..." , | | "Bezeichnung": "..." |
} |
-
{ | "Artikel_ID": "..." , | | "VersionKey": "..." , | | "Matchcode": "..." , | | "ArtikelArt": ... , | | "ArtikelNr": "..." , | | "Warengruppe": "..." , | | "Warengruppe_ID": "..." , | | "Bezeichnung": "..." , | | "Beschreibung": "..." , | | "Status": ..., | | "Hersteller": "..." , | | "HerstellerNr": "..." , | | "HerstellerURL": "..." , | | "Einheit": "..." , | | "Groesse": "..." , | | "Verpackung": "..." , | | "GewichtProStk": ... , | | "Gewicht": ... , | | "EANCode": "..." , | | "Gesperrt": ... , | | "Sperrgrund": "..." , | | "Kostenstelle": "..." , | | "InPreisliste": ... , | | "Lagerartikel": ... , | | "Lager": "..." , | | "LagerReferenz": "..." , | | "OnlineshopArtikel": ... , | | "Bestand": ... , | | "Bestellt": ... , | | "MindestBestand": ... , | | "ZielBestand": ... , | | "BestandZuAb": ... , | | "BestandZuAbGrund": "..." , | | "BestelltZuAb": ... , | | "BestelltZuAbGrund": "..." , | | "Notizen": "..." , | | "ArtikelBildAnzahl": ... , | | "AttachmentIDList": [...] , | | "StueckListTyp": ..., | | "PreisProStkEK": ... , | | "PreisProStkVK": ... , | | "EKBerechnungArt": ..., | | "EKAufwandArt": ..., | | "EKPreisNetto": "..." , | | "EKPreisSteuer": "..." , | | "EKPreisBrutto": "..." , | | "EKAufwBetragNetto": "..." , | | "EKAufwBetragSteuer": "..." , | | "EKAufwBetragBrutto": "..." , | | "EKAufwProzentNetto": "..." , | | "EKAufwProzentBrutto": "..." , | | "EKGesamtNetto": "..." , | | "EKGesamtSteuer": "..." , | | "EKGesamtBrutto": "..." , | | "VKBerechnungArt": ..., | | "VKMargeArt": ..., | | "VKMargeBetragNetto": "..." , | | "VKMargeBetragSteuer": "..." , | | "VKMargeBetragBrutto": "..." , | | "VKMargeProzentNetto": "..." , | | "VKMargeProzentBrutto": "..." , | | "VKGesamtNetto": "..." , | | "VKGesamtSteuer": "..." , | | "VKGesamtBrutto": "..." |
} |
-
{ | "Bezeichnung": "..." , | | "ArtikelArt": ... , | | "ArtikelNr": "..." , | | "Warengruppe": "..." , | | "Matchcode": "..." , | | "Beschreibung": "..." , | | "Status": ..., | | "Hersteller": "..." , | | "HerstellerNr": "..." , | | "HerstellerURL": "..." , | | "Einheit": "..." , | | "Groesse": "..." , | | "Verpackung": "..." , | | "GewichtProStk": ... , | | "Gewicht": ... , | | "EANCode": "..." , | | "Gesperrt": ... , | | "Sperrgrund": "..." , | | "Kostenstelle": "..." , | | "InPreisliste": ... , | | "Lagerartikel": ... , | | "Lager": "..." , | | "LagerReferenz": "..." , | | "OnlineshopArtikel": ... , | | "BestandZuAb": ... , | | "BestandZuAbGrund": "..." , | | "BestelltZuAb": ... , | | "BestelltZuAbGrund": "..." , | | "MindestBestand": ... , | | "ZielBestand": ... , | | "Notizen": "..." , | | "PreisProStkEK": ... , | | "PreisProStkVK": ... , | | "EKBerechnungArt": ..., | | "EKAufwandArt": ..., | | "EKPreisNetto": "..." , | | "EKPreisSteuer": "..." , | | "EKPreisBrutto": "..." , | | "EKAufwBetragNetto": "..." , | | "EKAufwBetragSteuer": "..." , | | "EKAufwBetragBrutto": "..." , | | "EKAufwProzentNetto": "..." , | | "EKAufwProzentBrutto": "..." , | | "EKGesamtNetto": "..." , | | "EKGesamtSteuer": "..." , | | "EKGesamtBrutto": "..." , | | "VKBerechnungArt": ..., | | "VKMargeArt": ..., | | "VKMargeBetragNetto": "..." , | | "VKMargeBetragSteuer": "..." , | | "VKMargeBetragBrutto": "..." , | | "VKMargeProzentNetto": "..." , | | "VKMargeProzentBrutto": "..." , | | "VKGesamtNetto": "..." , | | "VKGesamtSteuer": "..." , | | "VKGesamtBrutto": "..." |
} |
-
{ | "Artikel_ID": "..." , | | "Artikelmenge": ... |
} |
-
{ | "Name": "..." , | | "Notizen": "..." , | | "Bildposition": ... , | | "Bildbreite": ... , | | "Bildhoehe": ... , | | "Bildformat": "..." , | | "DatenBASE64": "..." |
} |
-
{ | "Name": "..." , | | "Bildposition": ... , | | "Notizen": "..." , | | "DatenBASE64": "..." |
} |
Funktionsliste von Artikel und Leistungen
liefert WarengruppeAddItem als Vorlage
- Aufruf:
-
{ "warengruppeTemplate":""}
- Rückgabe:
-
{ "warengruppeTemplateResponse":
{ | "ReturnData": { "WarengruppeAddItem": {...} } |
} |
}
Auflistung Warengruppen
- Aufruf:
-
{ "warengruppeList":""}
- Rückgabe:
-
{ "warengruppeListResponse":
{ | "ReturnData": { "WarengruppeListItem": [ {}, ... ] } |
} |
}
Liefert Details einer Warengruppe
- Aufruf:
-
{ "warengruppeGet":}
- Rückgabe:
-
{ "warengruppeGetResponse":
{ | "ReturnData": { "WarengruppeItem": {...} } |
} |
}
fügt eine Warengruppe hinzu
- Aufruf:
-
{ "warengruppeAdd":
{ | "WarengruppeAddItem": ... |
} |
}
- Rückgabe:
-
{ "warengruppeAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht eine vorhandene Warengruppe
- Aufruf:
-
{ "warengruppeDelete":}
- Rückgabe:
-
{ "warengruppeDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
liefert ArtikelAddltem als Vorlage
- Aufruf:
-
{ "artikelTemplate":""}
- Rückgabe:
-
{ "artikelTemplateResponse":
{ | "ReturnData": { "ArtikelAddltem": {...} } |
} |
}
Auflistung Artikel
- Aufruf:
-
{ "artikelList":}
- Rückgabe:
-
{ "artikelListResponse":
{ | "ReturnData": { "ArtikelListItem": [ {}, ... ] } |
} |
}
Liefert Details eines Artikel/Leistung
- Aufruf:
-
{ "artikelGet":}
- Rückgabe:
-
{ "artikelGetResponse":
{ | "ReturnData": { "ArtikelItem": {...} } |
} |
}
fügt einen Artikel/Leistung hinzu
- Aufruf:
-
{ "artikelAdd":}
- Rückgabe:
-
{ "artikelAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht einen vorhandene Artikel/Leistung
- Aufruf:
-
{ "artikelDelete":}
- Rückgabe:
-
{ "artikelDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
ä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":}
- Rückgabe:
-
{ "artikelModifyResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
Vorlage für Filter Artikel/Leistungen
- Aufruf:
-
{ "artikelFilterTemplate":""}
- Rückgabe:
-
{ "artikelFilterTemplateResponse":
{ | "ReturnData": { "ArtikelFilter": {...} } |
} |
}
fügt ein Attachment einem Artikel hinzu
- Aufruf:
-
{ "artikelAddAttachment":
{ | "Artikel_ID": "..." , | | "AttachmentAddItem": ... |
} |
}
- Rückgabe:
-
{ "artikelAddAttachmentResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
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": "..." , | | "Bildposition": ... |
} |
}
- Rückgabe:
-
{ "artikelBildGetResponse":
{ | "ReturnData": { "ArtikelBildItem": {...} } |
} |
}
Abrufen einer Datenstruktur ArtikelBildAddlItem
- Aufruf:
-
{ "artikelBildTemplate":""}
- Rückgabe:
-
{ "artikelBildTemplateResponse":
{ | "ReturnData": { "ArtikelBildAddlItem": {...} } |
} |
}
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:
2.1 Den Namen des Artikebildes in Name festlegen. Dieser muss innerhalb des Artikels eindeutig sein.
2.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.
2.3 Die eigentlichen Bilddaten Base64-codiert in DatenBASE64 setzen. Unterstützt werden die gängien Bildformate.
2.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": "..." , | | "ArtikelBildAddlItem": ... |
} |
}
- Rückgabe:
-
{ "artikelBildAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
Lager
Datenstrukturen von Lager
-
| { "LagerjournalVorgang": ... } |
-
{ | "DatumVon": "..." , | | "DatumBis": "..." , | | "LagerjournalVorgang": ... , | | "Vortragswerte": ... , | | "NurLetzeBewegung": ... , | | "nurUnterMindestBestand": ... , | | "nurUnterZielBestand": ... , | | "nurMitBestellungen": ... |
} |
-
{ | "EingabeDatum": "..." , | | "Buchungdatum": "..." , | | "LagerjournalVorgang": ... , | | "VorgangInfo": "..." , | | "Menge": ... , | | "Bestellt": ... , | | "Bestand": ... |
} |
Funktionsliste von Lager
Listet alle Lagerartikel
- Aufruf:
-
{ "lagerartikelList":""}
- Rückgabe:
-
{ "lagerartikelListResponse":
{ | "ReturnData": { "ArtikelListItem": [ {}, ... ] } |
} |
}
lagerjournalFilterTemplate
Top
Back
Vorlage für Lagerjournal-Filter
- Aufruf:
-
{ "lagerjournalFilterTemplate":""}
- Rückgabe:
-
{ "lagerjournalFilterTemplateResponse":
{ | "ReturnData": { "LagerjournalFilter": {...} } |
} |
}
Liefert Lagerjournal(mit filter)
- Aufruf:
-
{ "lagerjournalList":
{ | "LagerjournalFilter": ... |
} |
}
- Rückgabe:
-
{ "lagerjournalListResponse":
{ | "ReturnData": { "LagerjournalArtikelItem": [ {}, ... ] } |
} |
}
Liefert Lagerjournal für Artikel (mit ID)
- Aufruf:
-
{ "lagerjournalGet":
{ | "Artikel_ID": "..." , | | "NurLetzeBewegung": ... |
} |
}
- Rückgabe:
-
{ "lagerjournalGetResponse":
{ | "ReturnData": { "LagerjournalItem": {...} } |
} |
}
Verkaufsbelege
Datenstrukturen von Verkaufsbelege
-
| { "VerkaufbelegArt": ... } |
-
| { "VerkaufbelegStatus": ... } |
-
| { "VerkaufbelegDruckstatus": ... } |
-
| { "VerkaufBelegKalkbasis": ... } |
-
| { "VerkaufbelegPositionArt": ... } |
Neu ab 18.3.0
-
| { "VerkaufVorbelegStatus": ... } |
Neu ab 18.3.0
-
| { "VerkaufFolgebelegStatus": ... } |
-
{ | "Suchtext": "..." , | | "Adresse_ID": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "Angebot": ... , | | "AuftragsBestaetigung": ... , | | "Lieferschein": ... , | | "ProformaRechnung": ... , | | "Rechnung": ... , | | "AbschlagsRechnung": ... , | | "KorrekturRechnung": ... , | | "Storno": ... , | | "VerkaufbelegStatus": ... , | | "VerkaufbelegDruckstatus": ... , | | "FestschreibStatus": ... , | | "AuftragsNr": "..." , | | "Referenz": "..." , | | "Betreff": "..." , | | "Anschrift": "..." , | | "KopfText": "..." , | | "FussText": "..." , | | "Waehrung": "..." , | | "Bearbeiter": "..." , | | "Notiz": "..." , | | "EtikettTag_Ohne": ... , | | "EtikettTag_1": ... , | | "EtikettTag_2": ... , | | "EtikettTag_3": ... , | | "EtikettTag_4": ... , | | "EtikettTag_5": ... , | | "EtikettTag_6": ... , | | "EtikettTag_7": ... , | | "MitVorbelege": ... , | | "MitFolgebelege": ... , | | "Zahlungstatus": ... , | | "Versandnummer": "..." , | | "VorbelegStatus": ..., | | "FolgebelegStatus": ... |
} |
-
{ | "Verkaufbeleg_ID": "..." , | | "Adresse_ID": "..." , | | "AuftragNr": "..." , | | "VerkaufbelegArt": ... , | | "Kunde": "..." , | | "Datum": "..." , | | "Lieferdatum": "..." , | | "GesamtNettoSW": "..." , | | "GesamtBruttoSW": "..." , | | "Projekt_ID": "..." , | | "ProjektNr": "..." |
} |
-
{ | "Verkaufbeleg_ID": "..." , | | "VersionKey": "..." , | | "Adresse_ID": "..." , | | "Ansprechpartner_ID": "..." , | | "AuftragNr": "..." , | | "VerkaufbelegArt": ... , | | "Kunde": "..." , | | "Datum": "..." , | | "Lieferdatum": "..." , | | "GesamtNettoSW": "..." , | | "GesamtBruttoSW": "..." , | | "Projekt_ID": "..." , | | "ProjektNr": "..." , | | "Entwurf": ... , | | "EtikettTag": ..., | | "Zahlungstatus": ... , | | "FestschreibStatus": ... , | | "BestellNr": "..." , | | "Referenz": "..." , | | "RechnAnschrift": "..." , | | "LieferAnschrift": "..." , | | "LaVerwenden": ... , | | "Betreff": "..." , | | "Anrede": "..." , | | "KopfText": "..." , | | "FussText": "..." , | | "Grussformel": "..." , | | "Notizen": "..." , | | "Bearbeiter": "..." , | | "BearbeiterAngeben": ... , | | "Steuergebiet": ... , | | "VKPreisliste_ID": "..." , | | "Waehrung": "..." , | | "GesamtNettoFW": "..." , | | "GesamtBruttoFW": "..." , | | "GesamtRabattFW": "..." , | | "GesamtSteuerFW": "..." , | | "GesamtRabattSW": "..." , | | "GesamtSteuerSW": "..." , | | "Zahlungsbedingungen": "..." , | | "SepaMandatReferenz": "..." , | | "SepaBankeinzug": "..." , | | "Lieferart": "..." , | | "Versandnummer": "..." , | | "VersandURL": "..." , | | "Rabatt": "..." , | | "VorbelegIDList": [...] , | | "AttachmentIDList": [...] , | | "Posten_ID": "..." , | | "VerkaufbelegPositionItemList": { "VerkaufbelegPositionItem": [ {}, ... ] } |
} |
-
{ | "Nummer": "..." , | | "PosNrManuell": "..." , | | "VerkaufbelegPositionArt": ... , | | "Artikel_ID": "..." , | | "ArtikelArt": "..." , | | "ArtikelNr": "..." , | | "Warengruppe": "..." , | | "Menge": ... , | | "Beschreibung": "..." , | | "Bezeichnung": "..." , | | "Einheit": "..." , | | "Kostenstelle": "..." , | | "Rabatt": "..." , | | "Steuersatz": "..." , | | "Ertragskonto": ... , | | "EinzelPreisBruttoFW": "..." , | | "EinzelPreisNettoFW": "..." , | | "GesamtPreisBruttoFW": "..." , | | "GesamtPreisNettoFW": "..." , | | "GesamtGewicht": ... , | | "OSS_Daten": { "OSSDatenItem": {...} } |
} |
-
{ | "Adresse_ID": "..." , | | "Ansprechpartner_ID": "..." , | | "AuftragNr": "..." , | | "VerkaufbelegArt": ... , | | "Entwurf": ... , | | "EtikettTag": ..., | | "Datum": "..." , | | "Lieferdatum": "..." , | | "BestellNr": "..." , | | "Referenz": "..." , | | "Projekt_ID": "..." , | | "RechnAnschrift": "..." , | | "LieferAnschrift": "..." , | | "LaVerwenden": ... , | | "Betreff": "..." , | | "Anrede": "..." , | | "KopfText": "..." , | | "FussText": "..." , | | "Grussformel": "..." , | | "Notizen": "..." , | | "Bearbeiter": "..." , | | "BearbeiterAngeben": ... , | | "Steuergebiet": ... , | | "BerechnungArt": ..., | | "VKPreisliste_ID": "..." , | | "Waehrung": "..." , | | "Zahlungsbedingungen": "..." , | | "SepaMandatReferenz": "..." , | | "SepaBankeinzug": "..." , | | "Lieferart": "..." , | | "Versandnummer": "..." , | | "VersandURL": "..." , | | "Rabatt": "..." , | | "Lagerbuchung": ... , | | "VerkaufVorbeleg_ID": "..." , | | "VerkaufbelegPositionItemList": { "VerkaufbelegPositionAddItem": [ {}, ... ] } |
} |
VerkaufbelegPositionAddItem
Top
Back
-
{ | "Nummer": "..." , | | "PosNrManuell": "..." , | | "VerkaufbelegPositionArt": ... , | | "Artikel_ID": "..." , | | "ArtikelArt": "..." , | | "ArtikelNr": "..." , | | "Warengruppe": "..." , | | "Menge": ... , | | "Beschreibung": "..." , | | "Bezeichnung": "..." , | | "Einheit": "..." , | | "Kostenstelle": "..." , | | "Rabatt": "..." , | | "EinzelPreisBruttoFW": "..." , | | "EinzelPreisNettoFW": "..." , | | "Ertragskonto": ... , | | "OSS_Daten": { "OSSDatenItem": {...} } |
} |
-
{ | "Name": "..." , | | "Dateigroesse": ... , | | "Dateityp": "..." , | | "DatenBASE64": "..." |
} |
Funktionsliste von Verkaufsbelege
verkaufbelegFilterTemplate
Top
Back
Vorlage für Verkaufbeleg-Filter
Dient zur Steuerung von verkaufbelegList.
- Aufruf:
-
{ "verkaufbelegFilterTemplate":""}
- Rückgabe:
-
{ "verkaufbelegFilterTemplateResponse":
{ | "ReturnData": { "VerkaufbelegFilter": {...} } |
} |
}
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": ... |
} |
}
- Rückgabe:
-
{ "verkaufbelegListResponse":
{ | "ReturnData": { "VerkaufbelegListitem": [ {}, ... ] } |
} |
}
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":}
- Rückgabe:
-
{ "verkaufbelegGetResponse":
{ | "ReturnData": { "VerkaufbelegItem": {...} } |
} |
}
modifiziert vorhandenen, nicht weitergeleiteten Verkaufbeleg
Ablauf:
1. Struktur VerkaufbelegItem über verkaufbelegGet abrufen.Es wird ein gültiger VersionKey geliefert.
2. Daten von VerkaufbelegItem bei Bedarf anpassen.
3. Funktion verkaufbelegModify ausführen.
Es wird ein Status über Erfolg/Fehler der Operation zurückgeliefert.
Hinweis: Es sind nicht alle Daten über verkaufbelegModify modifizierbar, sondern nur die, welche nicht als READONLY deklariert sind.
Bei festgeschriebenen bzw. als gedruckt markierten Belegen können nur noch die Notizen geändert werden.
Es sollten nur die Parameter übergeben werden, welche auch geändert werden sollen. Alle anderen sollten aus VerkaufbelegItem entfernt werden.
Beispielaufruf Änderung Notizen (Verkaufbeleg_ID,VersionKey beispielhaft)
{
"verkaufbelegModify":{
"VerkaufbelegItem":{
"Verkaufbeleg_ID":"481A62479DF4207DB23598B6461308",
"VersionKey":"99276D86013D6FE47EFB22572D96B63624",
"Notizen":"Text für Notizen"
}
}
}
- Aufruf:
-
{ "verkaufbelegModify":}
- Rückgabe:
-
{ "verkaufbelegModifyResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
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": ... , | | "Adresse_ID": "..." , | | "VKPreisliste_ID": "..." , | | "ArtikelAddPostenList": { "ArtikelAddPosten": [ {}, ... ] } |
} |
}
- Rückgabe:
-
{ "verkaufbelegTemplateResponse":
{ | "ReturnData": { "VerkaufbelegAddItem": {...} } |
} |
}
verkaufbelegDuplikatTemplate
Top
Back
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": "..." , | | "Adresse_ID": "..." |
} |
}
- Rückgabe:
-
{ "verkaufbelegDuplikatTemplateResponse":
{ | "ReturnData": { "VerkaufbelegAddItem": {...} } |
} |
}
verkaufbelegWeiterleitungTemplate
Top
Back
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": "..." , | | "VerkaufbelegArt": ... |
} |
}
- Rückgabe:
-
{ "verkaufbelegWeiterleitungTemplateResponse":
{ | "ReturnData": { "VerkaufbelegAddItem": {...} } |
} |
}
verkaufbelegPositionTemplate
Top
Back
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": "..." , | | "Adresse_ID": "..." , | | "VKPreisliste_ID": "..." , | | "Artikelmenge": ... |
} |
}
- Rückgabe:
-
{ "verkaufbelegPositionTemplateResponse":
{ | "ReturnData": { "VerkaufbelegPositionAddItem": {...} } |
} |
}
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": {...} } |
} |
}
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.
Ab Version 18.4 wird das One Stop Shop - Verfahren (OSS) unterstützt. Voraussetzung ist, das dem Erlöskonto ein OSS-Steuersatz zugewiesen wurde.
Bei Verwendung eines solchen Erlöskontos können den Belegpositionen landesspezifische Steuerdaten zugewiesen werden.
- Aufruf:
-
{ "verkaufbelegAdd":
{ | "VerkaufbelegAddItem": ... |
} |
}
- Rückgabe:
-
{ "verkaufbelegAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
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": {...} } |
} |
}
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":}
- Rückgabe:
-
{ "verkaufbelegDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
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": "..." , | | "AttachmentAddItem": ... |
} |
}
- Rückgabe:
-
{ "verkaufbelegAddAttachmentResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
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": "..." , | | "DruckformularName": "..." , | | "MarkAsPrinted": ... , | | "UseOldPDF": ... |
} |
}
- Rückgabe:
-
{ "verkaufbelegPrintPDFResponse":
{ | "ReturnData": { "VerkaufbelegPrintItem": {...} } |
} |
}
Einkaufsbelege
Datenstrukturen von Einkaufsbelege
-
| { "EinkaufbelegArt": ... } |
-
| { "EinkaufbelegStatus": ... } |
-
| { "EinkaufbelegDruckstatus": ... } |
-
| { "EinkaufBelegKalkbasis": ... } |
-
| { "EinkaufbelegPositionArt": ... } |
-
{ | "Suchtext": "..." , | | "Adresse_ID": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "Bestellanfrage": ... , | | "Bestellung": ... , | | "Wareneingang": ... , | | "Ruecksendung": ... , | | "Eingangsrechnung": ... , | | "Lieferantengutschrift": ... , | | "Storno": ... , | | "EinkaufbelegStatus": ... , | | "EinkaufbelegDruckstatus": ... , | | "FestschreibStatus": ... , | | "BestellNr": "..." , | | "Betreff": "..." , | | "Anschrift": "..." , | | "KopfText": "..." , | | "FussText": "..." , | | "Waehrung": "..." , | | "Bearbeiter": "..." , | | "Notiz": "..." , | | "EtikettTag_Ohne": ... , | | "EtikettTag_1": ... , | | "EtikettTag_2": ... , | | "EtikettTag_3": ... , | | "EtikettTag_4": ... , | | "EtikettTag_5": ... , | | "EtikettTag_6": ... , | | "EtikettTag_7": ... , | | "MitVorbelege": ... , | | "MitFolgebelege": ... , | | "Zahlungstatus": ... , | | "Versandnummer": "..." , | | "VorbelegStatus": ..., | | "FolgebelegStatus": |
} |
-
{ | "Einkaufbeleg_ID": "..." , | | "Adresse_ID": "..." , | | "BestellNr": "..." , | | "EinkaufbelegArt": ... , | | "Kunde": "..." , | | "Datum": "..." , | | "Lieferdatum": "..." , | | "GesamtNettoFW": "..." , | | "GesamtBruttoFW": "..." , | | "Projekt_ID": "..." , | | "ProjektNr": "..." |
} |
-
{ | "Einkaufbeleg_ID": "..." , | | "VersionKey": "..." , | | "Adresse_ID": "..." , | | "Ansprechpartner_ID": "..." , | | "BestellNr": "..." , | | "EinkaufbelegArt": ... , | | "Kunde": "..." , | | "Datum": "..." , | | "Lieferdatum": "..." , | | "GesamtNettoFW": "..." , | | "GesamtBruttoFW": "..." , | | "Projekt_ID": "..." , | | "ProjektNr": "..." , | | "Entwurf": ... , | | "EtikettTag": ..., | | "Zahlungstatus": ... , | | "FestschreibStatus": ... , | | "LieferNr": "..." , | | "Referenz": "..." , | | "RechnAnschrift": "..." , | | "LieferAnschrift": "..." , | | "LaVerwenden": ... , | | "Betreff": "..." , | | "Anrede": "..." , | | "KopfText": "..." , | | "FussText": "..." , | | "Grussformel": "..." , | | "Notizen": "..." , | | "Bearbeiter": "..." , | | "BearbeiterAngeben": ... , | | "Waehrung": "..." , | | "Steuergebiet": ... , | | "GesamtRabattFW": "..." , | | "GesamtSteuerFW": "..." , | | "GesamtRabattSW": "..." , | | "GesamtSteuerSW": "..." , | | "Zahlungsbedingungen": "..." , | | "Lieferart": "..." , | | "Versandnummer": "..." , | | "VersandURL": "..." , | | "Rabatt": "..." , | | "VorbelegIDList": [...] , | | "AttachmentIDList": [...] , | | "EinkaufbelegPositionItemList": { "EinkaufbelegPositionItem": [ {}, ... ] } |
} |
-
{ | "Nummer": "..." , | | "PosNrManuell": "..." , | | "EinkaufbelegPositionArt": ... , | | "Artikel_ID": "..." , | | "ArtikelArt": "..." , | | "ArtikelNr": "..." , | | "Warengruppe": "..." , | | "Menge": ... , | | "Beschreibung": "..." , | | "Bezeichnung": "..." , | | "Einheit": "..." , | | "Kostenstelle": "..." , | | "Rabatt": "..." , | | "Steuersatz": "..." , | | "Aufwandskonto": ... , | | "EinzelPreisBruttoFW": "..." , | | "EinzelPreisNettoFW": "..." , | | "GesamtPreisBruttoFW": "..." , | | "GesamtPreisNettoFW": "..." , | | "EinzelPreisNettoSW": "..." , | | "EinzelPreisBruttoSW": "..." , | | "GesamtPreisBruttoSW": "..." , | | "GesamtPreisNettoSW": "..." , | | "GesamtGewicht": ... , | | "VorbelegBestellNr": "..." , | | "VorbelegEinkaufbeleg_ID": "..." |
} |
-
{ | "Adresse_ID": "..." , | | "Ansprechpartner_ID": "..." , | | "BestellNr": "..." , | | "EinkaufbelegArt": ... , | | "Entwurf": ... , | | "EtikettTag": ..., | | "Datum": "..." , | | "Lieferdatum": "..." , | | "Projekt_ID": "..." , | | "RechnAnschrift": "..." , | | "LieferAnschrift": "..." , | | "LaVerwenden": ... , | | "Betreff": "..." , | | "Anrede": "..." , | | "KopfText": "..." , | | "FussText": "..." , | | "Grussformel": "..." , | | "Notizen": "..." , | | "Bearbeiter": "..." , | | "BearbeiterAngeben": ... , | | "Waehrung": "..." , | | "Steuergebiet": ... , | | "BerechnungArt": ..., | | "Zahlungsbedingungen": "..." , | | "Lieferart": "..." , | | "Versandnummer": "..." , | | "VersandURL": "..." , | | "Rabatt": "..." , | | "LieferNr": "..." , | | "Referenz": "..." , | | "Lagerbuchung": ... , | | "EinkaufVorbeleg_ID": "..." , | | "EinkaufbelegPositionItemList": { "EinkaufbelegPositionAddItem": [ {}, ... ] } |
} |
EinkaufbelegPositionAddItem
Top
Back
-
{ | "Nummer": "..." , | | "PosNrManuell": "..." , | | "EinkaufbelegPositionArt": ... , | | "Artikel_ID": "..." , | | "ArtikelArt": "..." , | | "ArtikelNr": "..." , | | "Warengruppe": "..." , | | "Menge": ... , | | "Beschreibung": "..." , | | "Bezeichnung": "..." , | | "Einheit": "..." , | | "Kostenstelle": "..." , | | "Rabatt": "..." , | | "EinzelPreisBruttoFW": "..." , | | "EinzelPreisNettoFW": "..." , | | "Aufwandskonto": ... , | | "EinkaufVorbelegPosition_ID": "..." |
} |
-
{ | "Name": "..." , | | "Dateigroesse": ... , | | "Dateityp": "..." , | | "DatenBASE64": "..." |
} |
Funktionsliste von Einkaufsbelege
einkaufbelegFilterTemplate
Top
Back
Vorlage für Einkaufbeleg-Filter
- Aufruf:
-
{ "einkaufbelegFilterTemplate":""}
- Rückgabe:
-
{ "einkaufbelegFilterTemplateResponse":
{ | "ReturnData": { "EinkaufbelegFilter": {...} } |
} |
}
Auflistung Einkaufbelege
- Aufruf:
-
{ "einkaufbelegList":
{ | "EinkaufbelegFilter": ... |
} |
}
- Rückgabe:
-
{ "einkaufbelegListResponse":
{ | "ReturnData": { "EinkaufbelegListitem": [ {}, ... ] } |
} |
}
Liefert Details eines Einkaufbeleg
- Aufruf:
-
{ "einkaufbelegGet":}
- Rückgabe:
-
{ "einkaufbelegGetResponse":
{ | "ReturnData": { "EinkaufbelegItem": {...} } |
} |
}
modifiziert vorhandenen, nicht weitergeleiteten Einkaufbeleg
- Aufruf:
-
{ "einkaufbelegModify":}
- Rückgabe:
-
{ "einkaufbelegModifyResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
liefert EinkaufbelegAddItem als Vorlage
- Aufruf:
-
{ "einkaufbelegTemplate":
{ | "EinkaufbelegArt": ... , | | "Adresse_ID": "..." , | | "ArtikelAddPostenList": { "ArtikelAddPosten": [ {}, ... ] } |
} |
}
- Rückgabe:
-
{ "einkaufbelegTemplateResponse":
{ | "ReturnData": { "EinkaufbelegAddItem": {...} } |
} |
}
einkaufbelegDuplikatTemplate
Top
Back
Vorlage für einen duplizierten Einkaufbeleg
- Aufruf:
-
{ "einkaufbelegDuplikatTemplate":
{ | "Einkaufbeleg_ID": "..." , | | "Adresse_ID": "..." |
} |
}
- Rückgabe:
-
{ "einkaufbelegDuplikatTemplateResponse":
{ | "ReturnData": { "EinkaufbelegAddItem": {...} } |
} |
}
einkaufbelegWeiterleitungTemplate
Top
Back
Vorlage für einen weitergeleiteten Einkaufbeleg
- Aufruf:
-
{ "einkaufbelegWeiterleitungTemplate":
{ | "Einkaufbeleg_ID": "..." , | | "EinkaufbelegArt": ... |
} |
}
- Rückgabe:
-
{ "einkaufbelegWeiterleitungTemplateResponse":
{ | "ReturnData": { "EinkaufbelegAddItem": {...} } |
} |
}
einkaufbelegPositionTemplate
Top
Back
liefert EinkaufbelegPositionAddItem als Vorlage
- Aufruf:
-
{ "einkaufbelegPositionTemplate":
{ | "Artikel_ID": "..." , | | "Adresse_ID": "..." , | | "Artikelmenge": ... |
} |
}
- Rückgabe:
-
{ "einkaufbelegPositionTemplateResponse":
{ | "ReturnData": { "EinkaufbelegPositionAddItem": {...} } |
} |
}
berechnet einen Einkaufbeleg ohne zu sichern
- Aufruf:
-
{ "einkaufbelegPreview":
{ | "EinkaufbelegAddItem": ... |
} |
}
- Rückgabe:
-
{ "einkaufbelegPreviewResponse":
{ | "ReturnData": { "EinkaufbelegItem": {...} } |
} |
}
fügt einen neuen Einkaufbeleg hinzu
- Aufruf:
-
{ "einkaufbelegAdd":
{ | "EinkaufbelegAddItem": ... |
} |
}
- Rückgabe:
-
{ "einkaufbelegAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
fügt einen weitergeleiteten Einkaufbeleg hinzu
- Aufruf:
-
{ "einkaufbelegWeiterleitung":
{ | "EinkaufbelegAddItem": ... |
} |
}
- Rückgabe:
-
{ "einkaufbelegWeiterleitungResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht einen Einkaufbeleg
- Aufruf:
-
{ "einkaufbelegDelete":}
- Rückgabe:
-
{ "einkaufbelegDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
fügt ein Attachment einem Einkaufbeleg hinzu
- Aufruf:
-
{ "einkaufbelegAddAttachment":
{ | "Einkaufbeleg_ID": "..." , | | "AttachmentAddItem": ... |
} |
}
- Rückgabe:
-
{ "einkaufbelegAddAttachmentResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
liefert einen Einkaufbeleg als PDF
- Aufruf:
-
{ "einkaufbelegPrintPDF":
{ | "Einkaufbeleg_ID": "..." , | | "DruckformularName": "..." , | | "MarkAsPrinted": ... , | | "UseOldPDF": ... |
} |
}
- Rückgabe:
-
{ "einkaufbelegPrintPDFResponse":
{ | "ReturnData": { "EinkaufbelegPrintItem": {...} } |
} |
}
Buchungen
Datenstrukturen von Buchungen
-
{ | "Suchtext": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "FestschreibStatus": ... , | | "BelegNr": "..." , | | "Konto": ... , | | "KontoSoll": ... , | | "KontoHaben": ... |
} |
-
{ | "Buchung_ID": "..." , | | "Datum": "..." , | | "Text": "..." , | | "Status": ..., | | "Summe": "..." , | | "SummeFW": "..." , | | "BelegNr": "..." |
} |
-
{ | "Buchung_ID": "..." , | | "Datum": "..." , | | "Text": "..." , | | "Status": ..., | | "Summe": "..." , | | "SummeFW": "..." , | | "BelegNr": "..." , | | "EingabeDatum": "..." , | | "Referenz": "..." , | | "Notizen": "..." , | | "KontoSoll": ... , | | "KontoHaben": ... , | | "Waehrung": "..." , | | "Kurs": "..." , | | "Steuersatz": "..." , | | "FestschreibStatus": ... , | | "BuchungJournalItemList": { "BuchungJournalItem": [ {}, ... ] } , | | "AttachmentIDList": [...] |
} |
-
{ | "Datum": "..." , | | "Text": "..." , | | "BelegNr": "..." , | | "Referenz": "..." , | | "Notizen": "..." , | | "Waehrung": "..." , | | "Kurs": "..." , | | "BuchungPositionItemList": { "BuchungPositionAddItem": [ {}, ... ] } |
} |
-
{ | "Betrag": "..." , | | "KontoSoll": ... , | | "KontoHaben": ... , | | "Kostenstelle1": "..." , | | "Kostenstelle2": "..." , | | "Steuersatz": "..." , | | "Text": "..." , | | "BuchungBetragBasis": ... , | | "OSS_Daten": { "OSSDatenItem": {...} } |
} |
Neu ab Version 18.1.0
-
{ | "Journalnummer": ... , | | "Konto": ... , | | "Kontobezeichnung": "..." , | | "BetragSoll": "..." , | | "BetragHaben": "..." , | | "Steuersatz": ... , | | "Text": "..." , | | "Kostenstelle1": "..." , | | "Kostenstelle2": "..." , | | "FW_Soll": "..." , | | "FW_Haben": "..." , | | "OSS_Daten": { "OSSDatenItem": {...} } |
} |
Funktionsliste von Buchungen
Vorlage für Buchung-Filter
- Aufruf:
-
{ "buchungFilterTemplate":""}
- Rückgabe:
-
{ "buchungFilterTemplateResponse":
{ | "ReturnData": { "BuchungFilter": {...} } |
} |
}
Listet alle Buchungen
- Aufruf:
-
{ "buchungList":}
- Rückgabe:
-
{ "buchungListResponse":
{ | "ReturnData": { "BuchungListItem": [ {}, ... ] } |
} |
}
Liefert Eigenschaften einer Buchung
- Aufruf:
-
{ "buchungGet":}
- Rückgabe:
-
{ "buchungGetResponse":
{ | "ReturnData": { "BuchungItem": {...} } |
} |
}
liefert BuchungAddItem als Vorlage
- Aufruf:
-
{ "buchungTemplate":}
- Rückgabe:
-
{ "buchungTemplateResponse":
{ | "ReturnData": { "BuchungAddItem": {...} } |
} |
}
fügt neue Buchung hinzu
Hinweis: Standardbuchungen enthalten ein BuchungPositionAddItem
Mehrere BuchungPositionAddItem werden für Splitt-Buchungen verwendet
- Aufruf:
-
{ "buchungAdd":}
- Rückgabe:
-
{ "buchungAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
fügt ein Attachment einer Buchung hinzu
- Aufruf:
-
{ "buchungAddAttachment":
{ | "Buchung_ID": "..." , | | "AttachmentAddItem": ... |
} |
}
- Rückgabe:
-
{ "buchungAddAttachmentResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
Debitoren
Datenstrukturen von Debitoren
-
| { "DebitorenRechnungArt": ... } |
DebitorenRechnungArtAnzeige
Top
Back
-
| { "DebitorenRechnungArtAnzeige": ... } |
-
| { "DebitorenbelegStatus": ... } |
DebitorenRechnungKalkbasis
Top
Back
-
| { "DebitorenRechnungKalkbasis": ... } |
-
{ | "Posten_ID": "..." , | | "Adresse_ID": "..." , | | "RechnungArt": ..., | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Referenz": "..." , | | "Konto": "..." , | | "Brutto": "..." , | | "Bezahlt": "..." , | | "Offen": "..." , | | "Projekt_ID": "..." , | | "ProjektNr": "..." |
} |
-
{ | "Posten_ID": "..." , | | "Adresse_ID": "..." , | | "RechnungArt": ..., | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Referenz": "..." , | | "Konto": "..." , | | "Brutto": "..." , | | "Bezahlt": "..." , | | "Offen": "..." , | | "Projekt_ID": "..." , | | "ProjektNr": "..." , | | "Entwurf": ... , | | "Zahlungsbedingung": "..." , | | "Zahlungsart": ... , | | "TageNetto": ... , | | "TageSkonto": ... , | | "ProzentSkonto": ... , | | "NichtMahnen": ... , | | "FestschreibStatus": ... , | | "Waehrung": "..." , | | "Text": "..." , | | "AttachmentIDList": [...] , | | "DebitorenRechnungPositionItemList": { "DebitorenRechnungPositionItem": [ {}, ... ] } |
} |
DebitorenRechnungPositionItem
Top
Back
-
{ | "Position": ... , | | "Text": "..." , | | "BetragBruttoFW": "..." , | | "BetragBruttoSW": "..." , | | "BetragNettoFW": "..." , | | "BetragNettoSW": "..." , | | "BetragSteuerFW": "..." , | | "BetragSteuerSW": "..." , | | "Ertragskonto": ... , | | "Kostenstelle1": "..." , | | "Kostenstelle2": "..." , | | "Steuersatz": "..." , | | "OSS_Daten": { "OSSDatenItem": {...} } |
} |
-
{ | "Adresse_ID": "..." , | | "Konto": "..." , | | "Datum": "..." , | | "BelegNr": "..." , | | "Text": "..." , | | "Referenz": "..." , | | "Projekt_ID": "..." , | | "Waehrung": "..." , | | "BerechnungArt": ..., | | "Zahlungsbedingung": "..." , | | "Zahlungsart": ... , | | "TageNetto": ... , | | "TageSkonto": ... , | | "ProzentSkonto": ... , | | "NichtMahnen": ... , | | "DebitorenRechnungPositionItemList": { "DebitorenRechnungPositionAddItem": [ {}, ... ] } |
} |
DebitorenRechnungPositionAddItem
Top
Back
-
{ | "Text": "..." , | | "BetragBruttoFW": "..." , | | "BetragNettoFW": "..." , | | "Ertragskonto": ... , | | "Kostenstelle1": "..." , | | "Kostenstelle2": "..." , | | "Steuersatz": "..." , | | "OSS_Daten": { "OSSDatenItem": {...} } |
} |
-
{ | "Adresse_ID": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "Rechnungsart": ..., | | "RechnungsNr": "..." , | | "Text": "..." , | | "Debitorenkonto": ... , | | "Erfolgskonto": ... , | | "Referenz": "..." , | | "FestschreibStatus": ... , | | "DebitorenbelegStatus": ... |
} |
-
{ | "Zahlung_ID": "..." , | | "Adresse_ID": "..." , | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Referenz": "..." , | | "Konto": "..." , | | "Zahlung": "..." , | | "Minderung": "..." |
} |
-
{ | "Zahlung_ID": "..." , | | "Adresse_ID": "..." , | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Referenz": "..." , | | "Konto": "..." , | | "Zahlung": "..." , | | "Minderung": "..." , | | "Zahlungsart": ... , | | "D-Konto": "..." , | | "ZahlungSW": "..." , | | "MinderungSW": "..." , | | "Text": "..." , | | "Waehrung": "..." |
} |
-
{ | "Adresse_ID": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "RechnungsNr": "..." , | | "Text": "..." , | | "Referenz": "..." |
} |
Funktionsliste von Debitoren
debitorenRechnungFilterTemplate
Top
Back
Vorlage für Filter Debitorenrechnungen
- Aufruf:
-
{ "debitorenRechnungFilterTemplate":""}
- Rückgabe:
-
{ "debitorenRechnungFilterTemplateResponse":
{ | "ReturnData": { "DebitorenRechnungFilter": {...} } |
} |
}
Auflistung Debitorenrechnungen
- Aufruf:
-
{ "debitorenRechnungList":
{ | "DebitorenRechnungFilter": ... |
} |
}
- Rückgabe:
-
{ "debitorenRechnungListResponse":
{ | "ReturnData": { "DebitorenRechnungListItem": [ {}, ... ] } |
} |
}
Liefert Details einer Debitorenrechnung
- Aufruf:
-
{ "debitorenRechnungGet":}
- Rückgabe:
-
{ "debitorenRechnungGetResponse":
{ | "ReturnData": { "DebitorenRechnungItem": {...} } |
} |
}
liefert DebitorenRechnungAddItem als Vorlage
- Aufruf:
-
{ "debitorenRechnungTemplate":
{ | "Adresse_ID": "..." , | | "Datum": "..." , | | "PositionenAnzahl": ... |
} |
}
- Rückgabe:
-
{ "debitorenRechnungTemplateResponse":
{ | "ReturnData": { "DebitorenRechnungAddItem": {...} } |
} |
}
berechnet eine neue Debitorenrechnung, ohne speichern
- Aufruf:
-
{ "debitorenRechnungPreview":
{ | "DebitorenRechnungAddItem": ... |
} |
}
- Rückgabe:
-
{ "debitorenRechnungPreviewResponse":
{ | "ReturnData": { "DebitorenRechnungItem": {...} } |
} |
}
fügt eine neue Debitorenrechnung hinzu
- Aufruf:
-
{ "debitorenRechnungAdd":
{ | "DebitorenRechnungAddItem": ... |
} |
}
- Rückgabe:
-
{ "debitorenRechnungAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht eine vorhandene Debitorenrechnung
- Aufruf:
-
{ "debitorenRechnungDelete":}
- Rückgabe:
-
{ "debitorenRechnungDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
debitorenRechnungAddAttachment
Top
Back
fügt ein Attachment einer Debitorenrechnung hinzu
- Aufruf:
-
{ "debitorenRechnungAddAttachment":
{ | "Posten_ID": "..." , | | "AttachmentAddItem": ... |
} |
}
- Rückgabe:
-
{ "debitorenRechnungAddAttachmentResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
debitorenZahlungFilterTemplate
Top
Back
Vorlage für Filter Debitorenzahlungen
- Aufruf:
-
{ "debitorenZahlungFilterTemplate":""}
- Rückgabe:
-
{ "debitorenZahlungFilterTemplateResponse":
{ | "ReturnData": { "DebitorenZahlungFilter": {...} } |
} |
}
Auflistung Debitorenzahlungen
- Aufruf:
-
{ "debitorenZahlungList":
{ | "DebitorenZahlungFilter": ... |
} |
}
- Rückgabe:
-
{ "debitorenZahlungListResponse":
{ | "ReturnData": { "DebitorenZahlungListItem": [ {}, ... ] } |
} |
}
Liefert Details einer Debitorenzahlung
- Aufruf:
-
{ "debitorenZahlungGet":}
- Rückgabe:
-
{ "debitorenZahlungGetResponse":
{ | "ReturnData": { "DebitorenZahlungItem": {...} } |
} |
}
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": "..." , | | "Datum": "..." , | | "Konto": ... , | | "Zahlungsart": ... |
} |
}
- Rückgabe:
-
{ "debitorenZahlungCreateResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht eine vorhandene Debitorenzahlung
- Aufruf:
-
{ "debitorenZahlungDelete":}
- Rückgabe:
-
{ "debitorenZahlungDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
Kreditoren
Datenstrukturen von Kreditoren
-
| { "KreditorenRechnungArt": ... } |
KreditorenRechnungArtAnzeige
Top
Back
-
| { "KreditorenRechnungArtAnzeige": ... } |
KreditorenRechnungKalkbasis
Top
Back
-
| { "KreditorenRechnungKalkbasis": ... } |
KreditorenRechnungListItem
Top
Back
-
{ | "Posten_ID": "..." , | | "Adresse_ID": "..." , | | "RechnungArt": ..., | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Referenz": "..." , | | "Konto": "..." , | | "Brutto": "..." , | | "Bezahlt": "..." , | | "Offen": "..." , | | "Projekt_ID": "..." , | | "ProjektNr": "..." |
} |
-
{ | "Posten_ID": "..." , | | "Adresse_ID": "..." , | | "RechnungArt": ..., | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Referenz": "..." , | | "Konto": "..." , | | "Brutto": "..." , | | "Bezahlt": "..." , | | "Offen": "..." , | | "Projekt_ID": "..." , | | "ProjektNr": "..." , | | "Entwurf": ... , | | "Zahlungsbedingung": "..." , | | "Zahlungsart": ... , | | "TageNetto": ... , | | "TageSkonto": ... , | | "ProzentSkonto": ... , | | "FestschreibStatus": ... , | | "Waehrung": "..." , | | "Text": "..." , | | "AttachmentIDList": [...] , | | "KreditorenRechnungPositionItemList": { "KreditorenRechnungPositionItem": [ {}, ... ] } |
} |
KreditorenRechnungPositionItem
Top
Back
-
{ | "Position": ... , | | "Text": "..." , | | "BetragBruttoFW": "..." , | | "BetragBruttoSW": "..." , | | "BetragNettoFW": "..." , | | "BetragNettoSW": "..." , | | "BetragSteuerFW": "..." , | | "BetragSteuerSW": "..." , | | "Aufwandskonto": ... , | | "Kostenstelle1": "..." , | | "Kostenstelle2": "..." , | | "Steuersatz": "..." |
} |
-
{ | "Adresse_ID": "..." , | | "Konto": ... , | | "Datum": "..." , | | "BelegNr": "..." , | | "Text": "..." , | | "Referenz": "..." , | | "Projekt_ID": "..." , | | "Waehrung": "..." , | | "BerechnungArt": ..., | | "Zahlungsbedingung": "..." , | | "Zahlungsart": ... , | | "TageNetto": ... , | | "TageSkonto": ... , | | "ProzentSkonto": ... , | | "KreditorenRechnungPositionItemList": { "KreditorenRechnungPositionAddItem": [ {}, ... ] } |
} |
KreditorenRechnungPositionAddItem
Top
Back
-
{ | "Text": "..." , | | "BetragBruttoFW": "..." , | | "BetragNettoFW": "..." , | | "Aufwandskonto": ... , | | "Kostenstelle1": "..." , | | "Kostenstelle2": "..." , | | "Steuersatz": "..." |
} |
-
{ | "Adresse_ID": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "Rechnungsart": ..., | | "RechnungsNr": "..." , | | "Text": "..." , | | "Kreditorenkonto": ... , | | "Aufwandkonto": ... , | | "Referenz": "..." , | | "FestschreibStatus": ... , | | "KreditorenbelegStatus": ... |
} |
-
{ | "Zahlung_ID": "..." , | | "Adresse_ID": "..." , | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Referenz": "..." , | | "Konto": "..." , | | "Zahlung": "..." , | | "Minderung": "..." |
} |
-
{ | "Zahlung_ID": "..." , | | "Adresse_ID": "..." , | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Referenz": "..." , | | "Konto": "..." , | | "Zahlung": "..." , | | "Minderung": "..." , | | "Zahlungsart": ... , | | "K-Konto": "..." , | | "ZahlungSW": "..." , | | "MinderungSW": "..." , | | "Text": "..." , | | "Waehrung": "..." |
} |
-
{ | "Adresse_ID": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "RechnungsNr": "..." , | | "Text": "..." , | | "Referenz": "..." |
} |
Funktionsliste von Kreditoren
kreditorenRechnungFilterTemplate
Top
Back
Vorlage für Filter Kreditorenrechnungen
- Aufruf:
-
{ "kreditorenRechnungFilterTemplate":""}
- Rückgabe:
-
{ "kreditorenRechnungFilterTemplateResponse":
{ | "ReturnData": { "KreditorenRechnungFilter": {...} } |
} |
}
Auflistung Kreditorenrechnungen
- Aufruf:
-
{ "kreditorenRechnungList":
{ | "KreditorenRechnungFilter": ... |
} |
}
- Rückgabe:
-
{ "kreditorenRechnungListResponse":
{ | "ReturnData": { "KreditorenRechnungListItem": [ {}, ... ] } |
} |
}
Liefert Details einer Kreditorenrechnung
- Aufruf:
-
{ "kreditorenRechnungGet":}
- Rückgabe:
-
{ "kreditorenRechnungGetResponse":
{ | "ReturnData": { "KreditorenRechnungItem": {...} } |
} |
}
kreditorenRechnungTemplate
Top
Back
liefert KreditorenRechnungAddItem als Vorlage
- Aufruf:
-
{ "kreditorenRechnungTemplate":
{ | "Adresse_ID": "..." , | | "Datum": "..." , | | "PositionenAnzahl": ... |
} |
}
- Rückgabe:
-
{ "kreditorenRechnungTemplateResponse":
{ | "ReturnData": { "KreditorenRechnungAddItem": {...} } |
} |
}
berechnet eine neue Kreditorenrechnung, ohne speichern
- Aufruf:
-
{ "kreditorenRechnungPreview":
{ | "KreditorenRechnungAddItem": ... |
} |
}
- Rückgabe:
-
{ "kreditorenRechnungPreviewResponse":
{ | "ReturnData": { "KreditorenRechnungItem": {...} } |
} |
}
fügt eine neue Kreditorenrechnung hinzu
- Aufruf:
-
{ "kreditorenRechnungAdd":
{ | "KreditorenRechnungAddItem": ... |
} |
}
- Rückgabe:
-
{ "kreditorenRechnungAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht eine vorhandene Kreditorenrechnung
- Aufruf:
-
{ "kreditorenRechnungDelete":}
- Rückgabe:
-
{ "kreditorenRechnungDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
kreditorenRechnungAddAttachment
Top
Back
fügt ein Attachment einer Kreditorenrechnung hinzu
- Aufruf:
-
{ "kreditorenRechnungAddAttachment":
{ | "Posten_ID": "..." , | | "AttachmentAddItem": ... |
} |
}
- Rückgabe:
-
{ "kreditorenRechnungAddAttachmentResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
kreditorenZahlungFilterTemplate
Top
Back
Vorlage für Filter Kreditorenzahlungen
- Aufruf:
-
{ "kreditorenZahlungFilterTemplate":""}
- Rückgabe:
-
{ "kreditorenZahlungFilterTemplateResponse":
{ | "ReturnData": { "KreditorenZahlungFilter": {...} } |
} |
}
Auflistung Kreditorenzahlungen
- Aufruf:
-
{ "kreditorenZahlungList":
{ | "KreditorenZahlungFilter": ... |
} |
}
- Rückgabe:
-
{ "kreditorenZahlungListResponse":
{ | "ReturnData": { "KreditorenZahlungListItem": [ {}, ... ] } |
} |
}
Liefert Details einer Kreditorenzahlung
- Aufruf:
-
{ "kreditorenZahlungGet":}
- Rückgabe:
-
{ "kreditorenZahlungGetResponse":
{ | "ReturnData": { "KreditorenZahlungItem": {...} } |
} |
}
erzeugt Zahlung für Kreditorenrechnung
Es wird für eine vorhandenen Kreditoren-Rechnung eine Zahlung angelegt.
Ablauf:
1. Posten_ID ermitteln für welchen eine Zahlung angelegt werden soll( z.B. über kreditorenRechnungList).
2. Funktion kreditorenZahlungCreate mit Parameter Posten_ID,Datum,Konto,Zahlungsart ausführen.
Es wird eine Zahlung angelegt, Rückgabe InsertID oder Fehlerstatus.
- Aufruf:
-
{ "kreditorenZahlungCreate":
{ | "Posten_ID": "..." , | | "Datum": "..." , | | "Konto": ... , | | "Zahlungsart": ... |
} |
}
- Rückgabe:
-
{ "kreditorenZahlungCreateResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht eine vorhandene Kreditorenzahlung
- Aufruf:
-
{ "kreditorenZahlungDelete":}
- Rückgabe:
-
{ "kreditorenZahlungDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
Offene Posten
Datenstrukturen von Offene Posten
-
| { "OffenePostenArt": ... } |
-
{ | "Posten_ID": "..." , | | "Adresse_ID": "..." , | | "Postenart": ..., | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Konto": ... , | | "Brutto": "..." , | | "Bezahlt": "..." , | | "Offen": "..." |
} |
-
{ | "Posten_ID": "..." , | | "Adresse_ID": "..." , | | "Postenart": ..., | | "Datum": "..." , | | "BelegNr": "..." , | | "Name": "..." , | | "Konto": ... , | | "Brutto": "..." , | | "Bezahlt": "..." , | | "Offen": "..." , | | "Zahlungsart": ... , | | "Waehrung": "..." , | | "Text": "..." , | | "OffenePostenPositionItemList": { "OffenePostenPositionItem": [ {}, ... ] } |
} |
-
{ | "Position": ... , | | "Text": "..." , | | "BetragBruttoFW": "..." , | | "BetragBruttoSW": "..." , | | "BetragNettoFW": "..." , | | "BetragNettoSW": "..." , | | "BetragSteuerFW": "..." , | | "BetragSteuerSW": "..." , | | "EA_Konto": ... , | | "Kostenstelle1": "..." , | | "Kostenstelle2": "..." , | | "Steuersatz": "..." |
} |
-
{ | "Adresse_ID": "..." , | | "Postenart": ..., | | "Konto": "..." , | | "Datum": "..." , | | "OffenePostenPositionItemList": { "OffenePostenPositionAddItem": [ {}, ... ] } |
} |
OffenePostenPositionAddItem
Top
Back
-
{ | "Text": "..." , | | "BetragBruttoFW": "..." , | | "BetragNettoFW": "..." , | | "EA_Konto": ... , | | "Kostenstelle1": "..." , | | "Kostenstelle2": "..." , | | "Steuersatz": "..." |
} |
-
{ | "OpDatum": "..." , | | "BelegNr": "..." , | | "Konto": "..." , | | "Text": "..." , | | "Waehrung": "..." , | | "BetragVon": "..." , | | "BetragBis": "..." , | | "Zahlungsart": ... |
} |
Funktionsliste von Offene Posten
offenePostenFilterTemplate
Top
Back
Vorlage für Offene Posten-Filter
- Aufruf:
-
{ "offenePostenFilterTemplate":""}
- Rückgabe:
-
{ "offenePostenFilterTemplateResponse":
{ | "ReturnData": { "OffenePostenFilter": {...} } |
} |
}
Auflistung offener Posten Debitoren
- Aufruf:
-
{ "offenePostenListDebitoren":
{ | "OffenePostenFilter": ... |
} |
}
- Rückgabe:
-
{ "offenePostenListDebitorenResponse":
{ | "ReturnData": { "OffenePostenListItem": [ {}, ... ] } |
} |
}
offenePostenListKreditoren
Top
Back
Auflistung offener Posten Kreditoren
- Aufruf:
-
{ "offenePostenListKreditoren":
{ | "OffenePostenFilter": ... |
} |
}
- Rückgabe:
-
{ "offenePostenListKreditorenResponse":
{ | "ReturnData": { "OffenePostenListItem": [ {}, ... ] } |
} |
}
Liefert Details eines Posten
- Aufruf:
-
{ "offenePostenGet":}
- Rückgabe:
-
{ "offenePostenGetResponse":
{ | "ReturnData": { "OffenePostenItem": {...} } |
} |
}
Projekte
Diese Modul erlaubt das Auflisten und Abrufen (vorhandener) Projekt. Über Projekte können z.B. Belege für Einkauf/Verkauf organisiert werden.
Zur Verwendung von Projekten ist eine PRO-Lizenz für Monkey Office notwendig.
Ohne PRO-Lizenz lassen sich Datensätze, welche Projekten zugeordnet sind, nicht mehr weiterverarbeiten!
Datenstrukturen von Projekte
-
{ | "Projekt_ID": "..." , | | "ProjektNr": "..." , | | "Bezeichnung": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "ProjektStatus": ... |
} |
-
{ | "Projekt_ID": "..." , | | "ProjektNr": "..." , | | "Bezeichnung": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "ProjektStatus": ... , | | "Beschreibung": "..." , | | "Bearbeiter": "..." , | | "Notizen": "..." , | | "EtikettTag": ..., | | "AttachmentIDList": [...] |
} |
-
{ | "Suchtext": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "ProjektNr": "..." , | | "Bezeichnung": "..." , | | "KeinStatus": ... , | | "Akquise": ... , | | "Beauftragt": ... , | | "Vorbereitung": ... , | | "InArbeit": ... , | | "Abrechnen": ... , | | "Abgeschlossen": ... , | | "Beschreibung": "..." , | | "Bearbeiter": "..." , | | "Notizen": "..." , | | "EtikettTag_Ohne": ... , | | "EtikettTag_1": ... , | | "EtikettTag_2": ... , | | "EtikettTag_3": ... , | | "EtikettTag_4": ... , | | "EtikettTag_5": ... , | | "EtikettTag_6": ... , | | "EtikettTag_7": ... |
} |
Funktionsliste von Projekte
Vorlage für Projekt-Filter
- Aufruf:
-
{ "projektFilterTemplate":""}
- Rückgabe:
-
{ "projektFilterTemplateResponse":
{ | "ReturnData": { "ProjektFilter": {...} } |
} |
}
Listet vorhandene Projekte
- Aufruf:
-
{ "projektList":}
- Rückgabe:
-
{ "projektListResponse":
{ | "ReturnData": { "ProjektListItem": {...} } |
} |
}
Liefert ein Projekt für die ID
- Aufruf:
-
{ "projektGet":}
- Rückgabe:
-
{ "projektGetResponse":
{ | "ReturnData": { "ProjektItem": {...} } |
} |
}
fügt ein Attachment einem Projekt hinzu
- Aufruf:
-
{ "projektAddAttachment":
{ | "Projekt_ID": "..." , | | "AttachmentAddItem": ... |
} |
}
- Rückgabe:
-
{ "projektAddAttachmentResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
Aktivitaet
Diese Modul erlaubt das Auflisten/Anlegen/Modifizieren und Löschen von Aktivitäten. Aktivitäten können mit Projekten bzw Adressen verknüft werden.
Zur Verwendung von Aktivitäten ist eine PRO-Lizenz für Monkey Office notwendig.
Ohne PRO-Lizenz lassen sich Aktivitäten nicht mehr weiterverarbeiten!
Datenstrukturen von Aktivitaet
-
{ | "Aktivitaet_ID": "..." , | | "Projekt_ID": "..." , | | "Adresse_ID": "..." , | | "Ansprechpartner_ID": "..." , | | "AdressMatchCode": "..." , | | "Betreff": "..." , | | "Datum": "..." , | | "AktivitaetArt": ... |
} |
-
{ | "Aktivitaet_ID": "..." , | | "Projekt_ID": "..." , | | "Adresse_ID": "..." , | | "Ansprechpartner_ID": "..." , | | "AdressMatchCode": "..." , | | "Betreff": "..." , | | "Datum": "..." , | | "AktivitaetArt": ... , | | "VersionKey": "..." , | | "ProjektName": "..." , | | "Artbezeichnung": "..." , | | "Beschreibung": "..." , | | "Bearbeiter": "..." |
} |
-
{ | "Suchtext": "..." , | | "Adresse_ID": "..." , | | "DatumVon": "..." , | | "DatumBis": "..." , | | "AdressMatchCode": "..." , | | "ProjektName": "..." , | | "Telefonat": ... , | | "Besuch": ... , | | "E-Mail": ... , | | "Brief": ... , | | "Notiz": ... , | | "Sonstiges": ... , | | "Beschreibung": "..." , | | "Bearbeiter": "..." |
} |
-
{ | "AktivitaetArt": ... , | | "Projekt_ID": "..." , | | "Adresse_ID": "..." , | | "Ansprechpartner_ID": "..." , | | "Datum": "..." , | | "Betreff": "..." , | | "Beschreibung": "..." , | | "Bearbeiter": "..." |
} |
Funktionsliste von Aktivitaet
Vorlage für Aktivität-Filter
- Aufruf:
-
{ "aktivitaetFilterTemplate":""}
- Rückgabe:
-
{ "aktivitaetFilterTemplateResponse":
{ | "ReturnData": { "AktivitaetFilter": {...} } |
} |
}
Listet vorhandene Aktivitäten
- Aufruf:
-
{ "aktivitaetList":}
- Rückgabe:
-
{ "aktivitaetListResponse":
{ | "ReturnData": { "AktivitaetListItem": {...} } |
} |
}
Liefert ein Aktivität für die ID
- Aufruf:
-
{ "aktivitaetGet":}
- Rückgabe:
-
{ "aktivitaetGetResponse":
{ | "ReturnData": { "AktivitaetItem": {...} } |
} |
}
modifiziert vorhandene Aktivität, der Ablauf erfolgt ähnlich dem von Verkaufsbelegen
- Aufruf:
-
{ "aktivitaetModify":}
- Rückgabe:
-
{ "aktivitaetModifyResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
liefert AktivitaetAddItem als Vorlage
- Aufruf:
-
{ "aktivitaetTemplate":""}
- Rückgabe:
-
{ "aktivitaetTemplateResponse":
{ | "ReturnData": { "AktivitaetAddItem": {...} } |
} |
}
fügt ein neues Aktivität hinzu
- Aufruf:
-
{ "aktivitaetAdd":}
- Rückgabe:
-
{ "aktivitaetAddResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
löscht ein vorhandenes Aktivität
- Aufruf:
-
{ "aktivitaetDelete":}
- Rückgabe:
-
{ "aktivitaetDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
Attachment-Verwaltung
Die Zuweisung von Attachments zu Datenobjekten erfolgt in dem jeweilen Modul,z.B über die Funktion verkaufbelegAddAttachment im Modul Verkaufsbelege (siehe dortige Beschreibung). Attachment-Daten werden als Base64-Daten übertragen.
Ab Version 17.0 werden alternativ Links unterstützt. Links verweisen auf Daten, welche durch externe System verwaltet werden.
Über die Attachment-Verwaltung können existierende Attachments aufgelistet und abgerufen werden.
Die SourceID wird je nach Parent-Objekt (AttachmentGruppe) interpretiert (Verkaufsbelege=Verkaufbeleg_ID).
Datenstrukturen von Attachment-Verwaltung
-
| { "AttachmentGruppe": ... } |
-
{ | "DatumVon": "..." , | | "DatumBis": "..." , | | "DatumVonParent": "..." , | | "DatumBisParent": "..." , | | "Bezeichnung": "..." , | | "Name": "..." , | | "Dateityp": "..." , | | "AttachmentGruppe": ... , | | "Notizen": "..." , | | "Link": "..." |
} |
-
{ | "Attachment_ID": "..." , | | "Bezeichnung": "..." , | | "Name": "..." , | | "AttachmentGruppe": ... , | | "SourceID": "..." , | | "Datum": "..." , | | "Dateityp": "..." , | | "Dateigroesse": ... , | | "Link": "..." |
} |
-
{ | "Attachment_ID": "..." , | | "Bezeichnung": "..." , | | "Name": "..." , | | "AttachmentGruppe": ... , | | "SourceID": "..." , | | "Datum": "..." , | | "Dateityp": "..." , | | "Dateigroesse": ... , | | "Link": "..." , | | "Notizen": "..." |
} |
-
{ | "Bezeichnung": "..." , | | "Name": "..." , | | "AttachmentGruppe": ... , | | "Dateigroesse": ... , | | "Datum": "..." , | | "Dateityp": "..." , | | "DatenBASE64": "..." , | | "Link": "..." , | | "Notizen": "..." |
} |
-
{ | "Bezeichnung": "..." , | | "Name": "..." , | | "DatenBASE64": "..." , | | "Link": "..." , | | "Notizen": "..." |
} |
Funktionsliste von Attachment-Verwaltung
Vorlage für Attachment-Filter
- Aufruf:
-
{ "attachmentFilterTemplate":""}
- Rückgabe:
-
{ "attachmentFilterTemplateResponse":
{ | "ReturnData": { "AttachmentFilter": {...} } |
} |
}
listet vorhandenen Attachments
- Aufruf:
-
{ "attachmentList":}
- Rückgabe:
-
{ "attachmentListResponse":
{ | "ReturnData": { "AttachmentListItem": {...} } |
} |
}
Liefert Details eines Attachments
- Aufruf:
-
{ "attachmentGet":}
- Rückgabe:
-
{ "attachmentGetResponse":
{ | "ReturnData": { "AttachmentItem": {...} } |
} |
}
Download Attachment-File. Die Daten des Dokuments sind als Base64 codiert
- Aufruf:
-
{ "attachmentLoad":}
- Rückgabe:
-
{ "attachmentLoadResponse":
{ | "ReturnData": { "AttachmentItemData": {...} } |
} |
}
löscht ein Attachment
- Aufruf:
-
{ "attachmentDelete":}
- Rückgabe:
-
{ "attachmentDeleteResponse":
{ | "ReturnData": { "ReturnStatus": {...} } |
} |
}
API Information
Datenstrukturen von API Information
-
{ | "App_Name": "..." , | | "App_Homepage": "..." , | | "App_Email": "..." , | | "App_MajorVersion": ... , | | "App_MinorVersion": ... , | | "App_BugVersion": ... , | | "App_Build": ... , | | "App_APISchemaVersion": "..." , | | "App_CopyRight": "..." , | | "App_NewVersion": ... |
} |
-
{ | "App_Datenbank": "..." , | | "App_DBSchemaVersion": "..." , | | "Firma_ID": "..." , | | "Benutzer_ID": "..." , | | "User_Name": "..." , | | "UserAccessItemList": { "UserAccessItem": [ {}, ... ] } |
} |
-
{ | "Modul_ID": "..." , | | "ModulName": "..." , | | "Zugriff": ... , | | "Anlegen": ... , | | "Aendern": ... , | | "Loeschen": ... |
} |
Funktionsliste von API Information
Infos zum aktuellenAPI
- Aufruf:
-
{ "apiInfoGet":""}
- Rückgabe:
-
{ "apiInfoGetResponse":
{ | "ReturnData": { "apiInfoItem": {...} } |
} |
}
Infos zur aktuellen Session
- Aufruf:
-
{ "apisessionInfoGet":""}
- Rückgabe:
-
{ "apisessionInfoGetResponse":
{ | "ReturnData": { "apisessionInfoItem": {...} } |
} |
}