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.
Number of items to skip before collecting the result set. Defaults to 0; a negative value is rejected with 400.
Default:0
>= 0
Maximum number of items to return. Defaults to 20; a value outside 1-500 is rejected with 400.
Default:20
>= 1<= 500
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Paged result of domains
Total number of items available
Example:100
Current offset in the list
Example:10
Maximum number of items returned
Example:20
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.
The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Domain object
Example:e7ff8d6e-d82a-4649-be6e-523db02052d3
Example:Example Domain
Example:abcd1234
Example:Business
The status of the domain for read purposes.
Allowed values:StartupActiveInactiveArchived
Example:Active
Example:Netherlands
Example:2023-01-01T10:00:00Z
Example:Admin User
Example:2023-01-15T15:30:00Z
Example:Moderator
Example:2023-01-20T09:00:00Z
Example:2023-01-18T14:45:00Z
Free-form remarks stored on the domain.
Example:Migrated from legacy portal
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:
AccountantManagement, AccountantBackofficeManager, BackofficeController, AccountantManagement - Enforced at the back-office security level and back-office functions layer.The portal id
Example:3afb7b54-6144-4561-9a29-1148006f2375
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Schema for updating an existing domain.
Back office configuration settings for updating a domain. All fields are optional; only the fields that are supplied are updated.
Domain updated successfully.
Operations related to users of domain
This endpoint allows retrieving all users within a specific domain. Returns a list of all users with their details including name, email, roles, and language preferences. Users attempting to perform this operation need to ensure they possess the necessary permissions. You should have the openid and yukiapi:domain:users: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.
Number of items to skip before collecting the result set. Defaults to 0; a negative value is rejected with 400.
Default:0
>= 0
Maximum number of items to return. Defaults to 20; a value outside 1-500 is rejected with 400.
Default:20
>= 1<= 500
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Paged result of domain users
Total number of items available
Example:100
Current offset in the list
Example:10
Maximum number of items returned
Example:20