GET
/
v1
/
account
/
{accountId}

Path Parameters

​
accountId
string
required

Account id for given account

Query Parameters

​
auditUser
string
required

The audit user to log the request

​
page
integer
default:
0

Current page

​
size
integer
default:
15

How many invoices should be returned per page, default is 15. Cannot be more than 30.

Required range: 1 <= x <= 30
​
status
enum<string>

Used to return invoices only with a certain status

Available options:
CLOSED,
OPEN,
OVERDUE,
PAID,
PAID_PARTIALLY,
WRITE-OFF

Response

200 - application/json
​
amount
number

Total amount of this invoice

​
createdDate
string

Date when invoice was created

​
dueDate
string

Date when invoice is due

​
dunning
object

Dunning details, this should only be populated if invoice status is overdue

​
id
string

Unique id for invoice

​
invoiceNumber
string

Number of the invoice

​
paidAmount
number

Total amount that is paid of this invoice

​
paymentReference
object

Number connected to account that will be used to map incoming payments to

​
period
object
​
status
enum<string>
  • CLOSED Closed
  • OPEN Open
  • OVERDUE Overdue
  • PAID Paid
  • PAID_PARTIALLY Partially Paid
  • WRITE-OFF Written Off
Available options:
CLOSED,
OPEN,
OVERDUE,
PAID,
PAID_PARTIALLY,
WRITE-OFF
Get invoice for given invoice idOverview