Get Invoices for a Company

get

https://api.avionte.com/bo-prod/v3/company/invoice

Returns a list of invoices processed under the company record.

Query Params

companyGuid

uuid

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

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.

page

int32

≥ 1

Defaults to 1

The page number to return.

pageSize

int32

1 to 100

Defaults to 20

The number of items to return per page.

OpenInvoiceOnly

string

An indication of whether to include only invoices with an outstanding balance amount.

SortMethod

string

enum

The method used for sorting.

Allowed:

SortField

string

enum

The field to sort by.

Allowed:

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 invoices.

402Additional subscription required.

403Access Denied

404Not found