Get invoice information
Get invoices for a given accountId
This operation returns invoices for a given account ordered in ascending order
GET
/
v1
/
account
/
{accountId}
Path Parameters
accountId
string
requiredAccount id for given account
Query Parameters
auditUser
string
requiredThe audit user to log the request
page
integer
default: 0Current page
size
integer
default: 15How many invoices should be returned per page, default is 15. Cannot be more than 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
id
string
Unique id for 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
dunning
object
Dunning details, this should only be populated if invoice status is overdue
invoiceNumber
string
Number of the invoice