GEgetswipe
Customer

Add a customer

Changed on

v1 is deprecated — use the v2 endpoint instead. Creates a customer keyed by your own id. Sending an ID that already exists fails with CUSTOMER_ALREADY_EXISTS — use Update a customer to change an existing record. Customers are also created automatically when a document references an unknown party.id.

post/v1/customer

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v1/customer
  • Auth
    HTTP bearer

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

Example request

{
  "customer_id": "123",
  "name": "TATA RATAN",
  "email": "reddi@reddi.reddi",
  "discount": 10,
  "gstin": "27AARCS7202C1ZD",
  "company_name": "GSTN",
  "opening_balance": "1245",
  "credit_limit": 200,
  "billing_address": [
    {
      "pincode": "500075",
      "state": "State Name",
      "country": "India"
    }
  ],
  "shipping_address": [
    {
      "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"
}

Response

Success

successboolean

Success flag

messagestring

Response message

Example response

{
  "success": true,
  "message": "Customer added successfully"
}

Changes