v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Invoices

Get Invoices for a Company

Returns a list of invoices processed under the company record.

get/v3/company/invoice

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.

pageinteger

The page number to return.

pageSizeinteger

The number of items to return per page.

OpenInvoiceOnlystring

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

SortMethod'Ascending' | 'Descending'

The valid options for determining how data in a paged response is sorted.

The method used for sorting.

SortField'Invoice Number' | 'Due Date'

Valid options for invoice fields to sort by.

The field to sort by.

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

A list of company invoices.

totalResultsinteger nullable

The total number of results.

pageSizeinteger nullable

The number of results included per page.

currentPageinteger nullable

The current page number.

totalPagesinteger nullable

The total number of pages available.

currentPageSizeinteger nullable

The number of records in the current page.

currentSortMethod'Ascending' | 'Descending'

The valid options for determining how data in a paged response is sorted.

validSortMethodsSortMethod[] nullable
currentInvoiceSortField'Invoice Number' | 'Due Date'

Valid options for invoice fields to sort by.

validInvoiceSortFieldsInvoiceSortFields[]