Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Billing

Invoice To Department Options

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.

get/v3/billing/option-items/invoice-to-department

Query parameters

companyExternalIdstring

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.

departmentExternalIdstring

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

companyGuidstring uuid

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

Headers

FrontOfficeTenantIdinteger required

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

RequestOriginstring required

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

RequestIdstring uuid required

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

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

ExternalIdSource'BOLD' required
Example:BOLD

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

RequestUserExternalIdstring
Example:ABC123

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.

Response

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

companyExternalIdstring nullable

The unique system-defined identifier for the Company.

companyGuidstring uuid nullable

The Back Office unique identifier for the Company, formatted as a UUID.

departmentExternalIdstring nullable

The unique system-defined identifier for the Company Department.

departmentGuidstring uuid nullable

The Back Office unique identifier for the Department, formatted as a UUID.

departmentNamestring

The name of the company department.