searchCustomer - Enkash APIs

Request

Query Params

direction

enum<string>

optional

Allowed values:

ASCDESC

limit

integer <int32>

optional

<= 5000

offset

integer <int32>

optional

orderBy

string

optional

Body Params application/json

accountNumber

string

optional

Unique account number for the customer

assignedAgent

string

optional

Name of the agent assigned to the customer

balanceAmount

number

optional

Current balance amount for the customer

companyId

string

optional

Unique identifier for the company

contactNumber

string

optional

Contact number of the customer

createdByName

string

optional

Name of the person who created the record

createdOnFrom

string <date-time>

optional

Start date for the creation date range filter

createdOnTo

string <date-time>

optional

End date for the creation date range filter

customerIds

array[string]

optional

List of customer IDs

customerStatus

enum<string>

optional

Status of the customer

Allowed values:

ACTIVEALLINACTIVE

dsoFrom

integer <int32>

optional

Start value for the Days Sales Outstanding (DSO) range

dsoTo

integer <int32>

optional

End value for the Days Sales Outstanding (DSO) range

ifsc

string

optional

IFSC code for the customer's bank

legalName

string

optional

Legal name of the customer

level

enum<string>

optional

Level of the customer

Allowed values:

LEVEL_1LEVEL_2LEVEL_3

modifiedByName

string

optional

Name of the person who last modified the record

modifiedOn

string <date-time>

optional

Date and time when the record was last modified

panOrGstin

string

optional

PAN or GSTIN of the customer

parentCompanyId

string

optional

Unique identifier for the parent company

selectAll

boolean

optional

Flag to select all customers

uniqueRefNo

string

optional

Unique reference number for the customer

Example

{
  "accountNumber": "string",
  "assignedAgent": "string",
  "balanceAmount": 0,
  "companyId": "string",
  "contactNumber": "string",
  "createdByName": "string",
  "createdOnFrom": "2019-08-24T14:15:22Z",
  "createdOnTo": "2019-08-24T14:15:22Z",
  "customerIds": [
    "string"
  ],
  "customerStatus": "ACTIVE",
  "dsoFrom": 0,
  "dsoTo": 0,
  "ifsc": "string",
  "legalName": "string",
  "level": "LEVEL_1",
  "modifiedByName": "string",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "panOrGstin": "string",
  "parentCompanyId": "string",
  "selectAll": true,
  "uniqueRefNo": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

errorResponse

object (ErrorResponse)

optional

apiSubErrors

array[object (ApiSubError)]

optional

errorMessage

string

optional

errorType

enum<string>

optional

Allowed values:

CLIENT_REQUEST_ABORTCLIENT_REQUEST_ERRORINVALID_ACCESSRECORD_NOT_FOUNDSYSTEM_ERRORUNAUTHORIZEDUNKNOWN_ERRORUNPROCESSABLE_REQUESTVALIDATION_ERROR

requestId

string

optional

timestamp

string

optional

Example:

yyyy-MM-dd HH:mm:ss

payload

object (GenericPaginationResponse«CustomerResponse»)

optional

data

array[object (CustomerResponse) {31}]

optional

recordsCount

integer <int64>

optional

response_code

integer <int32>

optional

response_message

string

optional

Example

{
  "errorResponse": {
    "apiSubErrors": [
      {}
    ],
    "errorMessage": "string",
    "errorType": "CLIENT_REQUEST_ABORT",
    "requestId": "string",
    "timestamp": "yyyy-MM-dd HH:mm:ss"
  },
  "payload": {
    "data": [
      {
        "accountNumber": "string",
        "active": true,
        "address": "string",
        "assignedAgent": "string",
        "bankName": "string",
        "branchCodes": [
          "string"
        ],
        "companyId": "string",
        "contactEmail": "string",
        "contactNumber": "string",
        "createdBy": "string",
        "createdByName": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "customerId": "string",
        "customerKeyContacts": [
          {
            "createdBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "customerId": "string",
            "customerName": "string",
            "deleted": "string",
            "email": "string",
            "keyContactPersonId": "string",
            "mail_enabled": true,
            "mobile": "string",
            "modifiedBy": "string",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "name": "string",
            "sms_enabled": true,
            "whatsapp_enabled": true
          }
        ],
        "customerLogo": "string",
        "customerReminders": [
          {
            "customerId": "string",
            "customerReminderId": "string",
            "dueDateDifference": 0,
            "reminderInterval": 0,
            "reminderTime": "HH:mm",
            "reminderType": "ONCE",
            "stage": "string"
          }
        ],
        "dsoMedian": 0,
        "id": 0,
        "ifsc": "string",
        "legalName": "string",
        "modifiedBy": "string",
        "modifiedByName": "string",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "netAmount": 0,
        "panOrGstin": "string",
        "parentCompanyId": "string",
        "parentLegalName": "string",
        "pinCode": "string",
        "state": "string",
        "uniqueRefNo": "string",
        "warnings": [
          "string"
        ]
      }
    ],
    "recordsCount": 0
  },
  "response_code": 0,
  "response_message": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠422Unprocessable Request

🔴500Server Error