v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Billing Preferences

Get Company Billing Preferences

Returns company billing options for the specified company, based on its unique record identifier.

get/v3/company/billing-preferences

Query parameters

companyGuidstring uuid

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

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.

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

Company setup options and configuration related to billing.

companyGuidstring uuid

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

billingPeriod'Unknown' | 'Weekly' | 'BiWeekly' | 'Monthly' | 'SemiMonthly' | 'Daily' | 'Yearly' | 'Hourly'

An option to define the billing frequency of billing processing.

billingPeriodCycle'1' | '2' | '3' | '4' | 'LastWeek'

An option to define when billing processing occurs.

Example response

{
  "invoicePreferences": {
    "maxInvoiceAmount": 1000.01
  }
}