Domain
Operations related to domains
Create Domain
This endpoint allows the creation of a new domain. Ensure you have the necessary permissions before attempting to create a domain. You should have the openid scope together with one of yukiapi:domain:domains:create or yukiapi:domain:domains:write to access this endpoint. The portal must be registered as a Yuki Partner and be allowed to create new administrations; otherwise the request is rejected with 403. Returns domains:already_exists (409) if a domain with that name already exists or the name is reserved, domains:validation_failed (400) if the domain cannot be created from the data supplied, or domains:creation_failed (500) if the domain and its default administration could not be created.
Authorization
Called with a Portal User token - an employee of an accounting portal.
The caller must hold at least one of these roles in the portal: AccountantManagement, Accountant.
post
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/domains
Path Parameters
portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Body
application/json
Body
application/json
CreateDomain
Schema for creating a new domain.
namestringrequired
The domain name. Only lowercase letters, numbers and dashes are allowed, and it must start with a letter or number.
Example:my-company-name
statusstringrequired
The status of the domain for creation purposes.
Allowed values:StartupActive
Example:Active
bundlestringrequired
The bundle type for the domain.
Allowed values:MinimalSmallMediumLargeUnlimited
Example:Medium
languagestringrequired
The locale for the domain.
BE: nl-BE, en-US, fr-BE.
NL: en-US, nl-NL
Allowed values:nl-BEen-USfr-BEnl-NL
Example:nl-BE
companyobjectrequired
Company information object.
Show Child Parameters
createCustomerUserbooleanrequired
Whether to also create a user account for the customer. When true, the customer (customerName/customerEmail) is invited as the first user of the domain: an invitation email is sent and, once accepted, the customer can log in with management permissions. When false, no user account is created and no email is sent. In both cases the customer is registered as the main contact person of the company created together with the domain.
Example:true
customerNamestringrequired
The full name of the customer. Always required, regardless of createCustomerUser: together with customerEmail it identifies the main contact person of the company created together with the domain.
Example:John Doe
customerEmailstring(email)required
The email address of the customer. Always required, regardless of createCustomerUser: it is stored on the main contact person of the company created together with the domain and, when createCustomerUser is true, it is also used to send the invitation email.
Example:john.doe@yuki.be
backofficeobject
Back office configuration settings.
Show Child Parameters
Response
application/json
Response
application/json
Domain successfully created
idstring
The unique identifier of the created domain
Example:3afb7b54-6144-4561-9a29-1148006f2375
companyIdstring
The unique identifier of the company created together with the domain
Example:8c2e0d11-4b7a-4f3e-9d02-5a6f31c9e842
application/json
Get All Domains for a Portal
This endpoint allows the retrieval of all domains belonging to a Portal. Ensure you have the necessary permissions before attempting to retrieve the domains list. You should have the openid and yukiapi:domain:domains:read scopes to access this endpoint.
Authorization
Called with a Portal User token - an employee of an accounting portal.
The caller must hold at least one of these roles in the portal: AccountantManagement, Accountant.
get
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/domains
Query Parameters
offsetinteger
Number of items to skip before collecting the result set. Defaults to 0; a negative value is rejected with 400.
Default:0
>= 0
limitinteger
Maximum number of items to return. Defaults to 20; a value outside 1-500 is rejected with 400.
Default:20
>= 1<= 500
Path Parameters
portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Response
application/json
Response
application/json
Paged result of domains
totalItemsinteger
Total number of items available
Example:100
offsetinteger
Current offset in the list
Example:10
limitinteger
Maximum number of items returned
Example:20
itemsarray[object]
Show Child Parameters
application/json
Get Domain by ID
Retrieves detailed information about a specific domain using its unique identifier. This includes domain metadata and configuration details. You should have the openid and yukiapi:domain:domains:read scopes to access this endpoint. Returns domains:not_found (404) if this portal has no domain with that id.
Authorization
Called with a Portal User token - an employee of an accounting portal.
The caller must hold at least one of these roles in the portal: AccountantManagement, Accountant.
get
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/domains/{domain-id}
Path Parameters
portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
domain-idstringrequired
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Response
application/json
Response
application/json
Domain object
Domain
idstring
Example:e7ff8d6e-d82a-4649-be6e-523db02052d3
namestring
Example:Example Domain
hidstring
Example:abcd1234
typestring
Example:Business
statusstring
The status of the domain for read purposes.
Allowed values:StartupActiveInactiveArchived
Example:Active
countrystring
Example:Belgium
ownerobject
Show Child Parameters
backofficeobject
Show Child Parameters
createdDatestring(date-time)
Example:2023-01-01T10:00:00Z
createdBystring
Example:Admin User
modifiedDatestring(date-time)
Example:2023-01-15T15:30:00Z
modifiedBystring
Example:Moderator
lastUserLoginstring(date-time)
Example:2023-01-20T09:00:00Z
lastDocumentUploadstring(date-time)
Example:2023-01-18T14:45:00Z
commentsstring | null
Free-form remarks stored on the domain.
Example:Migrated from legacy portal
contractobject
Show Child Parameters
application/json
Update Domain by ID
This endpoint allows the modification of an existing domain’s details by its ID. Ensure you have the necessary permissions before attempting to update a domain. You should have the openid scope together with one of yukiapi:domain:domains:write or yukiapi:domain:domains:update to access this endpoint. Returns domains:not_found (404) if this portal has no domain with that id, or domains:update_failed (500) if the domain was found but the back-office change could not be written.
Authorization
Called with a Portal User token - an employee of an accounting portal.
The caller must hold at least one role from each of the following groups:
- In the portal:
AccountantManagement,Accountant BackofficeManager,BackofficeController,AccountantManagement- Enforced at the back-office security level and back-office functions layer.
put
https://apirest.yukiworks.be/api/v1/portals/{portal-id}/domains/{domain-id}
Path Parameters
portal-idstringrequired
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
domain-idstringrequired
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Body
application/json
Body
application/json
UpdateDomain
Schema for updating an existing domain.
backofficeobjectrequired
Back office configuration settings for updating a domain. All fields are optional; only the fields that are supplied are updated.
Show Child Parameters
Response
Response
Domain updated successfully.