Hoi 👋🏻 kunnen we je helpen?

Zoeken

Bedrijven beheren via de API

Article author
Shannon Bolink-Tieman
  • Bijgewerkt

Via de Hix API kun je bedrijven (klanten) volledig beheren: aanmaken, opvragen, bijwerken, archiveren en verwijderen.

Endpoints

MethodeEndpointBeschrijving
GET/api/v1/companiesLijst van alle bedrijven (gepagineerd)
PUT/api/v1/company/addNieuw bedrijf aanmaken
PATCH/api/v1/company/{id}Bedrijf bijwerken
DELETE/api/v1/company/{id}Bedrijf verwijderen
PATCH/api/v1/company/{id}/restoreGearchiveerd bedrijf herstellen
GET/api/v1/company/{id}/usersGebruikers van een bedrijf opvragen
GET/api/v1/company/{id}/identifiersKVK/BTW-nummers opvragen
PUT/api/v1/company/{id}/identifiers/addIdentifier toevoegen
DELETE/api/v1/company/{id}/identifiers/{identifier_id}Identifier verwijderen

Bedrijf opvragen (lijst)

GET /api/v1/companies?page=1&limit=15

Response:
{
  "data": [
    {
      "id": 42,
      "name": "Acme B.V.",
      "address": "Hoofdstraat 1, Amsterdam",
      "internal_client_id": "CLIENT-001",
      "external_id": "ERP-9876",
      "archived": false,
      "identifiers": [],
      "tags": ["accountancy"]
    }
  ],
  "meta": { "current_page": 1, "last_page": 3, "per_page": 15, "total": 38 }
}

Bedrijf aanmaken

PUT /api/v1/company/add
Content-Type: application/json

{
  "name": "Nieuwe Klant B.V.",
  "internal_client_id": "CLIENT-002",
  "external_id": "ERP-1234"
}

Bedrijf bijwerken

PATCH /api/v1/company/42
Content-Type: application/json

{
  "name": "Nieuwe Klant Holding B.V."
}

KVK/BTW-nummer koppelen

PUT /api/v1/company/42/identifiers/add
Content-Type: application/json

{
  "type": "kvk",
  "value": "12345678"
}