Retrieve a business-establishment
Retrieve a business-establishment.
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
Headers
Only execute the request if current cached version of the resource does not match the one given here.
"W/q5sd4w2x1c1gfdg"
Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.
"W/q5sd4w2x1c1gfdg"
List of compression algorithms you support.
Path Parameters
Unique id of the business-establishment.
Query Parameters
Include metadata:
embedded
: the partial or complete representations of related resources (e.g. the employee the resource belongs to).links
: links to related resources or actions (e.g. approving a leave-request). May benull
when you do not have access to the resource (or action).totalCount
: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.
Read more about expanding responses.
Response
Representation of the requested business-establishment.
A business-establishment resource. Embedded resources on a business-establishment(s) response. A business-establishment is a geographically localized unit of the organization structure.
It belongs to a legal-entity. A legal-entity may have one (and only one) business-establishment set as its headquarters.
Business-establishments are an essential resource of the enterprise model, as they are the fundamental units of access rights scoping. As such, most objects are either directly or indirectly attached to a business-establishment.
Employees are attached to a business-establishment through their job-position.