Module endpoint.Kunden

Kunden - CASYMIR REST API Standard Endpunkt Kunden

Methods

Methods

Request GET Kunden

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

Request POST Kunden

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

Kunden-Request-Handler (Internal)

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


Methods

Methods

Usage:

    GET, POST

Request GET Kunden

GET-Request-Field-Definition

Fields:

  • DebiNr string -- Eindeutige Bezeichnung des Kunden
  • order int -- Liefert die maximale Anzahl der letzten X Bestellungen zurück default 0 (optional)
  • status string -- Liefert nur den angegebenen Planstatus O,N oder A zurück (optional)
GET-Request-Usage
Liefert eine (Liste) von Kundendaten zurück.

Usage:

    GET /www/kunden/{DebiNr}
GET /www/kunden/{DebiNr}?order={order}
GET /www/kunden/{DebiNr}?order={order}&status={status}
GET-Response-Field-Definition

Fields:

  • status int -- gibt den Status des Kunden ob das Kreditlimit >0 ist status = 0 Nein, 1 Ja
  • WaehrAbk char(4) -- Währung des Kunden ISO 4217
  • BrancheID varchar(12) -- Eindeutige Identifikation der Branche
  • AdrSprache string -- Sprache des Kunden ISO-639-2B Mapping
  • KundLief int -- Lieferadresse IDKey
  • KundRech int -- Rechnungsadresse IDKey
  • KundKontakt int -- Kontaktsadresse IDKey
  • attributes table -- Attribute zum Kunden (optional)
  • Contents varchar(200) -- Inhalt
  • PHKey varchar(12) -- Eindeutige Bezeichnung
  • ZahlungsMethode string -- Komma getrennte Liste: K = Kreditkarte Zahlung ausserhalb Casymir, R = Rechnung Bezahlung über Casymir (optional)
  • links table -- Verlinkungen
  • href varchar(2048) -- Verweis
  • type varchar(2048) -- type des Verweis
  • rel varchar(2048) -- relation des Verweis
  • KundBez varchar(24) -- Bezeichnung des Kunden
  • Kommentar varchar(255) -- Kommentar beim Kunden
  • VBTyp varchar(12) -- Versandbedingungstyp
  • Auftrag table -- Auflistung der Vorhanden Aufträge (optional)
  • PlanStatus char(1) -- Der Planstatus bezeichnet den Zustand eines Auftrages, N Neu, O Offen in Bearbeitung, A Abgeschlossen
  • AuftErf string -- Datum der Erfassung des Auftrags
  • AuftNr varchar(10) -- Auftragsnummer
GET-Response

Usage:

    GET /www/kunden/200003?order=10

