IntraSell API: Unterschied zwischen den Versionen
Grigor (Diskussion | Beiträge) (Die Seite wurde neu angelegt: „Die IntraSell API bietet diverse Möglichkeiten IntraSell zu automatisieren: Folgendes ist möglich: # # Nummerierter Listeneintrag # # Nummerierter Listene…“) |
Grigor (Diskussion | Beiträge) |
||
| (Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| − | Die IntraSell API bietet diverse Möglichkeiten IntraSell zu automatisieren | + | Die IntraSell API bietet diverse Möglichkeiten IntraSell zu automatisieren. |
| + | |||
Folgendes ist möglich: | Folgendes ist möglich: | ||
| − | # | + | # Rechnungen auflisten |
| − | # | + | # PDF Dokumente holen. Siehe auch [[PDFExport]] |
| − | # | + | # Artikel Importieren |
| − | + | ||
| − | + | ||
| + | |||
| + | = IntraSell API Docs = | ||
| + | <p>Anleitung</p> | ||
| + | <p>Die API verwendet MQTT Nachrichten für den Datenaustausch. MQTT Kommunikation kann mit jedem beliebigen Tool realisiert werden. Wir empfehlen jedoch den MQTTX Client für Tests.</p> | ||
| + | |||
| + | <pre> | ||
| + | Kommunikation erfolgt über MQTT (Websockets). | ||
| + | Server: <strong>www.griton.net</strong>, Port: <strong>1883</strong> | ||
| + | Datenprotokoll: JSON | ||
| + | Test Client: MQTTX (Link: https://mqttx.app/) | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | <div> | ||
| + | <h2>Rechnungen für Kunde auflisten</h2> | ||
| + | <p>Die Rechnungen für einen Kunden sind erst verfügbar wenn ein Office Mitarbeiter die Rechnung von einem Auftrag erstellt (oder manuell eine Rechnung anlegt). Siehe [[PDFExport]] </p> | ||
| + | <p>Der Request spezifiziert die Kunden Emailadresse, im System werden alle Rechnungen der letzten Kunden mit der Emailadresse aufgelistet.</p> | ||
| + | <p>Im Block Eigenschaften sind die Paketnummer zu finden (können 0 oder mehrere sein).</p> | ||
| + | <p>Die Paketnummer kann ggf. eine Url sein für Tracking. das hängt von der Implementierung ab. </p> | ||
| + | <p>Die Rechnungen enthalten alle Informationen, jedoch die PDF ist mit dem nachfolgenden Request (<strong>$mandant/dokument</strong>) zu holen. </p> | ||
| + | <h3>Request: </h3> | ||
| + | Topic: <strong>$mandant/rechnungen</strong> | ||
| + | <br /> | ||
| + | Request: | ||
| + | <pre>{"KundenEmail": "office@mandant.at"}</pre> | ||
| + | <h3>Response:</h3> | ||
| + | Topic: <strong>$mandant/rechnungen/list</strong> | ||
| + | |||
| + | <br /> | ||
| + | Response: | ||
| + | <pre> | ||
| + | [{ | ||
| + | "Nummer": 2025031060, | ||
| + | "Typ": "AR", | ||
| + | "KundNr": 468165, | ||
| + | "Kunde": { | ||
| + | "Idnr": 468165, | ||
| + | "LandNr": 43, | ||
| + | "Land": null, | ||
| + | "Name": "TONKOV", | ||
| + | "Vorname": "Grigor", | ||
| + | "Firma": "", | ||
| + | "Adresse": "Riedmarkstr. 14", | ||
| + | "PLZ": "4209", | ||
| + | "Ort": "Engerwitzdorf", | ||
| + | "Tel": "06766063036", | ||
| + | "Mobil": null, | ||
| + | "Email": "gt@griton.net", | ||
| + | "Settings": [] | ||
| + | }, | ||
| + | "KundNr2": 5670, | ||
| + | "Lieferadresse": null, | ||
| + | "MitarbeiterNr": 2, | ||
| + | "Mitarbeiter": null, | ||
| + | "Summe": 0.00, | ||
| + | "SummeBrutto": 0.00, | ||
| + | "SummeMWST": 0.00, | ||
| + | "Positionen": [{ | ||
| + | "Id": 3102341, | ||
| + | "Nummer": 2025031060, | ||
| + | "Typ": "AR", | ||
| + | "ArtNr": 1653, | ||
| + | "Artikel": null, | ||
| + | "Stk": 1.00, | ||
| + | "Preis_Netto": 0.0000, | ||
| + | "Preis_Brutto": 0.0000, | ||
| + | "MWST": 0.0000, | ||
| + | "Bezeichnung": "Versandkostenpauschale DE", | ||
| + | "Beschreibung": null, | ||
| + | "MWSTSatz": 0 | ||
| + | }, { | ||
| + | "Id": 3102342, | ||
| + | "Nummer": 2025031060, | ||
| + | "Typ": "AR", | ||
| + | "ArtNr": 328, | ||
| + | "Artikel": null, | ||
| + | "Stk": 1.00, | ||
| + | "Preis_Netto": 0.0000, | ||
| + | "Preis_Brutto": 0.0000, | ||
| + | "MWST": 0.0000, | ||
| + | "Bezeichnung": "TEST", | ||
| + | "Beschreibung": null, | ||
| + | "MWSTSatz": 0 | ||
| + | }, { | ||
| + | "Id": 3102343, | ||
| + | "Nummer": 2025031060, | ||
| + | "Typ": "AR", | ||
| + | "ArtNr": 10007, | ||
| + | "Artikel": null, | ||
| + | "Stk": 2.00, | ||
| + | "Preis_Netto": 0.0000, | ||
| + | "Preis_Brutto": 0.0000, | ||
| + | "MWST": 0.0000, | ||
| + | "Bezeichnung": "Pros Pro BLACKOUT 200 m 1.24", | ||
| + | "Beschreibung": null, | ||
| + | "MWSTSatz": 0 | ||
| + | } | ||
| + | ], | ||
| + | "Datum": "2025-08-12T11:01:16", | ||
| + | "Eigenschaften": null, | ||
| + | "Zustellzeit": null, | ||
| + | "ZustellzeitBestaetigt": null, | ||
| + | "ZahlungsMethode": "paypal@arfaian.com", | ||
| + | "ZahlungsBedingung": "PayPal", | ||
| + | "TransportMethode": "Versand mit GLS", | ||
| + | "Abgeschlossen": true, | ||
| + | "Ausgedruckt": true, | ||
| + | "Bezahlt": false, | ||
| + | "Notiz": "TEST Rechnung - Nicht löschen bitte!", | ||
| + | "Woher": "AU2024031342", | ||
| + | "Wohin": null, | ||
| + | "ExterneReferenz": null, | ||
| + | "Dokumente": [{ | ||
| + | "Id": 6, | ||
| + | "DokumenteName": "Z:\\IntraSell_PDF_AR\\Vorgang_AR2025031060.pdf", | ||
| + | "TabelleName": "buchVorgang", | ||
| + | "FilterString": "AR-2025031060", | ||
| + | "ErstelltAm": null | ||
| + | } | ||
| + | ], | ||
| + | "Eigenschaften": [ | ||
| + | { | ||
| + | "Id": 6127, | ||
| + | "Name": "Paketnummerr", | ||
| + | "Value": "1123234234" | ||
| + | }, | ||
| + | { | ||
| + | "Id": 6128, | ||
| + | "Name": "Paketnummerr", | ||
| + | "Value": "12312312312" | ||
| + | }, | ||
| + | { | ||
| + | "Id": 6129, | ||
| + | "Name": "Paketnummerr", | ||
| + | "Value": "01234567894" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | ] | ||
| + | |||
| + | </pre> | ||
| + | </div> | ||
| + | |||
| + | <div> | ||
| + | <h2>Dokument Base64 (PDF) holen</h2> | ||
| + | <p>Nicht jeder Rechnung hat PDF Dokument. Damit die Kunden eine PDF erhalten ist notwendig in IntraSell die Rechnung als PDF zu speichern und im Vorgang als Dokument abzulegen. </p> | ||
| + | <h3>Request: </h3> | ||
| + | Topic: <strong>$mandant/dokument</strong> | ||
| + | <br /> | ||
| + | Request: | ||
| + | <pre>{"DokumentName": "p:/test.pdf"}</pre> | ||
| + | <h3>Response:</h3> | ||
| + | Topic: <strong>$mandant/dokument/content</strong> | ||
| + | |||
| + | <br /> | ||
| + | Response: | ||
| + | <pre> {"DokumentName":"p:/test.pdf", "DokumentBase64" : "ABCD...."} </pre> | ||
| + | </div> | ||
| + | <p> | ||
| + | PDF Rechnung in IntraSell ersrtellen</p> | ||
| + | <p> | ||
Aktuelle Version vom 12. Februar 2026, 23:00 Uhr
Die IntraSell API bietet diverse Möglichkeiten IntraSell zu automatisieren.
Folgendes ist möglich:
- Rechnungen auflisten
- PDF Dokumente holen. Siehe auch PDFExport
- Artikel Importieren
Inhaltsverzeichnis
IntraSell API Docs
Anleitung
Die API verwendet MQTT Nachrichten für den Datenaustausch. MQTT Kommunikation kann mit jedem beliebigen Tool realisiert werden. Wir empfehlen jedoch den MQTTX Client für Tests.
Kommunikation erfolgt über MQTT (Websockets).
Server: <strong>www.griton.net</strong>, Port: <strong>1883</strong>
Datenprotokoll: JSON
Test Client: MQTTX (Link: https://mqttx.app/)
Rechnungen für Kunde auflisten
Die Rechnungen für einen Kunden sind erst verfügbar wenn ein Office Mitarbeiter die Rechnung von einem Auftrag erstellt (oder manuell eine Rechnung anlegt). Siehe PDFExport
Der Request spezifiziert die Kunden Emailadresse, im System werden alle Rechnungen der letzten Kunden mit der Emailadresse aufgelistet.
Im Block Eigenschaften sind die Paketnummer zu finden (können 0 oder mehrere sein).
Die Paketnummer kann ggf. eine Url sein für Tracking. das hängt von der Implementierung ab.
Die Rechnungen enthalten alle Informationen, jedoch die PDF ist mit dem nachfolgenden Request ($mandant/dokument) zu holen.
Request:
Topic: $mandant/rechnungen
Request:
{"KundenEmail": "office@mandant.at"}
Response:
Topic: $mandant/rechnungen/list
Response:
[{
"Nummer": 2025031060,
"Typ": "AR",
"KundNr": 468165,
"Kunde": {
"Idnr": 468165,
"LandNr": 43,
"Land": null,
"Name": "TONKOV",
"Vorname": "Grigor",
"Firma": "",
"Adresse": "Riedmarkstr. 14",
"PLZ": "4209",
"Ort": "Engerwitzdorf",
"Tel": "06766063036",
"Mobil": null,
"Email": "gt@griton.net",
"Settings": []
},
"KundNr2": 5670,
"Lieferadresse": null,
"MitarbeiterNr": 2,
"Mitarbeiter": null,
"Summe": 0.00,
"SummeBrutto": 0.00,
"SummeMWST": 0.00,
"Positionen": [{
"Id": 3102341,
"Nummer": 2025031060,
"Typ": "AR",
"ArtNr": 1653,
"Artikel": null,
"Stk": 1.00,
"Preis_Netto": 0.0000,
"Preis_Brutto": 0.0000,
"MWST": 0.0000,
"Bezeichnung": "Versandkostenpauschale DE",
"Beschreibung": null,
"MWSTSatz": 0
}, {
"Id": 3102342,
"Nummer": 2025031060,
"Typ": "AR",
"ArtNr": 328,
"Artikel": null,
"Stk": 1.00,
"Preis_Netto": 0.0000,
"Preis_Brutto": 0.0000,
"MWST": 0.0000,
"Bezeichnung": "TEST",
"Beschreibung": null,
"MWSTSatz": 0
}, {
"Id": 3102343,
"Nummer": 2025031060,
"Typ": "AR",
"ArtNr": 10007,
"Artikel": null,
"Stk": 2.00,
"Preis_Netto": 0.0000,
"Preis_Brutto": 0.0000,
"MWST": 0.0000,
"Bezeichnung": "Pros Pro BLACKOUT 200 m 1.24",
"Beschreibung": null,
"MWSTSatz": 0
}
],
"Datum": "2025-08-12T11:01:16",
"Eigenschaften": null,
"Zustellzeit": null,
"ZustellzeitBestaetigt": null,
"ZahlungsMethode": "paypal@arfaian.com",
"ZahlungsBedingung": "PayPal",
"TransportMethode": "Versand mit GLS",
"Abgeschlossen": true,
"Ausgedruckt": true,
"Bezahlt": false,
"Notiz": "TEST Rechnung - Nicht löschen bitte!",
"Woher": "AU2024031342",
"Wohin": null,
"ExterneReferenz": null,
"Dokumente": [{
"Id": 6,
"DokumenteName": "Z:\\IntraSell_PDF_AR\\Vorgang_AR2025031060.pdf",
"TabelleName": "buchVorgang",
"FilterString": "AR-2025031060",
"ErstelltAm": null
}
],
"Eigenschaften": [
{
"Id": 6127,
"Name": "Paketnummerr",
"Value": "1123234234"
},
{
"Id": 6128,
"Name": "Paketnummerr",
"Value": "12312312312"
},
{
"Id": 6129,
"Name": "Paketnummerr",
"Value": "01234567894"
}
]
}
]
Dokument Base64 (PDF) holen
Nicht jeder Rechnung hat PDF Dokument. Damit die Kunden eine PDF erhalten ist notwendig in IntraSell die Rechnung als PDF zu speichern und im Vorgang als Dokument abzulegen.
Request:
Topic: $mandant/dokument
Request:
{"DokumentName": "p:/test.pdf"}
Response:
Topic: $mandant/dokument/content
Response:
{"DokumentName":"p:/test.pdf", "DokumentBase64" : "ABCD...."}
PDF Rechnung in IntraSell ersrtellen