Invoice

Manage Invoices.

Download

Endpoint

POST /invoice/download

Authorized User Role

owner

Request Body

Field	Type	Required	Notes
id	string	yes	Invoice ID.

Response

A PDF binary string.

Get

Endpoint

POST /invoice/get

Authorized User Role

admin

Request Body

Field	Type	Required	Notes
id	string	yes	Invoice ID.

Response

Field	Type
accountId	string
amount	number
date	date
description	string
due	date
items	array
id	string
memo	string
nextReminder	date
number	string
order	string
paid	number
pdf	string
receipt	string
submitted	date
tax	number
terms	number
total	number

Find

Endpoint

POST /invoice/find

Authorized User Role

admin

Request Body

None.

Query String Options

Field	Type
filter	string
hidden	boolean
index	string
limit	number
log	boolean
next	object
prev	object
where	string

Response

Paged response.

Field	Type	Notes
data	array	An array of Invoice records.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Invoice

Field	Type
accountId	string
amount	number
date	date
description	string
due	date
items	array
id	string
memo	string
nextReminder	date
number	string
order	string
paid	number
pdf	string
receipt	string
submitted	date
tax	number
terms	number
total	number

FindOutstanding

Endpoint

POST /invoice/findOutstanding

Authorized User Role

owner

Request Body

None.

Query String Options

Field	Type
filter	string
hidden	boolean
index	string
limit	number
log	boolean
next	object
prev	object
where	string

Response

Paged response.

Field	Type	Notes
data	array	An array of Invoice records.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Invoice

Field	Type
accountId	string
amount	number
date	date
description	string
due	date
items	array
id	string
memo	string
nextReminder	date
number	string
order	string
paid	number
pdf	string
receipt	string
submitted	date
tax	number
terms	number
total	number

Reissue

Endpoint

POST /invoice/reissue

Authorized User Role

admin

Request Body

Field	Type	Required	Notes
id	string	yes	Invoice ID.

Response

A PDF binary string.