GET
/
v1
/
account
/
{accountId}
curl --request GET \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/account/{accountId}'
[
  {
    "amount": 123,
    "createdDate": "2019-11-27T05:08:31",
    "dueDate": "2019-11-27",
    "id": "<string>",
    "paidAmount": 123,
    "paymentReference": {
      "number": 1234567897,
      "type": "MOD10"
    },
    "period": {
      "start": "2020-01-01",
      "end": "2020-01-31"
    },
    "status": "CLOSED",
    "dunning": {
      "dunningStatus": "WAIT",
      "reminder1TriggerDate": "2019-11-27",
      "blockTriggerDate": "2019-11-27",
      "reminder2TriggerDate": "2019-11-27",
      "collectionTriggerDate": "2019-11-27"
    },
    "invoiceNumber": "<string>"
  }
]

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

Successful lookup of invoices for given account

​
amount
number

Total amount of this invoice

​
createdDate
string

Date when invoice was created

Example:

"2019-11-27T05:08:31"

​
dueDate
string

Date when invoice is due

Example:

"2019-11-27"

​
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