API

Kontakte

Kontakt erstellen

Neue Firma wird erstellt.

m                        | string            |  contacts
method                   | string            |  create_contact
msg                      | object            |  Folgende Werte müssen enthalten sein:
  - type                 | string            |  'Kunde', 'Lieferant', 'Kunde & Lieferant'  
  - title                | string            |   Firmenname
  - tax_id               | string (optional) |   Steuernummer
  - vat_id               | string (optional) |   Umsatzsteuer-ID
  - street               | string            |   Straße
  - street_additional    | string (optional) |   Adresszusatz
  - street_number        | string            |   Hausnummer
  - zip_code             | string            |   Postleitzahl
  - city                 | string            |   Stadt
  - country              | string            |   Land
  - email                | string (optional) |   E-Mail-Adresse
  - phone                | string (optional) |   Telefonnummer
  - mobile               | string (optional) |   Handynummer
  - note                 | string (optional) |   Zusätzliche Information
  - contact_person       | object (optional) |   Kann folgende Werte enthalten:
     - salutation        | string (optional) |   Anrede
     - firstname         | string            |   Vorname
     - lastname          | string            |   Nachname
     - email             | string (optional) |   E-Mail-Adresse
     - phone             | string (optional) |   Telefonnummer

Beispiel Anfrage:
{
  "m":"contacts",
  "method":"create_contact",
  "msg": {
      "type":"Kunde & Lieferant",
      "title":"First Firma GmBH",
      "tax_id":"78549327754",
      "vat_id":"DE999999999",
      "street":"Blumenstraße",
      "street_number":"67",
      "zip_code":"43584",
      "city":"Blumenstadt",
      "country":"Deutschland",
      "email":"test@gmail.com",
      "phone":"673434",
      "mobile":"8735645",
      "note":"Mitarbeiter",
      "contact_person": {
            "salutation":"Herr",
            "firstname":"Dorian",
            "lastname":"Gray",
            "email":"dor@gmail.com",
            "phone":"654788342"
      },
   }
}

Beispiel Antwort:
{
  "src":"server",
  "time":1709019163,
  "module":"contacts",
  "method":"create_contact",
  "msg":"ok",
  "id": "ee7f5cb2-c5b1-4bcb-9985-c18bf66162b5"
}

Mögliche Fehlercodes:
– „Kontakt muss einer von 3 Typen sein: Kunde, Lieferant oder Kunde & Lieferant“
– „Adresse ist unvollständig“
– „Kontaktperson kann nicht ohne Vorname oder Nachname erstellt werden“
– „Firmenname kann nicht leer sein“

SEPA Mandat aktualisieren

Das SEPA Mandat eines Kunden wird hinterlegt/aktualisiert.

Parameter:
m                 | string            | contacts
method            | string            | set_sepa_debit_data
id                | string            | [ID des Kontaktes] 
msg               | object            | Folgende Werte müssen enthalten sein:
 - source         | string (optional) | Modulname der Kontaktquelle und Bezug von "id". 
                                      | Beispiel: Bei einem lexoffice.de Kontakt wird der Modulname "lexoffice" als "source" verwendet. 
                                      | Wenn nicht angegeben, oder leer, wird die ID eines Sticky-Kontaktes erwartet.
 - sepa_name      | string            | Name des Kontoinhabers
 - sepa_iban      | string            | IBAN wird auf Gültigkeit geprüft
 - sepa_bic       | string            | Wert kann leer sein, bei einer "IBAN-Only" Nutzung bei deiner Bank
 - sepa_id        | string            | Mandatsreferenz (Meist gleich der Kundenummer)
 - sepa_date      | string            | Datum Unterschrift Kunde im Format dd.mm.yyy
 - sepa_last_used | string            | Datum letzte Nutzung für SEPA-Lastschrift dd.mm.yyy (leer, wenn noch nie benutzt)
 - sepa_type      | string            | "SEPA Basis-Lastschrift", "SEPA Firmen-Lastschrift", "SEPA Mandat deaktiviert"

Beispiel Anfrage: 
{ 
  "m":"contacts", 
  "method":"set_sepa_debit_data", 
  "id":"40490b91-9016-45de-ba4a-a506285064a0",
  "msg": {
    "source":"lexoffice",
    "sepa_name":"Baebeca Solutions GmbH",
    "sepa_iban":"DE02120300000000202051",
    "sepa_bic":"BYLADEM1001",
    "sepa_id":"10005",
    "sepa_date":"10.03.2021",
    "sepa_last_used":"10.03.2021",
    "sepa_type":"SEPA Basis-Lastschrift"
  }
} 

Beispiel Antwort: 
{ 
  "src":"server", 
  "time":1656968326, 
  "module":"contacts", 
  "method":"set_sepa_debit_data", 
  "msg":"ok", 
  "id":"" 
}

Mögliche Fehlercodes:
- "<field> darf nicht leer sein"
- "<field> hat ein ungültiges Format"
- "<field> muss existieren"
- "Kontakt konnte nicht gefunden werden"

Kundenummer aktualisieren

Die Kundenummer in der angeschlossenen Buchhaltungssoftware wird für einen Kontakt aktualisiert.

Einschränkungen, die beachtet werden müssen:

• Kundenummern müssen zu dem Nummernkreis im jeweiligen externen Buchhaltungstool passen
• Je nach Buchhaltungsmodul müssen gültige Login-Daten in den Moduleinstellungen hinterlegt sein
• Kundenummern können nur für unbebuchte Kontakte (also es darf keine Rechnung für den Kunden existieren) geändert werden

Parameter:
m                  | string            | contacts
method             | string            | update_customer_number
id                 | string            | [ID des Kontaktes] 
msg                | object            | Folgende Werte müssen enthalten sein:
 - source          | string (optional) | Modulname der Kontaktquelle und Bezug von "id". 
                                       | Beispiel: Bei einem lexoffice.de Kontakt wird der Modulname "lexoffice" als "source" verwendet. 
                                       | Wenn nicht angegeben, oder leer, wird die ID eines Sticky-Kontaktes erwartet.
 - customer_number | string            | Neue Kundenummer

Beispiel Anfrage: 
{ 
  "m":"contacts", 
  "method":"update_customer_number", 
  "id":"f8559d8b-52d1-4393-a101-f48f72a177a8",
  "msg": {
    "source":"lexoffice",
    "customer_number":"30889"
  }
} 

Beispiel Antwort: 
{ 
  "src":"server", 
  "time":1656968326, 
  "module":"contacts", 
  "method":"set_sepa_debit_data", 
  "msg":"ok", 
  "id":"" 
}

Mögliche Fehlercodes:
– „<field> darf nicht leer sein“
– „<field> hat ein ungültiges Format“
– „Kontakt konnte nicht gefunden werden“
– „Account in <module> Modul ist nicht verknüpft“
– „Kundenummer konnte nicht aktualisiert werden. (<module> Login gescheitert)“
– „Kundenummer konnte nicht aktualisiert werden“
– „Modul <module> unterstützt kein update_customer_number“