{"data": {
   "KundLief": 76,
   "WaehrAbk": "CHF",
   "BrancheID": "BAUU",
   "links":    [
            {
         "rel": "adressen",
         "type": "GET",
         "href": "https://casyrest.opag.loc/www/adressen/76"
      },
            {
         "rel": "adressen",
         "type": "GET",
         "href": "https://casyrest.opag.loc/www/adressen/76"
      },
            {
         "rel": "adressen",
         "type": "GET",
         "href": "https://casyrest.opag.loc/www/adressen/76"
      }
   ],
   "AdrSprache": "ger",
   "KundRech": 76,
   "Auftrag":    [
            {
         "links": [         {
            "rel": "auftrag",
            "type": "GET",
            "href": "https://casyrest.opag.loc/www/auftrag/10056"
         }],
         "PlanStatus": "A",
         "AuftErf": "2022-07-21T00:00:00Z",
         "AuftNr": "10056"
      },
            {
         "links": [         {
            "rel": "auftrag",
            "type": "GET",
            "href": "https://casyrest.opag.loc/www/auftrag/10063"
         }],
         "PlanStatus": "A",
         "AuftErf": "2022-07-21T00:00:00Z",
         "AuftNr": "10063"
      },
            {
         "links": [         {
            "rel": "auftrag",
            "type": "GET",
            "href": "https://casyrest.opag.loc/www/auftrag/10084"
         }],
         "PlanStatus": "A",
         "AuftErf": "2022-07-21T00:00:00Z",
         "AuftNr": "10084"
      },
            {
         "links": [         {
            "rel": "auftrag",
            "type": "GET",
            "href": "https://casyrest.opag.loc/www/auftrag/10094"
         }],
         "PlanStatus": "A",
         "AuftErfUTC": "2022-07-21T00:00:00Z",
         "AuftNr": "10094"
      },
            {
         "links": [         {
            "rel": "auftrag",
            "type": "GET",
            "href": "https://casyrest.opag.loc/www/auftrag/10097"
         }],
         "PlanStatus": "O",
         "AuftErf": "2022-07-21T00:00:00Z",
         "AuftNr": "10097"
      },
            {
         "links": [         {
            "rel": "auftrag",
            "type": "GET",
            "href": "https://casyrest.opag.loc/www/auftrag/10112"
         }],
         "PlanStatus": "A",
         "AuftErf": "May 18 2021 12:00:00:000AM",
         "AuftNr": "10112"
      },
            {
         "links": [         {
            "rel": "auftrag",
            "type": "GET",
            "href": "https://casyrest.opag.loc/www/auftrag/10133"
         }],
         "PlanStatus": "O",
         "AuftErf": "Jan 03 2021 12:00:00:000AM",
         "AuftNr": "10133"
      }
   ],
   "KundBez": "Crown Obrist AG",
   "Kommentar": "Kommentar beim Kunden",
   "ZahlungsMethode": "K",
   "status": 1,
   "KundKontakt": 76,
   "attributes":       [
                     {
               "Contents": "AUFT_SPESENG",
               "PHKey": "AUFT_SPESEN"
            },
                     {
               "Contents": "Artikel",
               "PHKey": "RESTWEBSHOP"
            }
         ],
   "VBTyp": "POST"
}}

Request POST Kunden

POST-Request-Field-Definition
Abspeichern von Kundendaten.

Fields:

  • AdrSprache string -- Sprache des Kunden ISO-639-2B Mapping
  • EmailAdress varchar(255) -- EmailAdresse
  • AdrAdresse1 varchar(60) -- Strasse Hausnummer
  • AdrAdresse2 varchar(60) -- Zusatz (optional)
  • AdrAnrede string -- Anrede 0 = Firma/Allgemein, 1 = Herr, 2 = Frau
  • AdrFax varchar(28) -- Faxnummer (optional)
  • AdrFirma varchar(36) -- Firmenname es muss AdrFirma oder AdrName angegeben werden (optional)
  • AdrFirma2 varchar(36) -- Firmennamen zusatz (optional)
  • AdrVorname varchar(36) --Vorname (optional)
  • AdrName varchar(36) -- Nachname es muss AdrFirma oder AdrName angegeben werden (optional)
  • AdrTelex varchar(28) -- Mobilnummer (optional)
  • AdrTf1 varchar(28) -- Direkt Telefon (optional)
  • AdrTf2 varchar(28) -- Telefon Zentrale (optional)
  • OrtLand varchar(4) -- Land ISO 3166 ALPHA-2
  • OrtName varchar(48) -- Ortsnamen
  • OrtPLZ varchar(10) -- Postleitzahl
  • AdrCheck int -- Macht eine Prüfung des Ortsnamen zur Postleitzahl und Korrigiert den OrtsNamen. Default für CH Adressen 1 sonst 0
  • WaehrAbk char(4) -- Währung des Kunden die ISO 4217
  • AUFT_SPESEN varchar(32) -- Spesen Berechnungs Wert (optional)
  • VBTyp varchar(12) -- Versandbedingungstyp, CIF Kosten, Versicherung und Fracht (ID Codes Mandanten spezifisch) (optional)
  • TVTyp varchar(12) -- Transportversicherungstyp, T Versichert - Unversichert (optional)
  • FAKTZahlArt char(1) -- Zahlungs Art L = Lastschrift, B= Bar/Kreditkarte andere
  • Kommentar varchar(255) -- Kommentar welcher beim Kunden eingetragen wird (optional)
  • SteuerNummer varchar(20) --Steuernummer (optional)
  • FirmenURL varchar(20) -- URL der Firma (optional)
  • KreditLimit int -- KreditLimit 0 = gespeert default 0 (optional)
  • ZahlungsMethode string -- Komma getrennte Liste: K = Kreditkarte Zahlung ausserhalb Casymir, R = Rechnung Bezahlung über Casymir (optional)
  • KontaktAdr table -- Adresse für Kontakt
  • LiefAdr table -- Adresse für Lieferung default KontaktAdr (optional)
  • RechAdr table -- Adresse für Rechnung default KontaktAdr (optional)
