v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Invoices

Update Invoice Finance Charge

Recalculates the finance charges for the specified invoices based on the invoice IDs provided in the request.

put/v3/invoice/finance-charge

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.

ExternalIdSource'BOLD' required

Example:BOLD

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

RequestUserExternalIdstring required

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.

Request body

BackofficeIdentifierUuid[] required

Response

Invoice updated successfully.

invoiceIdstring uuid nullable

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

invoiceNumberstring

The current invoice number, unique per supplier.

invoiceDatestring date nullable

The invoice date, formatted as YYYY-MM-DD, without a timestamp.

billAmountnumber double nullable

The total bill amount of all transactions associated with the current invoice.

invoiceAmountnumber double nullable

The total bill amount of all transactions associated with the current invoice, including sales taxes and excluding discounts.

balanceAmountnumber double nullable

The total remaining balance for the invoice.

salesTaxAmountnumber double nullable

The total sales tax amount calculated for this invoice.

discountTaxAmountnumber double nullable

The total discount amount calculated for this invoice.

dueDatestring date nullable

The invoice due date, formatted as YYYY-MM-DD, without a timestamp.

branchIdstring uuid nullable

The unique identifier for the Branch associated with this invoice, formatted as a UUID.

paymentTermOptionIdinteger nullable

The invoice payment term selected for this invoice.

isPostedboolean nullable

An indication of whether processing of this invoice has been finalized (true) or not (false).

billingBatchIdstring uuid nullable

The unique identifier for the Billing Batch that contains the current invoice, formatted as a UUID.

invoiceToIdstring uuid nullable

The unique identifier for the Company associated with the current invoice, formatted as a UUID.

invoiceStyleIdstring uuid nullable

The unique identifier for the Invoice Style associated with the current invoice, formatted as a UUID.

invoiceTypeOptionIdinteger nullable

The invoice type option identifier for the current invoice.

totalFinanceChargeAmountnumber double nullable

The total finance charge amount for the current invoice.