SimpleAPI Available versions: 1.0 2.0

NAV

getCustomers

POST /customer/list

The following endpoint allows the developer to access SimplePin’s API in order to obtain a list of all customers associated with the current company. This call allows you to search for customers 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 your customers in one table and reflect their outstanding balance.

Parameters
Name
Description
customerListFilterModel (required)

This is the data that is required to return a list of customers associated with the company.

Response Messages
Code
Description
200
OK
201
Created
401
Unauthorized
403
Forbidden
404
Not Found 
             {
    "date_from": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "date_to": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "search": "string",
    "sort": "POLICY",
    "ascending": true,
    "first": 0,
    "count": 0,
    "filter_type": "NONE"
}
{ } CustomerListFilterModel
date_from optional string
date_to optional string
search optional string
sort optional string
ascending optional boolean
first optional integer
count optional integer
filter_type optional string 
             [
    {
        "account_holder": "string",
        "customer_since": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "email": "string",
        "has_invoice": true,
        "id": 0,
        "imported_on": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "outstanding_models": [
            {
                "amount": 1.01,
                "cc_id": 0,
                "currency_code": "AED"
            }
        ],
        "phone": "string",
        "policy": "string",
        "status": "string"
    }
]
{ } CustomerModel
account_holder optional string
customer_since optional string
email optional string
has_invoice optional boolean
id optional integer
imported_on optional string
outstanding_models optional array|OutstandingAmountModel
phone optional string
policy optional string
status optional string
{ } OutstandingAmountModel
amount optional number
cc_id optional integer
currency_code optional string 
             <customer_list_filter_model>
  <date_from>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</date_from>
  <date_to>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</date_to>
  <search>string</search>
  <sort>POLICY</sort>
  <ascending>1</ascending>
  <first>0</first>
  <count>0</count>
  <filter_type>NONE</filter_type>
</customer_list_filter_model>
{ } CustomerListFilterModel
date_from optional string
date_to optional string
search optional string
sort optional string
ascending optional boolean
first optional integer
count optional integer
filter_type optional string 
             <customer_model>
  <account_holder>string</account_holder>
  <customer_since>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</customer_since>
  <email>string</email>
  <has_invoice>1</has_invoice>
  <id>0</id>
  <imported_on>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</imported_on>
  <outstanding_model>
    <amount>1.01</amount>
    <cc_id>0</cc_id>
    <currency_code>AED</currency_code>
  </outstanding_model>
  <outstanding_model>
    <amount>1.01</amount>
    <cc_id>0</cc_id>
    <currency_code>AED</currency_code>
  </outstanding_model>
  <phone>string</phone>
  <policy>string</policy>
  <status>string</status>
</customer_model>
<customer_model>
  <account_holder>string</account_holder>
  <customer_since>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</customer_since>
  <email>string</email>
  <has_invoice>1</has_invoice>
  <id>0</id>
  <imported_on>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</imported_on>
  <outstanding_model>
    <amount>1.01</amount>
    <cc_id>0</cc_id>
    <currency_code>AED</currency_code>
  </outstanding_model>
  <outstanding_model>
    <amount>1.01</amount>
    <cc_id>0</cc_id>
    <currency_code>AED</currency_code>
  </outstanding_model>
  <phone>string</phone>
  <policy>string</policy>
  <status>string</status>
</customer_model>
{ } CustomerModel
account_holder optional string
customer_since optional string
email optional string
has_invoice optional boolean
id optional integer
imported_on optional string
outstanding_models optional array|OutstandingAmountModel
phone optional string
policy optional string
status optional string
{ } OutstandingAmountModel
amount optional number
cc_id optional integer
currency_code optional string