Klantly Developers

Référence de l'API

Entreprise

Les données de votre propre entreprise : nom, adresse, langue et paramètres de TVA.

Endpoints

Récupérer l'entreprise

GET /api/v1/company

Les données de l'entreprise à laquelle appartient la clé, avec le taux de TVA par défaut et si les prix incluent la TVA.

Scope
company.read — Lire les données de l'entreprise

Exemple de requête

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

Réponse 200

Exemple de réponse
{
  "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
  }
}

Erreurs possibles

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

L'objet

Tous les champs sont toujours présents ; un champ sans valeur vaut null.

ChampTypeDescription
object string Toujours « company ».
id string Id de l'entreprise.
name string Nom de l'entreprise.
email string Adresse e-mail générale. peut être vide (null)
phone string Numéro de téléphone. peut être vide (null)
website string Site web. peut être vide (null)
coc_number string Numéro d'immatriculation (registre du commerce). peut être vide (null)
vat_number string Numéro de TVA. peut être vide (null)
address string Rue et numéro. peut être vide (null)
postal_code string Code postal. peut être vide (null)
city string Ville. peut être vide (null)
country string Pays, sous forme de code ISO à deux lettres (par exemple FR). peut être vide (null)
language string Langue principale de l'entreprise. l'une des valeurs : nl, en, de, fr
currency string Toujours « EUR ».
timezone string Fuseau horaire dans lequel Klantly affiche les heures à l'entreprise. L'API renvoie toujours les heures en UTC.
default_vat_rate string Taux de TVA par défaut en pourcentage, sous forme de texte à deux décimales.
prices_include_vat boolean Si les prix sont saisis TTC par défaut.