Sign in

v1

latestOpenAPI 3.0.12026-07-263591116.9 KB
Customer V2

Update a customer

put/v2/customer

Request body

customer_idstring required

Your Customer ID

namestring required

Customer name

phonestring

Phone number

emailstring

Email address

discountinteger

Discount

gstinstring

GSTIN

company_namestring

Company name

opening_balancestring

Opening balance

credit_limitinteger

Credit limit

opening_balance_typeinteger

Credit[0] / Debit[1]

dial_codestring

Dial code

profile_imagestring

Profile image URL

panstring

PAN

notesstring

Notes

cc_emailsstring

CC email addresses

tagsstring[]

List of tags

visibilityinteger

If set to 1, the customer will be visible to all branches. If set to 0, the customer will be visible only to the branch it was created in.

Example request

{
  "customer_id": "123",
  "name": "TATA RATAN",
  "phone": "1234567890",
  "email": "reddi@reddi.reddi",
  "discount": 10,
  "gstin": "27AARCS7202C1ZD",
  "company_name": "GSTN",
  "opening_balance": "1245",
  "credit_limit": 200,
  "billing_address": [
    {
      "addr_id": -1,
      "addr_id_v2": "addr1",
      "pincode": "500075",
      "state": "State Name",
      "country": "India"
    }
  ],
  "shipping_address": [
    {
      "addr_id": -1,
      "addr_id_v2": "addr1",
      "pincode": "500075",
      "state": "State Name",
      "country": "India"
    }
  ],
  "opening_balance_type": 1,
  "dial_code": "91",
  "pan": "ABCD1234F",
  "notes": "Testing api",
  "cc_emails": "reddi@reddi.reddi,acb.a@bcd.con",
  "custom_fields": [
    {
      "label": "Custom Field 1",
      "value": "Value 1"
    }
  ],
  "visibility": 1
}

Response

Success

successboolean

Success flag

messagestring

Response message

error_codestring

Error Code

errorsobject

Errors

Example response

{
  "success": true,
  "data": {
    "message": "No data found!"
  }
}
All 35 operations