Get Options for Company Status

get

https://api.avionte.com/bo-prod/v3/company/option-items/statuses

Returns a list of configured options for company status, based on either the Company (for existing records) or the Branch (for new company records). Use the CompanyGuid query parameter if available; otherwise, use BranchGuid for the branch the company will be associated with.

Query Params

branchGuid

uuid

The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.

branchExternalId

string

The external ID of the Branch entity, used as an alternative to the BranchGuid query parameter. When provided with a valid ExternalIdSource header, it overrides the lookup of the Branch entity record. If a matching record is not found, an ExternalEntityNotFound error is returned. If a match is found, the response includes a BranchGuid header containing the classic entity record ID.

includeInactive

string

An indication of whether to include disabled or inactive statuses in the response. New records cannot be created with an inactive status.

Headers

FrontOfficeTenantId

integer

required

An integer identifier for the tenant that the request is being made for.

RequestOrigin

string

required

length between 1 and 100

The string source name (such as application or function name) that indicates the origin of the request.

RequestId

uuid

required

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

ExternalIdSource

string

enum

required

The external ID source that determines which external reference source is used to perform an external ID lookup.

Allowed:

RequestUserExternalId

string

The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.

Responses

405

Unsupported method

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

200A list of company statuses for the tenant.

402Additional subscription required.

403Access Denied

404Not found