# Client 🎨

# Client Create 🎨

📌 POST:/client/clientcreate

# Resource URL

https://api.jamku.app/client/clientcreate

# Request (Body)

  • clientno : String Alpha Numeric Max 10 Characters
  • fname* : String Min 2 and Max 60 Characters
  • lname | cname : String and Max 50 Characters
  • autogroupcreate* : Contains 0,1
  • groupno : String Alpha Numeric Max 10 Characters
  • groupname : String Alpha Numeric Max 50 Characters.
  • pan : String Max 10 Characters
  • dob : String Date
  • category | pcenter | ccenter : String Alpha Numeric Max 20 characters

Note:

  1. For creating a client, the user needs to have hasmaster permission.
  2. fname, lname, cname indicates client's first name, last name and company name respectively.
  3. If clientno is not provided, the respective client gets assigned the next clientno based on previous clientno, after the master is setup.
  4. When autogroupcreate is 1, you can enter your own group name or else the api will generate group name automatically for the specific client by combining the first 50 characters of client's fname,lname,cname together as a group name. The groupno is also generated by the api in this case.
  5. When autogroupcreate is 0. It is mandatory to provide groupno, as it signify that the client is been created for an existing group.

# Example Request

// Example 1
{
  "clientno": "C0001",
  "fname":"Yogesh",
  "lname":"Kudikala", 
  "cname":"Yogesh & Associates",
  "autogroupcreate": 1,
  "groupno":"",
  "groupname":"Yogesh & Group",
  "pan":"ABCDEFGHIJ",
  "dob":"1997-01-06", // (YYYY-MM-DD) format
  "category":"Company",
  "pcenter":"Partner 1",
  "ccenter":"Branch 1"
}
// Example 2
{
  "clientno": "C0001",
  "fname":"Yogesh",
  "lname":"Kudikala", 
  "cname":"Yogesh & Associates",
  "autogroupcreate": 0,
  "groupno":"G0001",
  "groupname":"",
  "pan":"ABCDEFGHIJ",
  "dob":"1997-01-06", // (YYYY-MM-DD) format
  "category":"Company",
  "pcenter":"Partner 1",
  "ccenter":"Branch 1"
}

# Response

// Success
{
  "data": [
    {...}
    {...}
  ],
  "success":true,
  "clientno":"clientno", 
  "groupno":"groupno",
  "msg": "Client Created"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Client View 🎨

📌 POST:/client/clientview

# Request (Body)

  • clientno : String Alpha Numeric Max 10 Characters`

  • Client view consists of the following data

    • client: Contains information about the client and group to which the client belongs.
    • tags: Involves tags which can be used to categorize clients uniquely.
    • otherclients: Includes clients which belong to the same group as that of viewed client.
    • clientteam: Includes staff who are assigned the work of respective client.
    • contacts: The public information of the client (ex: mobile no) can be viewed by any of your staff. But, for vieweing the client private contact details(ex: passwords ), the staff needs to have hascontactview permission.
    • stat: The components of stat includes taskno of the task going, stuck, passed target date, passed due date, pending bill, pending reminder, pending hearing.

# Response

// Success
{
  "data": {
    "client":{...},
    "tags":[...],
    "otherClients": [{...},{...}],
    "clientteam":[...],
    "contacts": [{...},{...}],
    "stat": {
      "taskgoing":[...],
      "taskstuck":[...],
      "taskovertarget":[...],
      "taskoverdue":[...],
      "taskbillpending":[...],
      "reminderpending":[...],
      "hearingpending":[...]
    }
},
  "success":true,
  "msg": "Client Loaded"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Client Search 🎨

📌 POST:/client/clientsearch

# Request (Body)

  • rf : Integer Only - 0,1,2
  • isactive : Integer Only - 0,1
  • search : String
  • clientnos | groupnos : Array, Max 1000
  • page | limit: Integer

The search will have effect only if string length is more than or equal to 2.

# Response

// Success
{
  "data": [
    {
      "clientno": "C0001",
      "groupno": "G0001",
      "fname": "Bhavesh 😎",
      "lname": "Balaji Jwellers",
      "cname": "",
      "pan": "",
      "dob": "2016-04-19",
      "c_category": "Important",
      "c_pcenter": "Partner 1",
      "c_ccenter": "Department 1",
      "isdeleted": 0,
      "g_category": "",
      "g_pcenter": "",
      "g_ccenter": "",
      "groupname": "Hingad",
      "tags": [ "Jwell", "Director" ],
      "isnew": false
    },
    {...},
    {...}
  ],
  "success": true,
  "msg": "Clients loaded",
  "params": {...}
}

The params will contain all the data sent to API

# Client Tag Add 🎨

📌 POST:/client/clienttagadd

# Resource URL

https://api.jamku.app/client/clienttagadd

# Request (body)

  • clientno* : String Alpha Numeric, Max 10 characters
  • tagname* : String Alpha Numeric, Max 10 characters

Note:

  1. For adding tags the user needs to have hasmaster permission.

# Example request

// Example
{
  "clientno":"C0001",
  "tagname":"Mumbai"
}

# Response

// Example
{
  "success": true, 
  "msg": "Tag Created", 
  "params": {...}, 
  "no": "clientno"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Client Tag Delelte 🎨

📌 POST:/client/clienttagdelete

# Resource URL

https://api.jamku.app/client/clienttagdelete

# Request (body)

  • clientno* : String Alpha Numeric, Max 10 characters.
  • tagname* : min 1 Characters are allowed.

Note :

  1. For deleting client tag needs to have hasmaster permission .

# Example Request

// Example
{
  "clientno":"C0001",
  "tagname":"Mumbai"
}

# Response

// Example
{
  "success": true, 
  "msg": "Tag Deleted", 
  "params": {...}, 
  "no": "clientno"
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}

# Client Delete

📌 POST:/client/clientdelete

# Resource URL

https://api.jamku.app/client/clientdelete

# Request (body)

  • clientno* : String Alpha Numeric, Max 10 characters.

Note :

  1. For deleting client tag needs to have hasdelete permission .
  2. If the Client has task files reminders left then it cannot be deleted .

# Example Request

// Example
{
  "clientno":"C0001",
  
}

# Response

// Example
{
  "success": true, 
  "msg": "client Deleted", 
}
// Error
{
  "error": [],
  "success":false,
  "msg":"Check Parameters"
}
Last Updated: 21 Jul 2020