Concept Office Rest API - Firmen

Ein Concept Office Kontakt wird primär über die folgenden Datenbanktabellen befüllt:

Domänenbegriff Tabelle Rolle Abhängigkeiten
Firma kontakte Hauptobjekt Kann Anschrift und Hauptansprechpartner direkt enthalten
Anschrift Anschriften Unterobjekt Gehört zu einer Firma über kontaktnummer
Ansprechpartner AnsprechPartner Unterobjekt Gehört zu einer Firma über kontaktnummer
Kontaktmitarbeiter KontaktMitarbeiter Unterobjekt Benötigt Firma und Mitarbeiter
Bankverbindung KontaktBankverbindungen Unterobjekt Benötigt Firma
Firmenbeziehung KontaktKontakte Unterobjekt Benötigt zwei Firmen
Fremdschlüssel Fremdschluessel Unterobjekt Benötigt eine Nummer der Firma

Hinweis: Unterobjekte können erst angelegt werden, wenn die Firma angelegt ist.


kontakte (Hauptobjekt)

Get

  • Mehrere Firmen aufrufen:
    GET /Office/CoServiceRestApi/office/kontakte
  • Ausgewählte Firma aufrufen:
    GET /Office/CoServiceRestApi/office/kontakte/{kontaktNummer}
  • Firma suchen:
    GET /Office/CoServiceRestApi/office/kontakte?q=XXXXX&count=2&skip=0

Post (Pflichtfelder / Beispiel)

Neue Firma anlegen:

POST /Office/CoServiceRestApi/office/kontakte
{
  "kurzname": "Muster GmbH",
  "kundengruppe": "Standard",
  "istkunde": true,
  "istlieferant": false,
  "istinteressent": false,
  "hauptanschrift": {
    "name": "Muster GmbH",
    "strasse": "Musterstrasse 1",
    "postleitzahl": "91093",
    "ort": "Musterstadt"
  },
  "hauptansprechpartner": {
    "nachname": "Mustermann",
    "vorname": "Max"
  }
}

Put

Ausgewählte Firma bearbeiten:

PUT /Office/CoServiceRestApi/office/kontakte/{kontaktNummer}
{
  "kurzname": "Muster GmbH aktualisiert",
  "kundengruppe": "Standard",
  "istkunde": true,
  "hauptanschrift": {
    "name": "Muster GmbH",
    "strasse": "Musterstrasse 2",
    "postleitzahl": "91093",
    "ort": "Musterstadt"
  }
}

Delete

Ausgewählte Firma löschen:

DELETE /Office/CoServiceRestApi/office/kontakte/{kontaktNummer}

KontaktMitarbeiter (Unterobjekt)

Get

  • Kontaktmitarbeiter einer Firma aufrufen:
    GET /Office/CoServiceRestApi/office/kontaktmitarbeiter?q={"KontaktNummer":{"value":"{kontaktNummer}","Operator":"="}}

Post (Pflichtfelder / Beispiel)

Kontaktmitarbeiter zu einer Firma hinzufügen:

POST /Office/CoServiceRestApi/office/kontaktmitarbeiter
{
  "kontaktnummer": 10000,
  "mitarbeiternummer": 999,
  "geschaeftsbereich": "Bueromoebel",
  "isthauptmitarbeiter": false,
  "schutz": false,
  "techniker": true,
  "vertriebsmitarbeiter": true,
  "sachbearbeiter": true
}

KontaktBankverbindungen (Unterobjekt)

Get

  • Bankverbindungen einer Firma aufrufen:
    GET /Office/CoServiceRestApi/office/kontaktbankverbindungen?q={"KontaktNummer":{"value":"{kontaktNummer}","Operator":"="}}

Post (Pflichtfelder / Beispiel)

Bankverbindung zu einer Firma hinzufügen:

POST /Office/CoServiceRestApi/office/kontaktbankverbindungen
{
  "kontaktnummer": 10000,
  "lfdnr": 1,
  "bankinstitut": "Musterbank",
  "bankleitzahl": 12345678,
  "kontonr": 123456789,
  "bic": "MUSTDEFFXXX",
  "iban": "DE00123456781234567890",
  "isthauptbankverbindung": true
}

Firmenbeziehungen (Unterobjekt)

Get

  • Firmenbeziehungen einer Firma anzeigen:
    GET /Office/CoServiceRestApi/office/firmenbeziehungen?q=[{"kontaktnummerzugeordnet":{"value":"{kontaktNummer}","Operator":"="}}]

Post (Pflichtfelder / Beispiel)

Firmenbeziehung zu einer Firma anlegen:

POST /Office/CoServiceRestApi/office/firmenbeziehungen
{
  "mandant": 1,
  "kontaktnummer": 10000,
  "kontaktnummerzugeordnet": 10001,
  "ansprechpartnernummer": 0,
  "apnummerzugeordnet": 0,
  "qualifikation": 400,
  "bemerkung": "Zugeordnete Firma",
  "gueltigvon": null,
  "gueltigbis": null
}

Fremdschluessel (Unterobjekt)

Get

  • Fremdschlüssel einer Firma anzeigen:
    GET /Office/CoServiceRestApi/office/fremdschluessel?q={"nummer":{"value":"{kontaktNummer}","Operator":"="}}

Post (Pflichtfelder / Beispiel)

Fremdschlüssel zu einer Firma hinzufügen:

POST /Office/CoServiceRestApi/office/fremdschluessel
{
  "mappingtype": 1,
  "nummer": "10000",
  "fremdsystem": "ERP",
  "fremdmandant": "01",
  "fremdnummer": "EXT-10000"
}