Invoice To Department Options

get

https://api.avionte.com/bo-prod/v3/billing/option-items/invoice-to-department

Returns a list of company departments that can be used to specify where billing should be invoiced to. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.

Query Params

companyExternalId

string

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

departmentExternalId

string

The unique identifier for a Department record, formatted as a UUID.

companyGuid

uuid

The unique identifier for a Company record, formatted as a UUID.

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

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns a list of company departments that can be used to specify where billing should be invoiced to.

400Bad Request

402Additional subscription required.

403Access Denied

404Not found

409Duplicate conflict