API-referentie

Bedrijf

De gegevens van je eigen bedrijf: naam, adres, taal en btw-instellingen.

Endpoints

GET /company Bedrijf ophalen

Bedrijf ophalen

GET /api/v1/company

De gegevens van het bedrijf waar de sleutel bij hoort, met de standaard-btw en of prijzen inclusief btw zijn.

Scope: company.read — Bedrijfsgegevens lezen

Voorbeeldverzoek

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"]

Antwoord 200

Voorbeeldantwoord

{
  "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
  }
}

Mogelijke fouten

403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Het object

Alle velden zijn altijd aanwezig; een veld zonder waarde is null.

Veld	Type	Omschrijving
`object`	string	Altijd "company".
`id`	string	Id van het bedrijf.
`name`	string	Bedrijfsnaam.
`email`	string	Algemeen e-mailadres. kan leeg zijn (null)
`phone`	string	Telefoonnummer. kan leeg zijn (null)
`website`	string	Website. kan leeg zijn (null)
`coc_number`	string	KvK-nummer. kan leeg zijn (null)
`vat_number`	string	Btw-nummer. kan leeg zijn (null)
`address`	string	Straat en huisnummer. kan leeg zijn (null)
`postal_code`	string	Postcode. kan leeg zijn (null)
`city`	string	Plaats. kan leeg zijn (null)
`country`	string	Land, als ISO-code van twee letters (bijvoorbeeld NL). kan leeg zijn (null)
`language`	string	Hoofdtaal van het bedrijf. een van: nl, en, de, fr
`currency`	string	Altijd "EUR".
`timezone`	string	Tijdzone waarin Klantly tijden aan het bedrijf toont. De API geeft tijden altijd in UTC.
`default_vat_rate`	string	Standaard-btw-percentage, als tekst met twee decimalen.
`prices_include_vat`	boolean	Of prijzen standaard inclusief btw worden ingevoerd.