Module endpoint.Auftrag

Auftrag - CASYMIR REST API Standard Endpunkt Auftrag

Methods

Methods

Request GET Auftrag

GET-Request-Field-Definition
GET-Request-Usage
GET-Response-Field-Definition
GET-Response

Request PUT Auftrag

PUT-Request-Field-Definition
PUT-Request-Usage
PUT-Response-Field-Definition
PUT-Response

Request POST Auftrag

POST-Request-Field-Definition
POST-Request-Usage
POST-Request-Usage
POST-Response-Field-Definition
POST-Response

Auftrag-Request-Handler (Internal)

Auftrag (DB, EndUrl, Pattern, Methode, UserName, QueryStr, BodyTable) Endpunkt Handler.


Methods

Methods

Usage:

    GET, PUT, POST

Request GET Auftrag

GET-Request-Field-Definition

Fields:

  • AuftNr varchar(10) -- Auftragsnummer
GET-Request-Usage

Usage:

    GET /www/auftrag/A10021
GET-Response-Field-Definition

Fields:

  • GrundDaten
    • AuftNr varchar(10) -- Auftragsnummer
    • AuftBez varchar(80) -- Auftragsbezeichung
    • AuftBestellNr varchar(36) -- Bestellnummer Fremdsystem
    • AuftBestellRef varchar(60) -- Bestellreferenz
    • AuftBestellT char(20) -- Bestelldatum ISO 8601 (optional)
    • AuftLieferT char(20) -- Lieferdatum ISO 8601 (optional)
    • WaehrAbk char(4) -- Währungsabkürzung
    • AuftKomment varchar(255) -- Auftragskommentar
    • KundBedTyp tinyint -- Zahlungsbedingung Kunde
    • AuftLiefKost money -- Lieferkosten
    • StaoNr int -- Auftragsstandort
    • AuftStatus char(1) -- N: Neu, O: Offen, A: Abgeschlossen, P = Offerte

      -- Adressen es werden immmer die 3 geliefert auch bei Identischen.

  • Adressen
    • KontaktAdr table
    • KontaktAdr.AdrNr int -- CASYMIR Adressnummer
    • KontaktAdr.AdrFirma varchar(36) -- Firmennamen
    • KontaktAdr.AdrFirma2 varchar(36) -- Firmennamen-Zusatz
    • KontaktAdr.AdrVorname varchar(36) --Vorname
    • KontaktAdr.AdrName varchar(36) -- Nachname
    • KontaktAdr.AdrAdresse1 varchar(36) -- Adressfeld 1
    • KontaktAdr.AdrAdresse2 varchar(36) -- Adressfeld 2
    • KontaktAdr.AdrTelex varchar(28) -- Mobilnummer
    • KontaktAdr.AdrTf1 varchar(28) -- Telefonnummer 1
    • KontaktAdr.AdrTf2 varchar(28) -- Telefonnummer 2
    • KontaktAdr.AdrFax varchar(28) -- Faxnummer
    • KontaktAdr.OrtName varchar(48) -- Ortsnamen
    • KontaktAdr.OrtPLZ varchar(10) -- Postleitzahl
    • KontaktAdr.OrtLand varchar(4) -- Land ISO 3166 ALPHA-2
    • KontaktAdr.EmailAdress varchar(255) -- Emailadresse
    • LiefAdr table
    • LiefAdr.AdrNr int -- CASYMIR Adressnummer
    • LiefAdr.AdrFirma varchar(36) -- Firmennamen
    • LiefAdr.AdrFirma2 varchar(36) -- Firmennamen-Zusatz
    • LiefAdr.AdrVorname varchar(36) --Vorname
    • LiefAdr.AdrName varchar(36) -- Nachname
    • LiefAdr.AdrAdresse1 varchar(36) -- Adressfeld 1
    • LiefAdr.AdrAdresse2 varchar(36) -- Adressfeld 2
    • LiefAdr.AdrTelex varchar(28) -- Mobilnummer
    • LiefAdr.AdrTf1 varchar(28) -- Telefonnummer 1
    • LiefAdr.AdrTf2 varchar(28) -- Telefonnummer 2
    • LiefAdr.AdrFax varchar(28) -- Faxnummer
    • LiefAdr.OrtName varchar(48) -- Ortsnamen
    • LiefAdr.OrtPLZ varchar(10) -- Postleitzahl
    • LiefAdr.OrtLand varchar(4) -- Land ISO 3166 ALPHA-2
    • LiefAdr.EmailAdress varchar(255) -- Emailadresse
    • RechAdr table
    • RechAdr.AdrNr int -- CASYMIR Adressnummer
    • RechAdr.AdrFirma varchar(36) -- Firmennamen
    • RechAdr.AdrFirma2 varchar(36) -- Firmennamen-Zusatz
    • RechAdr.AdrVorname varchar(36) --Vorname
    • RechAdr.AdrName varchar(36) -- Nachname
    • RechAdr.AdrAdresse1 varchar(36) -- Adressfeld 1
    • RechAdr.AdrAdresse2 varchar(36) -- Adressfeld 2
    • RechAdr.AdrTelex varchar(28) -- Mobilnummer
    • RechAdr.AdrTf1 varchar(28) -- Telefonnummer 1
    • RechAdr.AdrTf2 varchar(28) -- Telefonnummer 2
    • RechAdr.AdrFax varchar(28) -- Faxnummer
    • RechAdr.OrtName varchar(48) -- Ortsnamen
    • RechAdr.OrtPLZ varchar(10) -- Postleitzahl
    • RechAdr.OrtLand varchar(4) -- Land ISO 3166 ALPHA-2
    • RechAdr.EmailAdress varchar(255) -- Emailadresse

      -- Positionen

  • Positionen
    • PosNr int -- CASYMIR Positionsnummer
    • VisPosNr int -- Ordnungsnummer
    • ArtNr char(15) -- CASYMIR Artikelnummer
    • PosBez varchar(2048) -- Positionsbezeichnung
    • PosAnzBest float -- Anzahl/Menge des bestellten Artikels in GE
    • PosPreisBasis float -- Preisbasis
    • PosPreisEinzel float -- Einzelpreis
    • PosPreisTotal float -- Totalpreis
    • PosPreisWUSTBetrag float -- Steuerwert der Position
    • VPEAnzBest float -- Anzahl/Menge in Verpackungseinheit
    • VPEPreisEinzel float -- Einzelpreis des Verpackungseinheits
    • VPEinheit varchar(30) -- Verpackungseinheit
    • WUSTSatz float -- Prozentsatz des Mehrwertsteuers
    • GRabSatz float -- Prozentsatz des Rabattes
    • GRabBez float -- Bezeichnung des Rabattes

      -- MWSTRekapitulation

  • MWSTRekapitulation -- MWST Rekapitulation des Auftrags/Offerte
    • Abschnitt string -- fix UST-Rekap
    • WaehrAbk char(4) -- Währungsabkürzung
    • PosWUST float -- Steuerwert der Position zusammen geführt auf den Satz
    • PosVSTSZiffer string -- Ziffer des Steuerformulares für den Vorsteuerbetrag
    • PosWUSTSatz float -- Prozentsatz des Mehrwertsteuers
    • PosWUSTBez string -- Bezeichnung des Steuersatzes
    • PosBetragNetto float -- Netto Betrag der Positionen zusammen geführt auf den Satz
    • PosUSTSZiffer string -- Ziffer des Steuerformulares für den Umsatzsteuerbetrag
    • PosWUSTCode string -- Interne Casymir Code
    • PosWUSTKlasse string -- Angaben zum Aufbau der Umsatzsteuererklärung, D Deutsch, C Schweiz, X andere
    • PosUSTUZiffer string -- Ziffer des Steuerformulares für den Umsatzbetrag.
  • Zahlung -- Zusatz Informationen von Zahlungen
    • Bezeichnung varchar(255) -- Bezeichnungs z.B TransID Reservierte Bezeichnungen: Dienstleister und TransID diese werden zur Weiteren zuordnung benötigt und sollten übergeben werden.
    • Wert varchar(200) -- Wert z.B Nummer der TransID
    • Key varchar(12) -- Eindeutige Zuordnung im Auftrag
