domain-idstringrequired
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
company-idstring(uuid)required
The ID of the company
Example:3afb7b54-6144-4561-9a29-1148006f2375
Company
Operations related to companies
Get Company by ID
Retrieves detailed information about a specific company using its unique identifier. You should have the openid and yukiapi:domain:companies: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/domains/{domain-id}/companies/{company-id}
Path Parameters
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
Update Company
This endpoint allows the modification of an existing company’s details. Ensure you have the necessary permissions before attempting to update a company. You should have the openid and yukiapi:domain:companies:update 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.
put
https://apirest.yukiworks.be/api/v1/domains/{domain-id}/companies/{company-id}
Path Parameters
domain-idstringrequired
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
company-idstring(uuid)required
The ID of the company
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Body
application/json
Body
application/json
UpdateCompany
Company information object.
namestring | null
The name of the company.
Example:Example Corp
descriptionstring | null
A brief description of the company, stored as its commercial name. Limited to 40 characters; longer values are truncated without an error.
<= 40 characters
Example:Cloud infrastructure and hosting
addressobject
Address information object.
Show Child Parameters
mailingAddressobject
Address information object.
Show Child Parameters
detailsobject | null
Company details information object.
Show Child Parameters
emailAddressstring | null
Back-office mailbox of the company. Only the part before the “@” is kept; the domain is replaced by Yuki’s own mail domain, so the value is returned as @yukiworks. and not as the address supplied here.
Example:backoffice@example.com
phonestring | null
Phone number.
Example:+31 20 123 4567
websitestring | null
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
internalCustomerCodestring | null
Internal customer code (optional).
Example:CUST001
accountingStartingDatestring | null(date)
Accounting starting date. Alias of financials.yukiStartKeepingFinancialRecordsDate; when both are supplied, financials.yukiStartKeepingFinancialRecordsDate takes precedence.
Example:2024-01-01
financialsobject | null
Financial object containing financial-related settings.
Show Child Parameters
taxInformationobject | null
Company tax information object.
Show Child Parameters
Response
Response
Company updated successfully.
Patch Company Peppol Settings
Partially updates a company’s Peppol settings, registering the company on the Peppol network, updating its registration, or removing it when both flags are set to false. You should have the openid and yukiapi:domain:companies:update scopes to access this endpoint - the gateway requires both together. Peppol must be enabled for the portal and licensed for the company’s domain, and sending over Peppol is only possible with a Small bundle or higher. A request that asks for more than the portal or the domain is entitled to is rejected with 422, not with a permissions error - errorCode peppol:portal_not_enabled when Peppol is not enabled for the portal, peppol:domain_not_eligible when the company’s domain is not licensed for Peppol, and peppol:sending_not_eligible when enableSending is requested for a domain that may receive over Peppol but not send.
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.
Checked before any Peppol eligibility check, so a caller who lacks these roles gets 403 rather than a 422 about Peppol.
patch
https://apirest.yukiworks.be/api/v1/domains/{domain-id}/companies/{company-id}/settings/peppol
Path Parameters
domain-idstringrequired
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
company-idstring(uuid)required
The ID of the company
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Body
application/json
Body
application/json
PatchPeppolSettingsRequest
Request body for partially updating company Peppol settings.
enableSendingboolean | null
Enables or disables Peppol sending. Omit to leave unchanged.
enableReceivingboolean | null
Enables or disables Peppol receiving. Omit to leave unchanged.
Response
Response
Company Peppol settings patched successfully.
Get All Companies
Retrieves a paginated list of all companies within the specified domain. Use offset and limit parameters for pagination through large result sets. You should have the openid and yukiapi:domain:companies: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/domains/{domain-id}/companies
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
domain-idstringrequired
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Headers
Authorizationstringrequired
Bearer token for authentication
Response
application/json
Response
application/json
Paged result of companies
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]
Company information object.
Show Child Parameters
application/json