Skip to main content

Update Company API

Overview​

Updates corporate client information, credit limits, or active status.

  • Endpoint: /api/companies/update
  • Method: POST
  • Access: Super Admin / Platform RM

Request Body Schema​

FieldTypeRequiredDescription
idString (UUID)YesTarget company ID
nameStringNoUpdated display name
legalNameStringNoRegistered legal entity name
gstinStringNo15-character GSTIN
gstTypeEnumNoREGISTERED, UNREGISTERED, COMPOSITION, or SEZ
panNumberStringNo10-character PAN number
addressStringNoOffice street address
phoneStringNoContact phone number
emailIdStringNoOfficial contact email address
creditLimitNumberNoUpdated credit limit
creditDaysNumberNoUpdated credit days
activeBooleanNoEnable/disable company access

Request Body Example​

{
"id": "c478a846-993d-4c8d-bf8d-d77cb3370e01",
"name": "Abbott Healthcare",
"legalName": "Abbott Healthcare India Private Limited",
"gstin": "27AAACA0000A1Z5",
"gstType": "REGISTERED",
"panNumber": "AAACA0000A",
"address": "123 Business Park, BKC",
"phone": "+912212345678",
"emailId": "info@abbott.com",
"creditLimit": 1500000,
"creditDays": 45,
"active": true
}

Success Response (200 OK)​

{
"success": true,
"message": "Company updated successfully",
"data": {
"id": "c478a846-993d-4c8d-bf8d-d77cb3370e01",
"name": "Abbott Healthcare",
"creditLimit": "1500000.00",
"creditDays": 45
}
}

Database Impact​

  • Table: companies
  • Operations: UPDATE record by ID.