GET-Response

Usage:

    GET https://casyrest.opag.loc/www/auftrag/70001 HTTP/1.1


{"data": {
   "Positionen":    [
            {
         "PosAnzBest": 10,
         "PosPreisBasis": 1,
         "VisPosNr": 1,
         "PosBez": "Eierlikör 100 ml Flasche",
         "WUSTSatz": 19,
         "ArtNr": "C210",
         "VPEinheit": "",
         "PosNr": 1
      },
            {
         "PosAnzBest": 5,
         "PosPreisBasis": 1,
         "VPEinheit": "",
         "VisPosNr": 2,
         "PosBez": "Zuckerlikör 100 ml Flasche",
         "WUSTSatz": 19,
         "ArtNr": "C213",
         "PosPreisEinzel": 8.7,
         "PosPreisTotal": 43.5,
         "PosNr": 2
      }
   ],
   "Adressen":    {
      "KontaktAdr":       {
         "AdrFirma": "Bauer-Lustig",
         "AdrTf1": "0049 6831 555 54",
         "AdrNr": 146,
         "AdrAdresse2": "Hauptstraße 151",
         "AdrAdresse1": "Heilpraktikerin",
         "ISOLandA2": "DE",
         "OrtLand": "D",
         "OrtName": "Schwalbach",
         "AdrVorname": "Frau Dipl. Ing.",
         "AdrName": "Lelia",
         "OrtPLZ": "66773"
      },
      "LiefAdr":       {
         "AdrFirma": "Bauer-Lustig",
         "AdrTf1": "0049 6831 555 54",
         "AdrNr": 146,
         "AdrAdresse2": "Hauptstraße 151",
         "AdrAdresse1": "Heilpraktikerin",
         "ISOLandA2": "DE",
         "OrtLand": "D",
         "OrtName": "Schwalbach",
         "AdrVorname": "Frau Dipl. Ing.",
         "AdrName": "Lelia",
         "OrtPLZ": "66773"
      },
      "RechAdr":       {
         "AdrFirma": "Bauer-Lustig",
         "AdrTf1": "0049 6831 555 54",
         "AdrNr": 146,
         "AdrAdresse2": "Hauptstraße 151",
         "AdrAdresse1": "Heilpraktikerin",
         "ISOLandA2": "DE",
         "OrtLand": "D",
         "OrtName": "Schwalbach",
         "AdrVorname": "Frau Dipl. Ing.",
         "AdrName": "Lelia",
         "OrtPLZ": "66773"
      }
   },
   "GrundDaten":    {
      "StaoNr": 1,
      "KundNr": "100075",
      "WaehrAbk": "CHF",
      "AuftLiefKost": 0,
      "AuftBestellTUTC": "2022-07-21T00:00:00Z",
      "AuftLieferTUTC": "2023-08-26T13:30:00",
      "KundBedTyp": 2,
      "AuftStatus": "O",
      "AuftBez": "Shop Import: 10180",
      "AuftBestellRef": "",
      "AuftKomment": "",
      "AuftNr": "10180"
   }
}}

