Tuhund - List of customers of a branch with basic details

API # : 8009 | API Name : customers

This API gets filtered, sort and ordered records of active customers of a branch. Single branch entities also need to pass branch ID as this, and all other similar API, theat a sole entity also as a branch. This is so that, if in future, the organization adds a branch, branches or business entity, integrators (third party developers) do not have to revisit their code and make changes to include branch ID.

URL : <domain>/apic/companies
Methods Allowed : POST
Request Body : JSON Payload

Payload Structure :

Name	Description	Type
bid	Branch ID of the branch for which data is required.	String
search	Search text.	String
show2	Customer Group. Customer policy group that controls group level discounts, policies, thresholds and rules.	String
show3	Marketing Zone ID.	String
show4	Industry ID to filter customers from a particular industry	String
show5	Country. Two character country code.	String
pp	Number of records per page. All the matching records are split in sets similar to pages. This value tells the system how many records have to be grouped under each page. Default value is 100	Integer
page	Page number. Default is 1	Integer
srt	Sort by. Possible values are : COMPANYNAME : Company name COMPANYNUMBER : Company number SHORTNAME : Short name CITY : City STATE : State COUNTRYNAME : Country GSTIN : GST Number CREDITLIMIT : Credit Limit	String
order	Sort Order. ASC or DESC	String

Request Headers :

Name	Description
device	A short name of your application. Device is mandatory but any value between 3 and 20 characters is accepted.
Authentication	Authentication code generated for API call.

Sample Payload :

{
    "bid":"branch id",
    "search": "computers",
    "show3": "asiazone",
    "page": 1,
    "pp": 50
}

Sample success response :

{
  "response": 1,
  "totalitems": 100,
  "list": [
    {
      "stateid": "91001",
      "balance": -1546,
      "companyid": "VOE54Y",
      "creditlimit": 0,
      "countrycode": "in",
      "companynumber": 1056,
      "status": 1,
      "priority": 4,
      "assignmenttype": 0,
      "branchid": "ENTERPRISE",
      "available": -1546,
      "companyname": "Nexus Technologies"
    },
    {
      "stateid": "91012",
      "countrycode": "in",
      "companynumber": 1237,
      "status": 1,
      "gstin": "29ZZA5565565",
      "branchid": "ENTERPRISE",
      "available": 43214.913,
      "tin": "55678876112",
      "companyname": "Noble consultants",
      "city": "Bangalore",
      "companyid": "OOuUS2",
      "balance": 43214.913,
      "creditlimit": 0,
      "priority": 4,
      "assignmenttype": 0
    },
    ......
  ]
}

Response Interpretation :

Key	Description
totalitems	Total Number of items matching search criteria