Sign in

v2

latestSwagger 2.02026-08-04108164321.0 KB
Invoice

Retrieves a single invoice by its Transaction ID, including line items, issuer/recipient address details, and web links.

get/api/Invoice/{id}

Path parameters

idinteger required

Invoice Transaction ID number

Response

Returns the invoice details with line items, issuer/recipient, and links.

TransactionIDinteger

Unique identifier for the invoice transaction.

AccountIDFKinteger

The Avaza account this invoice belongs to.

TransactionPrefixstring

Prefix used in the invoice number (e.g. 'INV').

InvoiceNumberstring

The full invoice number including prefix.

CompanyIDFKinteger

The customer company ID this invoice is for.

CompanyNamestring

Name of the customer company.

ExternalContactUserIDFKinteger

The external contact user ID associated with this invoice.

Subjectstring

Subject line for the invoice.

DateIssuedstring date-time

Date the invoice was issued.

DateSentstring date-time

Date the invoice was sent to the customer.

DueDatestring date-time

Payment due date.

TransactionStatusCodestring

Current status. Values: Draft, Sent, Late, Paid, Partial, Void.

TaxAmountnumber double

Total tax amount across all line items.

TransactionTaxConfigCodestring

Tax configuration: 'EX' (exclusive) or 'INC' (inclusive).

Balancenumber double

Outstanding balance remaining on the invoice.

CurrencyCodestring

ISO 3-character currency code for the invoice.

TotalAmountnumber double

Total amount of the invoice including tax.

ExchangeRatenumber double

Exchange rate to the account's base currency. 1.0 if same currency.

Notesstring

Additional notes or comments on the invoice.

CustomerPONumberstring

Customer's purchase order number for reference.

DateCreatedstring date-time

Date and time the record was created.

DateUpdatedstring date-time

Date and time the record was last updated.