Request PUT Auftrag

Umsetzen von Template Offerten (Ohne KundenNr) zu Kunden ist nur möglich wenn die Preisliste, KTNr WUSTCode und Währung passend ist.

Usage:

PUT /www/auftrag
PUT-Request-Field-Definition
Setzt eine Offerte zu einen Auftrag um

Fields:

  • GrundDaten table
  • KundNr char(8) -- CASYMIR Kundennummer
  • OffertNr varchar(10) -- Offerten Nummer
  • Zahlung table -- Zahlungs Informationen (optional)
  • Bezeichnung varchar(255) -- Bezeichnungs z.B TransID (optional)
  • Wert varchar(200) -- Wert z.B Nummer der TransID Anmerkung: Bezeichnung: payment_method erwartet wenn Wert der Zahlmethode z.b twi Um eine Eundeutige Zuordnung Zahlung zu ermöglichen. (optional)
PUT-Request-Usage

Usage:

    PUT https://casyrest.opag.loc/www/auftrag HTTP/1.1

{
	"GrundDaten" : {
		"KundNr": "100075",
		"OffertNr": "10212"
	},
 "Zahlung": [{
   "Bezeichnung": "TransID",
   "Wert": "FGDD456874645SADSA"
   },
   {
   "Bezeichnung": "Gutschein",
   "Wert": "GES-1534AKJS"
   }
 ]
}
PUT-Response-Field-Definition

Fields:

  • AuftNr varchar(10) -- Auftragsnummer
PUT-Response

Usage:

    HTTP/1.1 201 Created
