Skip to content

Latest commit

 

History

History
101 lines (84 loc) · 5.8 KB

company-autocomplete.md

File metadata and controls

101 lines (84 loc) · 5.8 KB

Firmen-Autocomplete

Struktur der Schnittstelle

Die Struktur der API ist hier beschrieben

Methode

Für die Firmen-Autocomplete muss companyAutocomplete als Methode angegeben werden

Eingabeparameter

Feld Erwarteter Wert Pflicht Bedeutung
countryCode String Nein ISO 3166-1 Alpha-2 Code des Landes, siehe Liste der Ländercodes
companyName String Ja Enthält den Firmennamen, nach dem gesucht werden soll

Ausgabefelder

Feld Erwarteter Wert Pflicht Bedeutung
predictions Array Ja Enthält JSON-Objekte mit Korrekturvorschlägen.
predictions.vatId String Ja Enthält die formatierte Umsatzsteuer-ID der zu prüfenden Firma.
predictions.companyStatus String Ja Enthält den Status zur Firma (active, inaktive, unknown)
predictions.companyName String Ja Enthält den Firmennamen zu diesem Vorschlag.
predictions.companyAddress String Ja Enthält die unstrukturierte Firmenadresse zu diesem Vorschlag.
predictions.companyAddressFormatted String Ja Enthält die strukturierte Firmenadresse zu diesem Vorschlag. Wird nur zurückgegeben, wenn die Adresse in strukturierter Form vorliegt
predictions.companyAddressFormatted.streetFull String Ja Enthält die Straße inkl. Hausnummer der strukturierten Firmenadresse zu diesem Vorschlag.
predictions.companyAddressFormatted.street String Ja Enthält den Straßennamen der strukturierten Firmenadresse zu diesem Vorschlag.
predictions.companyAddressFormatted.houseNumber String Ja Enthält die Hausnummer der strukturierten Firmenadresse zu diesem Vorschlag.
predictions.companyAddressFormatted.additionalInfo String Ja Enthält den Adresszusatz der strukturierten Firmenadresse zu diesem Vorschlag.
predictions.companyAddressFormatted.postCode String Ja Enthält die Postleitzahl der strukturierten Firmenadresse zu diesem Vorschlag.
predictions.companyAddressFormatted.cityName String Ja Enthält den Ortsnamen der strukturierten Firmenadresse zu diesem Vorschlag.
predictions.companyAddressFormatted.country String Ja Enthält den Ländercode der strukturierten Firmenadresse zu diesem Vorschlag.
status Array Ja Enthält eine Liste mit Statuscodes, die den geprüften Datensatz beschreiben. Siehe Liste der Statuscodes.

Statuscodes

Code Bedeutung
A1000 Es gibt nur ein Element in der Vorschlagsliste.
A2000 Es gibt mehrere Elemente in der Vorschlagsliste.
A3000 Es wurden keine Elemente für die Vorschlagsliste gefunden.

Beispiele

Beispiel mit Ländercode

Anfrage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "companyAutocomplete",
  "params": {
    "countryCode": "de",
    "companyName": "endereco"
  }
}

Antwort

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "predictions": [
      {
        "vatId": "DE297464149",
        "companyStatus": "active",
        "companyName": "endereco UG (haftungsbeschränkt) Gesellschaft für Master Data Quality Management",
        "companyAddressFull": "Balthasar-Neumann Str. 4b, 97236, Randersacker",
        "companyAddressFormatted": {
          "streetFull": "Balthasar-Neumann Str. 4b",
          "additionalInfo": "",
          "postCode": "97236",
          "cityName": "Randersacker",
          "country": "DE",
          "street": "Balthasar-Neumann Str.",
          "houseNumber": "4b"
        }
      }
    ],
    "status": [
      "A1000",
      "company_single_variant"
    ]
  }
}