SimpleAPI Available versions: 1.0 2.0

NAV

getInvoices

POST /v2/invoice/list

Whenever you'd like to obtain a list of invoices for a specific customer, use this endpoint. This call will allow you to search for invoices by specific patterns, filter them using date ranges, and even sort them in ascending or descending order. Use this call when you want to list all customer invoices in one table and reflect the outstanding balance.

Parameters
Name
Description
customer_id 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
}
{ } InvoiceListFilterV2Model
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_description": "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",
        "customer_id": "string",
        "email": "string",
        "id": 0,
        "import_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "invoice_date": "string",
        "invoice_due_date": "string",
        "invoice_number": "string",
        "invoice_owner_account_id": 0,
        "invoice_reminder_schema": "DEFAULT",
        "invoice_state": "DRAFT",
        "last_tx_type": "string",
        "opened": 0,
        "paid": "PAID",
        "payment_method": "string",
        "period_end_date": "string",
        "period_start_date": "string",
        "resend": true,
        "sent_times": 0,
        "uuid": "string",
        "version": 0
    }
]
{ } InvoicePreviewV2Model
account_holder required string
account_imported_on optional string
additional_description 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
customer_id required string
email required string
id required integer
import_date optional string
invoice_date required string
invoice_due_date required string
invoice_number required string
invoice_owner_account_id optional integer
invoice_reminder_schema 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
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>
{ } InvoiceListFilterV2Model
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_preview_models>
  <invoice_preview_model>
    <account_holder>string</account_holder>
    <account_imported_on>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</account_imported_on>
    <additional_description>string</additional_description>
    <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>
    <customer_id>string</customer_id>
    <email>string</email>
    <id>0</id>
    <import_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</import_date>
    <invoice_date>string</invoice_date>
    <invoice_due_date>string</invoice_due_date>
    <invoice_number>string</invoice_number>
    <invoice_owner_account_id>0</invoice_owner_account_id>
    <invoice_reminder_schema>DEFAULT</invoice_reminder_schema>
    <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>string</period_end_date>
    <period_start_date>string</period_start_date>
    <resend>1</resend>
    <sent_times>0</sent_times>
    <uuid>string</uuid>
    <version>0</version>
  </invoice_preview_model>
</invoice_preview_models>
{ } InvoicePreviewV2Model
account_holder required string
account_imported_on optional string
additional_description 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
customer_id required string
email required string
id required integer
import_date optional string
invoice_date required string
invoice_due_date required string
invoice_number required string
invoice_owner_account_id optional integer
invoice_reminder_schema 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
resend required boolean
sent_times optional integer
uuid required string
version required integer