API Reference
Guides

Create a new Invoice

post
https://api.test.payadvantage.com.au/v3/invoices

Manage merchant invoices. Invoices allows for line items. Invoices status lifecycle is: (Draft → Sent → Paid / Cancelled). You can also connect an invoice to any payment.


Creates a new invoice in Draft status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Customer
object
required
string
required
length between 1 and 50

Your merchant-supplied invoice number.

date | null
^\d\d\d\d\-\d\d\-\d\d$

Optional date the invoice was issued. Defaults to today when not supplied.

date | null
^\d\d\d\d\-\d\d\-\d\d$

Optional due date for payment of this invoice.

string | null

Optional notes or message to the customer.

string | null

Optional merchant internal reference.

string | null

Optional identifier from your own system.

LineItems
array of objects
required
length ≥ 1

List of line items on this invoice. At least one is required.

LineItems*
string | null

Description of the goods or services for this line item. Required unless 'product' is supplied, in which case it defaults to the product's description (or its name if the product has no description).

double | null
1 to 999

Quantity of units. Defaults to 1 when omitted. Supports fractional quantities (e.g. 1.5 hours).

double | null

Unit price per item. When set, 'amount' is computed as quantity × unitPrice by the server.

double | null

Total line amount. Required when 'unitPrice' is not provided. Ignored if 'unitPrice' is provided.

string | null

A product code. When set, pre-fills description, unit price, and tax code if those fields are not explicitly provided.

double
required
0 to 99999

Discount amount subtracted from the line subtotal (quantity x unitPrice). Defaults to 0.

string | null

A tax code. If omitted, the product's tax code is used; if no product is provided either, the merchant's default tax code is applied. The tax amount is always derived server-side from the resolved tax code's rate.

int16
required

Display order of this line item. Lower values appear first.

boolean
required

Whether notes on this invoice are visible to the customer on the hosted invoice page. Defaults to false.

boolean
required

Whether line item unit prices are tax exclusive (tax added on top). When false (default) unit prices are tax inclusive (tax is contained within the entered price).

Responses

Updated 26 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 26 days ago

Did this page help you?