Skip to main content

Client

As a client we define either a user or a service that communicates and interacts with the Accounting System API. In order for a client to be able to interact with the API, first it has to register itself into the Accounting System. Based on the Client voperson_id the Accounting System API assigns different Roles to different Clients. Consequently, a client cannot get a Role unless registration has been completed first.

[POST] - Client Registration​

One client can register itself into the Accounting System by executing the following request:

POST /accounting-system/clients

Authorization: Bearer {token}

Once the above request is executed, we extract the following information from the token:

  • sub
  • name
  • email

Then we store it into the database collection Client:

FieldDescription
idAn identifier for the client which is globally unique and not reassignable.
nameThe client's full name.
emailThe client’s email.

[GET] - Read the registered Clients​

You can read the registered clients by executing the following request:

GET /accounting-system/clients

Authorization: Bearer {token}

Errors​

Please refer to section Errors to see all possible Errors.