Gegevens uit het domain "accounts" stellen een account op het platform voor. Om ook accounts aan te kunnen maken moet je beschikken over een boekhoudersportaal.
Opbouw URL's:
/api/v1/accounts: Alle accounts waartoe de gebruiker toegang heeft
/api/v1/accounts/1111: Account met ID 1111
/api/v1/accounts/CAAAAAAAAA: Account met account nummer CAAAAAAAAA
/api/v1/accounts/current: Huidige actieve account
Domein: accounts
Voorbeeld van een account in JSON:
{ "account_id": 1111, "number": "CAAAAAAAAA", "name": "My Company", "company_name": "My Company", "street": "Olifantenstraat 200", "postal_code": "9000", "city": "Gent", "country": "België", "vat_number": "BE 0123.456.789", "company_id": "", "language": "", "email_address": "my@domain.be", "account_type": "professional", "account_type_until": "2028-12-31", "created": "2024-04-13 10:16", "last_login": "2025-06-05 13:33" }
Aanmaken van accounts
Bijkomende accounts kunnen enkel worden aangemaakt via een boekhoudersportaal. Gebruik daarom een API-sleutel die gekoppeld is aan een boekhoudersportaal om deze actie uit te voeren.
Accounts worden aangemaakt via een POST-aanvraag naar: /api/v1/accounts
Hoofdgebruiker instellen
Bij het aanmaken van een account heb je de keuze om:
een nieuwe hoofdgebruiker aan te maken, of
een bestaande gebruiker als hoofdgebruiker toe te wijzen.
Of het een nieuwe of bestaande gebruiker betreft, wordt automatisch bepaald op basis van het opgegeven e-mailadres. Je hoeft dus enkel het e-mailadres van de gebruiker mee te geven.
Let op: een bestaande gebruiker kan enkel worden ingesteld als hoofdgebruiker indien deze toegang heeft tot het boekhoudersportaal.
Beheerder van het account
Een account kan:
in beheer van de gebruiker worden aangemaakt, of
in beheer van het boekhoudersportaal (via de parameter
managed_by: "portal"
).
Wachtwoord of activatiemail
Wanneer je een nieuwe gebruiker aanmaakt, heb je twee opties:
Geef je geen wachtwoord op, dan ontvangt de gebruiker automatisch een activatiemail om een wachtwoord in te stellen.
Geef je wel een wachtwoord op, dan wordt geen activatiemail verstuurd.
Voorbeelden
1. Minimale gegevens (activatiemail + beheer door gebruiker):
{ "company_name": "My Company", "country": "België", "email_address": "jan@domain.be", "contact_name": "Jan Desmet", "managed_by": "user" }
2. Uitgebreide gegevens (beheer door portaal, wachtwoord en bedrijfsgegevens):
{ "company_name": "My Company", "street": "Olifantenstraat 200", "postal_code": "9000", "city": "Gent", "country": "België", "vat_number": "BE 0123.456.789", "email_address": "my@domain.be", "password": "-MySecretPassword-", "contact_name": "Jan Desmet", "managed_by": "portal", "account_type": "limited", }
Opmerking: Bij accounts in beheer van het portaal kan je ook het gewenste abonnementstype (account_type) opgeven.
3. Modules en SSO activeren bij aanmaak:
{ "company_name": "My Company", "country": "België", "email_address": "my@domain.be", "password": "-MySecretPassword-", "contact_name": "Jan Desmet", "managed_by": "portal", "sso": [{"identity": "1111111111111", "type": "google", "username": "Jan Desmet"}], "modules": ["quotes", "structured_message", "bank"] }
Met deze parameters kan je bij creatie aangeven welke modules standaard geactiveerd moeten worden en welke automatische aanmeldingsmethodes (SSO) van toepassing zijn.