companyIdstring(uuid)required
The unique identifier of the company to search for
Search Company by Company ID
This endpoint allows searching for a company within a specific portal by its company ID. Returns the company details if a match is found. Users attempting to perform this operation need to ensure they possess the necessary permissions. You should have the openid and yukiapi:portal:portals: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}/companies/search/byCompanyId
Query Parameters
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
Company object
Company
Company information object.
idstring(uuid)
Unique identifier of the company.
Example:123e4567-e89b-12d3-a456-426614174000
companyNamestring
The name of the company.
Example:Example Corp
companyDescriptionstring
A brief description of the company.
Example:Example Corp is a leading provider of innovative solutions.
addressobject
Address information object.
Show Child Parameters
mailingAddressobject
Address information object.
Show Child Parameters
countrystring | null
Country ISO code.
Example:NL
emailAddressstring
Back-office mailbox of the company, always on Yuki’s own mail domain. Only the part before the “@” is stored when the company is updated, so this is not the company’s own email address.
Example:backoffice@yukiworks.be
phonestring
Phone number.
Example:+31 20 123 4567
websitestring
Company website (optional).
Example:https://example.com
legalFormstring
Legal form of the company.
BE: Unknown, SolePartnership, PrivateLimited, PublicLimited, GeneralPartnership, LimitedPartnership, Partnership, Association, Foundation, Cooperative.
NL: values to be added later
Allowed values:UnknownSolePartnershipPrivateLimitedPublicLimitedGeneralPartnershipLimitedPartnershipPartnershipAssociationFoundationCooperative
Example:PrivateLimited
cocNumberstring
Chamber of Commerce number.
Example:12345678
internalCustomerCodestring
Internal customer code (optional).
Example:CUST001
accountingStartingDatestring(date)
Accounting starting date.
Example:2024-01-01
financialobject
Financial object containing financial-related settings.
Show Child Parameters
peppolConfigurationobjectrequired
Peppol configuration object containing Peppol-related settings.
Show Child Parameters
domainIdstring(uuid)
The unique identifier of the domain where the company belongs.
Example:456e5678-f90c-23e4-b567-537725285111
application/json
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:en-US
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.nl
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:Netherlands
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