API-Referenz

Unternehmen

Die Daten Ihres eigenen Unternehmens: Name, Adresse, Sprache und Umsatzsteuer-Einstellungen.

Endpunkte

GET /company Unternehmen abrufen

Unternehmen abrufen

GET /api/v1/company

Die Daten des Unternehmens, zu dem der Schlüssel gehört, mit dem Standard-Steuersatz und ob Preise inklusive Umsatzsteuer sind.

Scope: company.read — Unternehmensdaten lesen

Beispielanfrage

cURL

curl "https://app.klantly.com/api/v1/company" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"

PHP

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('GET', 'company');

$data = json_decode((string) $response->getBody(), true)['data'];

JavaScript

const response = await fetch('https://app.klantly.com/api/v1/company', {
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
  },
});

const { data } = await response.json();

Python

import os

import requests

response = requests.get(
    "https://app.klantly.com/api/v1/company",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
    },
)
data = response.json()["data"]

Antwort 200

Beispielantwort

{
  "data": {
    "object": "company",
    "id": "42",
    "name": "De Vries Bouw",
    "email": "info@devriesbouw.nl",
    "phone": "+31 30 1234567",
    "website": "https://devriesbouw.nl",
    "coc_number": "12345678",
    "vat_number": "NL123456789B01",
    "address": "Industrieweg 5",
    "postal_code": "3542 AD",
    "city": "Utrecht",
    "country": "NL",
    "language": "nl",
    "currency": "EUR",
    "timezone": "Europe/Amsterdam",
    "default_vat_rate": "21.00",
    "prices_include_vat": false
  }
}

Mögliche Fehler

403 insufficient_scope — Dieser API-Schlüssel hat keinen Zugriff auf diese Aktion.

Zusätzlich kann jeder Endpunkt die allgemeinen Fehler zurückgeben, etwa einen ungültigen Schlüssel oder ein erreichtes Limit. Alle Fehlercodes ansehen.

Das Objekt

Alle Felder sind immer vorhanden; ein Feld ohne Wert ist null.

Feld	Typ	Beschreibung
`object`	string	Immer „company“.
`id`	string	ID des Unternehmens.
`name`	string	Name des Unternehmens.
`email`	string	Allgemeine E-Mail-Adresse. kann leer sein (null)
`phone`	string	Telefonnummer. kann leer sein (null)
`website`	string	Website. kann leer sein (null)
`coc_number`	string	Handelsregisternummer. kann leer sein (null)
`vat_number`	string	USt-IdNr. kann leer sein (null)
`address`	string	Straße und Hausnummer. kann leer sein (null)
`postal_code`	string	Postleitzahl. kann leer sein (null)
`city`	string	Ort. kann leer sein (null)
`country`	string	Land als zweistelliger ISO-Code (zum Beispiel DE). kann leer sein (null)
`language`	string	Hauptsprache des Unternehmens. einer von: nl, en, de, fr
`currency`	string	Immer „EUR“.
`timezone`	string	Zeitzone, in der Klantly dem Unternehmen Zeiten anzeigt. Die API gibt Zeiten immer in UTC zurück.
`default_vat_rate`	string	Standard-Steuersatz in Prozent, als Text mit zwei Dezimalstellen.
`prices_include_vat`	boolean	Ob Preise standardmäßig inklusive Umsatzsteuer eingegeben werden.