Date: Fri, 26 Aug 2022 13:06:50 GMT
Server: Apache/2.4.6 (Red Hat Enterprise Linux) OpenSSL/1.0.2k-fips mod_fcgid/2.3.9 PHP/5.4.16
Connection: close
Cache-Control: no-store
Content-MD5: ZDM5MDAyMzNlOWQ4OTZkYmVmMzYyM2I4NjI2NmM4ZjE=
Content-Length: 52
Content-Type: application/json; charset=iso-8859-1

{"count":1,"success":true,"data":{"AuftNr":"10209"}}

Request POST Auftrag

Usage:

POST /www/auftrag
POST-Request-Field-Definition
Das Objekt Adressen ist optional

Fields:

  • GrundDaten
    • KundNr char(8) -- CASYMIR Kundennummer
    • AuftBestellNr varchar(36) -- Bestellnummer Fremdsystem (optional)
    • AuftBez varchar(80) -- Auftragsbezeichung (optional)
    • AuftBestellRef varchar(60) -- Bestellreferenz (optional)
    • AuftBestellT char(20) -- Bestelldatum ISO 8601 (optional)
    • AuftLieferT char(20) -- Lieferdatum ISO 8601 (optional)
    • WaehrAbk char(4) -- Währungsabkürzung Default Leitwährung (optional)
    • AuftKomment varchar(255) -- Auftragskommentar (optional)
    • KTNr char(6) -- Kostentraeger (optional)
    • StaoNr int -- Standort (optional)
    • KundBedTyp tinyint -- Zahlungsbedingung Kunde (optional)
    • AuftLiefKost money -- Lieferkosten (optional)
  • Zahlung -- Zahlungs Informationen
    • Bezeichnung varchar(255) -- Bezeichnungs z.B TransID (optional)
    • Wert varchar(200) -- Wert z.B Nummer der TransID Anmerkung: Bezeichnung: payment_method erwartet wenn Wert der Zahlmethode z.b twi Um eine Eundeutige Zuordnung Zahlung zu ermöglichen. (optional)
  • Adressen
    • ADR table (ADR Ersetzen durch LiefAdr,RechAdr oder KontaktAdr)-- können pro auftrag vom Kunden übersteuert werden (optional)
    • ADR.AdrSprache string -- Sprache des Kunden ISO-639-2B Mapping
    • ADR.EmailAdress varchar(255) -- EmailAdresse (optional)
    • ADR.AdrAdresse1 varchar(60) -- Strasse Hausnummer
    • ADR.AdrAdresse2 varchar(60) -- Zusatz (optional)
    • ADR.AdrAnrede int -- Anrede 0 = Firma/Allgemein, 1 = Herr, 2 = Frau
    • ADR.AdrFax varchar(28) -- Faxnummer (optional)
    • ADR.AdrFirma varchar(36) -- Firmenname es muss AdrFirma oder AdrName angegeben werden (optional)
    • ADR.AdrFirma2 varchar(36) -- Firmennamen zusatz (optional)
    • ADR.AdrVorname varchar(36) --Vorname (optional)
    • ADR.AdrName varchar(36) -- Nachname es muss AdrFirma oder AdrName angegeben werden (optional)
    • ADR.AdrTelex varchar(28) -- Mobilnummer (optional)
    • ADR.AdrTf1 varchar(28) -- Direkt Telefon (optional)
    • ADR.AdrTf2 varchar(28) -- Telefon Zentrale (optional)
    • ADR.OrtLand varchar(4) -- Land ISO 3166 ALPHA-2
    • ADR.OrtName varchar(48) -- Ortsnamen
    • ADR.OrtPLZ varchar(10) -- Postleitzahl
    • ADR.AdrCheck int -- Macht eine Prüfung des Ortsnamen zur Postleitzahl und Korrigiert den OrtsNamen. Default für CH Adressen 1 sonst 0
  • Positionen -- Liste mit Positionen
    • ArtNr char(15) -- CASYMIR Artikelnummer
    • PosBez varchar(2048) -- Positionsbezeichnung (optional)
    • Menge float -- Anzahl/Menge des bestellten Artikels in Grundeinheit
    • Preis float -- Einzelpreis Default wird der Preis in Casymir ermittelt beim bearbeiten (optional)
    • VPEinheit varchar(30) -- Verpackungseinheit (optional)
    • GRabSatz float -- Prozentsatz des Rabattes (optional)
POST-Request-Usage

