POST
/invoice/list/{policyId}
Whenever you would like to obtain list of invoices for a specific customer, use this endpoint. This call allows you to search for invoices by specific patterns, filter using date ranges and even sort them in ascending or descending order by specific parameter. This call comes in handy especially in situations when you want to list all customers invoices in one table and reflect their outstanding balance.
Parameters
Name
Description
policyId
string
(required)
Unique customer ID created by you previously using addCustomer end-point.
invoiceListFilterModel
(required)
Data required in order to return list of invoices associated with particular.
Response Messages
Code
Description
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
{
"first": 0,
"count": 0,
"date_from": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"date_to": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"filter_type": "NONE",
"search": "string",
"sort": "INVOICE_NUMBER",
"ascending": true
}
{ } InvoiceListFilterModel
first
optional
integer
count
optional
integer
date_from
optional
string
date_to
optional
string
filter_type
optional
string
search
optional
string
sort
optional
string
ascending
optional
boolean
[
{
"account_holder": "string",
"account_imported_on": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"additional_descr": "string",
"amount": 1.01,
"cc_profile_id": 0,
"charge_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"charge_type": "string",
"creation_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"currency_code": "AED",
"email": "string",
"id": 0,
"import_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"invoice_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"invoice_due_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"invoice_number": "string",
"invoice_state": "DRAFT",
"last_tx_type": "string",
"opened": 0,
"paid": "PAID",
"payment_method": "string",
"period_end_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"period_start_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
"policy": "string",
"resend": true,
"sent_times": 0,
"uuid": "string",
"version": 0
}
]
{ } InvoiceForCustomerModel
account_holder
required
string
account_imported_on
required
string
additional_descr
optional
string
amount
required
number
cc_profile_id
required
integer
charge_date
optional
string
charge_type
optional
string
creation_date
required
string
currency_code
required
string
email
required
string
id
required
integer
import_date
required
string
invoice_date
required
string
invoice_due_date
required
string
invoice_number
required
string
invoice_state
required
string
last_tx_type
optional
string
opened
optional
integer
paid
required
string
payment_method
optional
string
period_end_date
optional
string
period_start_date
optional
string
policy
required
string
resend
required
boolean
sent_times
optional
integer
uuid
required
string
version
required
integer
<invoice_list_filter_model>
<first>0</first>
<count>0</count>
<date_from>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</date_from>
<date_to>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</date_to>
<filter_type>NONE</filter_type>
<search>string</search>
<sort>INVOICE_NUMBER</sort>
<ascending>1</ascending>
</invoice_list_filter_model>
{ } InvoiceListFilterModel
first
optional
integer
count
optional
integer
date_from
optional
string
date_to
optional
string
filter_type
optional
string
search
optional
string
sort
optional
string
ascending
optional
boolean
<invoice_for_customer_model>
<account_holder>string</account_holder>
<account_imported_on>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</account_imported_on>
<additional_descr>string</additional_descr>
<amount>1.01</amount>
<cc_profile_id>0</cc_profile_id>
<charge_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</charge_date>
<charge_type>string</charge_type>
<creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
<currency_code>AED</currency_code>
<email>string</email>
<id>0</id>
<import_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</import_date>
<invoice_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</invoice_date>
<invoice_due_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</invoice_due_date>
<invoice_number>string</invoice_number>
<invoice_state>DRAFT</invoice_state>
<last_tx_type>string</last_tx_type>
<opened>0</opened>
<paid>PAID</paid>
<payment_method>string</payment_method>
<period_end_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</period_end_date>
<period_start_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</period_start_date>
<policy>string</policy>
<resend>1</resend>
<sent_times>0</sent_times>
<uuid>string</uuid>
<version>0</version>
</invoice_for_customer_model>
<invoice_for_customer_model>
<account_holder>string</account_holder>
<account_imported_on>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</account_imported_on>
<additional_descr>string</additional_descr>
<amount>1.01</amount>
<cc_profile_id>0</cc_profile_id>
<charge_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</charge_date>
<charge_type>string</charge_type>
<creation_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</creation_date>
<currency_code>AED</currency_code>
<email>string</email>
<id>0</id>
<import_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</import_date>
<invoice_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</invoice_date>
<invoice_due_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</invoice_due_date>
<invoice_number>string</invoice_number>
<invoice_state>DRAFT</invoice_state>
<last_tx_type>string</last_tx_type>
<opened>0</opened>
<paid>PAID</paid>
<payment_method>string</payment_method>
<period_end_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</period_end_date>
<period_start_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</period_start_date>
<policy>string</policy>
<resend>1</resend>
<sent_times>0</sent_times>
<uuid>string</uuid>
<version>0</version>
</invoice_for_customer_model>
{ } InvoiceForCustomerModel
account_holder
required
string
account_imported_on
required
string
additional_descr
optional
string
amount
required
number
cc_profile_id
required
integer
charge_date
optional
string
charge_type
optional
string
creation_date
required
string
currency_code
required
string
email
required
string
id
required
integer
import_date
required
string
invoice_date
required
string
invoice_due_date
required
string
invoice_number
required
string
invoice_state
required
string
last_tx_type
optional
string
opened
optional
integer
paid
required
string
payment_method
optional
string
period_end_date
optional
string
period_start_date
optional
string
policy
required
string
resend
required
boolean
sent_times
optional
integer
uuid
required
string
version
required
integer