POST-Request-Usage

Usage:

  • POST /www/kunden

{
 "GrundDaten" : {
   "WaehrAbk" : "CHF",
   "VBTyp" : "CIF",
   "TVTyp" : "T",
   "FAKTZahlArt" : "B",
   "SteuerNummer" : "12345678910",
   "Kommentar" : "Kommentar am Kunden",
   "FirmenURL" : "www.muster.ch",
   "KreditLimit" : 200,
   "ZahlungsMethode" : "K",
   "AUFT_SPESEN" : "WEBSHOP"
	},
	"Adressen" : {
   "KontaktAdr" : {
     "AdrSprache" : "ger",
     "AdrFirma" : "Muster Firma AG",
     "AdrFirma2" : "Zweigstelle",
     "AdrAnrede" : 0,
     "AdrAdresse1" : "Musterweg 22",
     "AdrTelex" : "079 100 100 1001",
     "AdrTf1" : "063 444 444 444",
     "OrtLand" : "CH",
     "OrtPLZ" : "4001",
     "OrtName" : "Basel",
     "EmailAdress" : "Muster@Firma.ch"
   },
   "LiefAdr" : {
     "AdrSprache" : "ger",
     "AdrAnrede" : 3,
     "AdrVorname" : "Maria",
     "AdrName" : "Muster",
     "AdrAdresse1" : "Blauenweg 22",
     "OrtLand" : "CH",
     "OrtPLZ" : "4001",
     "OrtName" : "Basel",
     "EmailAdress" : "Muster@firma.ch"
   },
   "RechAdr" : {
     "AdrSprache" : "ger",
     "AdrAnrede" : 1,
     "AdrName" : "Muster",
     "AdrAdresse1" : "Musterweg 22",
     "AdrAdresse2" : "1.OG",
     "AdrFax" : "0123 132155",
     "AdrTelex" : "0123 23135",
     "AdrTf1" : "0134567789",
     "OrtLand" : "CH",
     "OrtPLZ" : "4001",
     "OrtName" : "Basel",
     "EmailAdress" : "Max@muster.ch"
   }
	}
}  
  • POST /www/kunden
Minimal
{
  "GrundDaten" : {
    "WaehrAbk" : "CHF",
    "FAKTZahlArt" : "B"
  },
"Adressen" : {
  "KontaktAdr" : {
    "AdrSprache" : "ger",
    "AdrFirma" : "Muster Firma AG",
    "AdrAnrede" : 0,
    "AdrAdresse1" : "Musterweg 22",
    "OrtLand" : "CH",
    "OrtPLZ" : "4001",
    "OrtName" : "Basel"
  }
 }
}
POST-Response-Field-Definition

Fields:

  • DebiNr string -- Eindeutige ID des Kunden
POST-Response

Usage:

    HTTP/1.1 201 Create
{"data": {
   "DebiNr" : "123456"
  }
}

Kunden-Request-Handler (Internal)

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

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

Parameters:

  • DB UserData -- Datenbank Verbindung
  • EndUrl string -- Enthüllt die Ausgelesene URI aus der Datenbank
  • Pattern string -- Enthüllt 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 2024-11-23 10:47:21