updateCustomer

PATCH/api/v0/customer/{customerId}

Request

Path Params

customerId

string

required

customerId

Match pattern:

^KC[A-Z0-9]{14}$

Query Params

parentCompanyId

string

optional

parentCompanyId

Match pattern:

^CEK[A-Z0-9]{7}$

accountNumber

object (JsonNullable«string»)

optional

Unique account number for the customer

address

object (JsonNullable«string»)

optional

Physical address of the customer

assignedAgent

object (JsonNullable«string»)

optional

Name of the agent assigned to the customer

branchCodes

object (JsonNullable«List«string»»)

optional

Codes of branches associated with the customer

contactNumber

object (JsonNullable«string»)

optional

Contact number of the customer

customerId

object (JsonNullable«string»)

optional

Unique identifier for the customer

customerKeyContacts

object (JsonNullable«List«CustomerKeyContactCreateDTO»»)

optional

Key contact persons for the customer

customerReminders

object (JsonNullable«List«CustomerReminderCreateDTO»»)

optional

Reminders for the customer

ifsc

object (JsonNullable«string»)

optional

IFSC code for the customer's bank

legalName

object (JsonNullable«string»)

optional

Legal name of the customer

panOrGstin

object (JsonNullable«string»)

optional

PAN or GSTIN of the customer

pinCode

object (JsonNullable«string»)

optional

PIN code of the customer's address

state

object (JsonNullable«string»)

optional

State of the customer's address

uniqueRefNo

object (JsonNullable«string»)

optional

Unique reference number for the customer

{
  "accountNumber": {},
  "address": {},
  "assignedAgent": {},
  "branchCodes": {},
  "contactNumber": {},
  "customerId": {},
  "customerKeyContacts": {},
  "customerReminders": {},
  "ifsc": {},
  "legalName": {},
  "panOrGstin": {},
  "pinCode": {},
  "state": {},
  "uniqueRefNo": {}
}

Request samples

Responses

OK(200)

Bad Request(400)

Unauthorized(401)

Forbidden(403)

Not Found(404)

Unprocessable Request(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

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 (CustomerResponse)

optional

accountNumber

string

optional

active

boolean

optional

address

string

optional

assignedAgent

string

optional

bankName

string

optional

branchCodes

array[string]

optional

companyId

string

optional

contactEmail

string

optional

contactNumber

string

optional

createdBy

string

optional

createdByName

string

optional

createdOn

string <date-time>

optional

customerId

string

optional

customerKeyContacts

array[object (CustomerKeyContactResponse) {14}]

optional

customerLogo

string

optional

customerReminders

array[object (CustomerReminderConfigResponse) {7}]

optional

dsoMedian

integer <int64>

optional

integer <int64>

optional

ifsc

string

optional

legalName

string

optional

modifiedBy

string

optional

modifiedByName

string

optional

modifiedOn

string <date-time>

optional

netAmount

number

optional

panOrGstin

string

optional

parentCompanyId

string

optional

parentLegalName

string

optional

pinCode

string

optional

state

string

optional

uniqueRefNo

string

optional

warnings

array[string]

optional

response_code

integer <int32>

optional

response_message

string

optional

Not configured

Last modified: 3 months ago