Enkash Developer Portal
Home
Home
Login
  1. Customer Apis
  • Back to home
  • Account Receivable APIs
  • Get Authentication Token Copy
    • Get Authentication Token
  • Customer Management
    • Customer Apis
      • Activate customer
        PUT
      • createBulkCustomer
        POST
      • bulkUpdate
        POST
      • Deactivate customer
        PUT
      • deleteCustomerByCustomerId
        DELETE
      • updateCustomer
        PATCH
  • Customer Contacts Management
    • Customer Apis
      • getCustomerContactDetails
  • Invoice Management
    • invoice-controller
      • createInvoice
      • invoiceBulkUpload
      • Dispatch Invoice Collection
      • Delete Invoice Collection
      • searchCollectionInvoices
      • getInvoice
      • updateInvoice
  • Payment Reminders
    • customer-reminder-controller
      • createCustomerReminder
      • getCustomerReminders
      • getCustomerReminder
      • deleteReminder
      • updateCustomerReminder
  • Bharat Connect 2.0 AR
    • Payment Confirmation Request
    • Change Invoice Status Request
    • Bulk Create Invoice
  1. Customer Apis

deleteCustomerByCustomerId

DELETE
/api/v0/customer/{customerId}
Customer Apis

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}$

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://test.your-api-server.com/api/v0/customer/'

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
string 
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": "string",
    "response_code": 0,
    "response_message": "string"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠422Unprocessable Request
🔴500Server Error
Modified at 2025-07-07 18:44:30
Previous
Deactivate customer
Next
updateCustomer
Built with