Unified API specification for all Yuki Platform services. This specification includes 5 APIs with 11 total endpoints.
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
This API uses OAuth 2 with the authorization code flow.
Operations related to companies
Retrieves detailed information about a specific company using its unique identifier. You should have yukiapi:domain:companies:read scope to access this endpoint.
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
The company ID
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Content type of the request body
Default:application/json
Company object
Company information object.
Unique identifier of the company.
Example:123e4567-e89b-12d3-a456-426614174000
The name of the company.
Example:Example Corp
A brief description of the company.
Example:Example Corp is a leading provider of innovative solutions.
Address information object.
Address information object.
Country ISO code.
Example:NL
Email address.
Example:info@example.com
Phone number.
Example:+31 20 123 4567
Company website (optional).
Example:https://example.com
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
Chamber of Commerce number.
Example:12345678
Internal customer code (optional).
Example:CUST001
Accounting starting date.
Example:2024-01-01
Financial object containing financial-related settings.
Peppol configuration object containing Peppol-related settings.
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 yukiapi:domain:companies:update scope to access this endpoint.
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
The company ID
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Content type of the request body
Default:application/json
Company information object.
The name of the company.
Example:Example Corp
A brief description of the company.
Example:Example Corp is a leading provider of innovative solutions.
Address information object.
Address information object.
Country ISO code.
Example:NL
Email address.
Example:info@example.com
Phone number.
Example:+31 20 123 4567
Company website (optional).
Example:https://example.com
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
Chamber of Commerce number.
Example:12345678
Internal customer code (optional).
Example:CUST001
Accounting starting date.
Example:2024-01-01
Financial object containing financial-related settings.
Company updated successfully.
Retrieves a paginated list of all companies within the specified domain. Returns basic company information including ID, name, status, and metadata. Use offset and limit parameters for pagination through large result sets.
The number of items to skip before starting to collect the result set
The numbers of items to return
The domain name
Example:3afb7b54-6144-4561-9a29-1148006f2375
Bearer token for authentication
Content type of the request body
Default:application/json
Paged result of companies
Total number of items available
Example:100
Current offset in the list
Example:10
Maximum number of items returned
Example:20
Company information object.