Usage:

    POST https://casyrest.opag.loc/www/auftrag HTTP/1.1

{
  "GrundDaten": {
    "KundNr": "100075",
    "AuftBestellNr": "110011",
    "AuftBestellT": "2022-08-22T00:00:00Z",
    "AuftBestellRef": "-",
    "AuftBez": "REST TestAuftrag 2",
    "WaehrAbk": "CHF"
  },
  "Adressen": {
    "LiefAdr": {
      "AdrName": "Lustig",
      "AdrSprache": "ger",
      "AdrAnrede": 1,
      "AdrVorname": "Bauer",
      "OrtName": "Binningen",
      "AdrAdresse1": "Oberwilerstrasse 56",
      "OrtLand": "CH",
      "OrtPLZ": "4102"
    },
    "KontaktAdr": {
      "AdrName": "Lustig",
      "AdrSprache": "ger",
      "AdrAnrede": 1,
      "AdrVorname": "Bauer",
      "OrtName": "Binningen",
      "AdrAdresse1": "Oberwilerstrasse 56",
      "OrtLand": "CH",
      "OrtPLZ": "4102"
    },
    "RechAdr": {
      "AdrName": "Lustig",
      "AdrSprache": "ger",
      "AdrAnrede": 1,
      "AdrVorname": "Bauer",
      "OrtName": "Binningen",
      "AdrAdresse1": "Oberwilerstrasse 56",
      "OrtLand": "CH",
      "OrtPLZ": "4102"
    }


    },
  "Positionen": [{
      "ArtNr": "C210",
      "PosBez": "Eierlikör 100 ml Flasche",
      "Menge": 10,
      "Preis": 11,
      "GRabSatz": 5
    },
    {
      "ArtNr": "C213",
      "VisPosNr": "2",
      "PosBez": "Zuckerlikör 100 ml Flasche",
      "Menge": 5,
      "Preis": 6
    },
    {
      "ArtNr": "C201",
      "Menge": 5,
      "VPEinheit": "s12",
      "Preis": 3.7
    }
  ],
  "Zahlung": [{
    "Bezeichnung": "TransID",
    "Wert": "FGDD456874645SADSA"
    },
    {
    "Bezeichnung": "Gutschein",
    "Wert": "GES-1534AKJS"
    }
  ]
 }
POST-Request-Usage

Usage:

    POST https://casyrest.opag.loc/www/auftrag HTTP/1.1

{
  "GrundDaten": {
    "KundNr": "100075"
  },
  "Positionen": [
  {
    "ArtNr": "C210",
  	 "Menge": 10
  },
  {
    "ArtNr": "C213",
    "VisPosNr": "2",
    "PosBez": "Zuckerlikör 100 ml Flasche",
    "Menge": 5,
    "Preis": 8.7
  }]
}
POST-Response-Field-Definition

Fields:

  • AuftNr varchar(10) -- Auftragsnummer
POST-Response

Usage:

    HTTP/1.1 201 Create
Date: Fri, 13 May 2022 17:37:23 GMT
Server: Apache/2.4.6 (Red Hat Enterprise Linux) OpenSSL/1.0.2k-fips mod_fcgid/2.3.9 PHP/5.4.16
Connection: close
Cache-Control: no-store
Content-MD5: NGQwMWQwYjc4NWIzMTliM2MwODA5NzExNmU0ODBlMDc=
Content-Length: 27
Content-Type: application/json; charset=iso-8859-1

{"data":{"AuftNr":"10167"}}

Auftrag-Request-Handler (Internal)

Auftrag (DB, EndUrl, Pattern, Methode, UserName, QueryStr, BodyTable)
Endpunkt Handler.

Firmen-Attribut: Einstellbar PHKey verwaltung REST Schnitstelle Ereigniss REST_Auft wird bei POST und PUT ausgelöst

Parameters:

  • DB UserData -- Datenbank Verbindung
  • EndUrl string -- Enthält die Ausgelesene URI aus der Datenbank
  • Pattern string -- Enthält den Patter Teil der URI else nil
  • Methode string -- HTTP Methode
  • UserName string -- Benutzer der Angemeldet wurde
  • QueryStr string -- Orginal String ohne Hex Zeichen
  • BodyTable table -- Request Body

Returns:

    table retBody
generated by LDoc 1.4.6 Last updated 2025-04-02 16:42:07