Search
K
Yuki Platform API Prod

Yuki Platform API Prod

1.0.77OAS 3.0

Unified API specification for all Yuki Platform services. This specification includes 5 APIs with 15 total endpoints.

API Base URL
  • Server 1:https://apirest.yukiworks.be/api/v1
Security
bearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

vismaConnectPortalUser (oauth2)

Visma Connect token belonging to a Portal User - an employee of an accounting portal. The token’s tenant must be a portal; the API resolves it to the caller’s portal. The portal in the route must be that portal or one of the caller’s master-accountant portals. Unless an endpoint says otherwise, the caller’s roles are resolved against the portal.

vismaConnectDomainUser (oauth2)

Visma Connect token belonging to a Domain User - a user in a domain with access to one or more companies. The company the token was issued for must match the company-id in the route. The caller’s roles are resolved in that company’s domain.

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

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

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