CUSTOMERS

LIST: GET /api/clients/customers

Returns collection of customers in JSON format. Company ID must be provided as URL param.

Resource URL 

/api/clients/customers or /api/clients/customers?companyId={companyId} or
/api/clients/customers?companyId={companyId}&start={start}&limit={limit}

Resource Properties

ACCOUNTS DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
companyId number required The ID of the company for which to return the customerss.
start number optional Specify beginning of paging
limit number optional Specify end of paging

Example <base_url>/api/clients/customers?companyId=2132

Response

{
    "count": 11,
    "list": [
        {
            "name": "BRUCE",
            "customerType": "CUSTOMER",
            "ledgerName": "BRUCE [CUST-4745]",
            "ledgerId": 17737028,
            "clientType": "CUSTOMER",
            "companyId": 6621,
            "pinNo": "233",
            "txnCurrName": "Kenyan Shilling [KES]",
            "txnCurrId": 641,
            "allBills": 0,
            "clearedBills": 0,
            "pendingBills": 0,
            "overdueBills": 0,
            "journalized": 0.00,
            "invoices": 0.00,
            "payments": 0.00,
            "status": "ACTIVE",
            "accountNo": "4745",
            "clientGroupingId": 2665,
            "clientGroupingName": "GENERAL",
            "noOfRepeatInv": 0,
            "id": 17739049
        },
        {
            "name": "DRAKE",
            "customerType": "CUSTOMER",
            "ledgerName": "DRAKE [CUST-4953]",
            "ledgerId": 6100538,
            "clientType": "CUSTOMER",
            "companyId": 6621,
            "pinNo": "-",
            "txnCurrName": "Kenyan Shilling [KES]",
            "txnCurrId": 641,
            "allBills": 1,
            "clearedBills": 0,
            "pendingBills": 1,
            "overdueBills": 1,
            "amtOverdue": 20000.00,
            "balance": 20000.00,
            "journalized": 0.00,
            "invoices": 21000.00,
            "payments": 0.00,
            "status": "ACTIVE",
            "accountNo": "4953",
            "clientGroupingId": 2666,
            "clientGroupingName": "TENANT",
            "noOfRepeatInv": 0,
            "id": 6100539
        },
        {
            "name": "FIKA APARTMENTS",
            "contactPerson": "WILLY",
            "customerType": "CUSTOMER",
            "ledgerName": "FIKA APARTMENTS [CUST-1209364312237]",
            "ledgerId": 16211913,
            "invoicingAddress": "
?P.O BOX 3455456-0007889
NAIROBI
",
            "telno": "1235788",
            "clientType": "CUSTOMER",
            "companyId": 6621,
            "pinNo": "P345677532235K",
            "txnCurrName": "Kenyan Shilling [KES]",
            "txnCurrId": 641,
            "allBills": 1,
            "clearedBills": 1,
            "pendingBills": 0,
            "overdueBills": 1,
            "amtOverdue": 0.00,
            "balance": 0.00,
            "journalized": 0.00,
            "invoices": 56000.00,
            "payments": 56000.00,
            "status": "ACTIVE",
            "accountNo": "1209364312237",
            "clientGroupingId": 2665,
            "clientGroupingName": "GENERAL",
            "noOfRepeatInv": 0,
            "id": 16227946
        },
        {
            "name": "FREDRICK OMONDI",
            "customerType": "CUSTOMER",
            "ledgerName": "FREDRICK OMONDI [CUST-0720396310]",
            "ledgerId": 16369774,
            "invoicingAddress": "DOLNHOLM PHASE 8 HSE 22",
            "telno": "0720396310",
            "clientType": "CUSTOMER",
            "companyId": 6621,
            "pinNo": "-",
            "txnCurrName": "Kenyan Shilling [KES]",
            "txnCurrId": 641,
            "allBills": 4,
            "clearedBills": 0,
            "pendingBills": 4,
            "overdueBills": 4,
            "amtOverdue": 1095.00,
            "balance": 1095.00,
            "journalized": 0.00,
            "invoices": 1200.00,
            "payments": 105.00,
            "status": "ACTIVE",
            "accountNo": "0720396310",
            "clientGroupingId": 6999723,
            "clientGroupingName": "GARBAGE COLLECTION",
            "noOfRepeatInv": 1,
            "id": 16370481
        },
        {
            "name": "FUZU",
            "contactPerson": "powel mwanza",
            "customerType": "CUSTOMER",
            "ledgerName": "ALPHA TOWERS [PL-P0003A]",
            "ledgerId": 46143,
            "invoicingAddress": "3657767",
            "shippingAddress": "564657675",
            "telno": "0756646444545",
            "clientType": "CUSTOMER",
            "companyId": 6621,
            "pinNo": "45677798",
            "txnCurrName": "Kenyan Shilling [KES]",
            "txnCurrId": 641,
            "allBills": 1,
            "clearedBills": 0,
            "pendingBills": 1,
            "overdueBills": 1,
            "amtOverdue": 3292.00,
            "balance": 3292.00,
            "journalized": 1000.00,
            "invoices": 9292.00,
            "payments": 4700.00,
            "status": "ACTIVE",
            "accountNo": "46578997977",
            "clientGroupingId": 2666,
            "clientGroupingName": "TENANT",
            "noOfRepeatInv": 0,
            "id": 2838743
        }
    ]
}

LOAD: GET /api/customers/load/{id}

Returns customers details in JSON format. ID must be provided as path parameter.

Resource URL 

/api/customers/load/{id}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
id number required The ID of the employee to load details.

Response status

HTTP Status Code Reason
200 Found Record
404 Record not found
405 Invalid input
500 Internal server error

Example <base_url>/api/customers/load/2428

Response

{
success:true,
results:6,
rows:[
{
"ledger":"BAIA BUILDING [PROP03139]",
"overdue_bills":0,
"pending_bills":0,
"contactperson":"",
"curr_id":424,
"cleared_bills":0,
"inv_address":"",
"client_type":"Customer",
"telno":"",
"all_bills":0,
"pin_no":"",
"balance":0.00,"name":"john Doe",
"client_cat":"Customer",
"currency":"Kenyan Shilling [KES]",
"amt_overdue":0.00,"id":11088,"ship_address":"",
"ledger_id":3140,
"email":"",
"status":"Active"
}
]
}