v1

Swagger 2.02026-07-13107162315.5 KB
Invoice

Creates a new draft invoice. Optionally creates a new customer company and contact if no matching company is found.

post/api/Invoice

Request body

TransactionPrefixstring

A prefix for the Invoice number. e.g. 'INV'. If left blank it will be set to the account default. Max length 20 characters.

InvoiceNumberstring

Pass any string. If left blank it will use the next number in the auto incrementing sequence. If an integer is passed then the largest integer will be use as the seed to auto generate the next invoice number in the sequence.

CompanyIDFKinteger

If left blank then you must specify Company Name.

CompanyNamestring

If left blank then you must specify Company ID. Specified Name will be used to match existing customer record. If not matched then it will be used to create a new customer. First Name, Last Name and Email will only be used if it is a new company. If the Company name appears multiple times we will check the email address to find a matching company. If email address doesn't identify a matching company then the invoice creation will be rejected.

Firstnamestring

Specified value will be used to create a new customer contact only if a new customer is being created.

Lastnamestring

Specified value will be used to create a new customer contact only if a new customer is being created.

Emailstring

Specified value will be used to create a new customer contact only if a new customer is being created.

CurrencyCodestring

Expects ISO Standard 3 character currency code. If left blank the currency will default to account's currency in general setting. For existing companies this field will be ignored and the invoice will use the currency of the customer. For new customers if the currency is not specified then account currency will be used otherwise the specified currency will be used.

ExchangeRatenumber double

Exchange rate is only valid for invoices in currency other than default account currency. If not specified it will get the market rate based on the Date Issued.

InvoiceTemplateIDFKinteger

If left blank the account default invoice template will be used.

Subjectstring

Plain UTF8 text. (no HTML). 255 characters max

CustomerPONumberstring

Plain UTF8 text. 100 characters max

DateIssuedstring date-time

If not specified it will use today's date. The date should be specified as local date.

PaymentTermsinteger

"If left blank we will set it to customer default. If specified then it must match one of your existing pre configured payment term periods. Your account starts with: (-1 --- Custom, 0 --- Upon Receipt, 7 --- 7 Days, 15 --- 15 Days, 30 --- 30 Days, 45 --- 45 Days, 60 --- 60 Days)

DueDatestring date-time

It will be auto calculated based on the payment term and issue date. Due Date must be greater than or equal to Issue Date. If the Due Date is specified then Payment Terms will be set to -1 (Custom)

TransactionTaxConfigCodestring

Possible values are (EX --- Tax Exclusive, INC --- Tax Inclusive). If left empty it will use the account default.

Notesstring

Plain UTF8 text. (no HTML). Max 2000 characters

SendWebhooksboolean

If true, fires the invoice_created webhook event to any subscribed endpoints (and timesheet_updated for any timesheets pulled into the invoice). Defaults to false to preserve existing integration behaviour.

Response

Returns the created invoice with assigned Transaction ID and line items.

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.