Customer
Add a customer
Customer
Add a customer
POST
/
v1
/
customer
Authorization
string
*
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
object
*
customer_id
string
customer_id
string
Your Customer ID
Add Example Value
name
string
*
name
Required
string
Customer name
Add Example Value
phone
string
phone
string
Phone number
Add Example Value
email
string
email
string
Email address
Add Example Value
discount
integer
discount
integer
Discount
Add Example Value
gstin
string
gstin
string
GSTIN
Add Example Value
company_name
string
company_name
string
Company name
Add Example Value
opening_balance
string
opening_balance
string
Opening balance
Add Example Value
credit_limit
integer
credit_limit
integer
Credit limit
Add Example Value
billing_address
array
billing_address
array
List of billing addresses
shipping_address
array
shipping_address
array
List of shipping addresses
opening_balance_type
integer
opening_balance_type
integer
Credit[0] / Debit[1]
Add Example Value
dial_code
string
dial_code
string
Dial code
Add Example Value
profile_image
string
profile_image
string
Profile image URL
Add Example Value
pan
string
pan
string
PAN
Add Example Value
notes
string
notes
string
Notes
Add Example Value
cc_emails
string
cc_emails
string
CC email addresses
Add Example Value
status
string
status
string
Status
Add Example Value
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Customer name
Your Customer ID
Phone number
Email address
Discount
GSTIN
Company name
Opening balance
Credit limit
List of billing addresses
Address line 1
Address line 2
Pincode
City
State. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details
Available options:
JAMMU AND KASHMIR, HIMACHAL PRADESH, PUNJAB, CHANDIGARH, UTTARAKHAND, HARYANA, DELHI, RAJASTHAN, UTTAR PRADESH, BIHAR, SIKKIM, ARUNACHAL PRADESH, NAGALAND, MANIPUR, MIZORAM, TRIPURA, MEGHALAYA, ASSAM, WEST BENGAL, JHARKHAND, ODISHA, CHHATTISGARH, MADHYA PRADESH, GUJARAT, DADRA & NAGAR HAVELI & DAMAN & DIU, MAHARASHTRA, ANDHRAPRADESH(BEFOREADDED), KARNATAKA, GOA, LAKSHWADEEP, KERALA, TAMIL NADU, PUDUCHERRY, ANDAMAN & NICOBAR, TELANGANA, ANDHRA PRADESH, LADAKH(NEWLYADDED), OTHER TERRITORY Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
Available options:
Afghanistan, Albania, Algeria, Andorra, Angola, Antigua and Barbuda, Argentina, Armenia, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bhutan, Bolivia, Bosnia and Herzegovina, Botswana, Brazil, Brunei, Bulgaria, Burkina Faso, Burundi, Cabo Verde, Cambodia, Cameroon, Canada, Central African Republic, Chad, Chile, China, Colombia, Comoros, Congo, Democratic Republic of the, Congo, Republic of the, Costa Rica, Croatia, Cuba, Cyprus, Czechia, Denmark, Djibouti, Dominica, Dominican Republic, Ecuador, Egypt, El Salvador, Equatorial Guinea, Eritrea, Estonia, Eswatini, Ethiopia, Fiji, Finland, France, Gabon, Gambia, Georgia, Germany, Ghana, Greece, Grenada, Guatemala, Guinea, Guinea-Bissau, Guyana, Haiti, Honduras, Hungary, Iceland, India, Indonesia, Iran, Iraq, Ireland, Israel, Italy, Jamaica, Japan, Jordan, Kazakhstan, Kenya, Kiribati, Korea, North, Korea, South, Kosovo, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Mauritania, Mauritius, Mexico, Micronesia, Moldova, Monaco, Mongolia, Montenegro, Morocco, Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands, New Zealand, Nicaragua, Niger, Nigeria, North Macedonia, Norway, Oman, Pakistan, Palau, Palestine, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Poland, Portugal, Qatar, Romania, Russia, Rwanda, Saint Kitts and Nevis, Saint Lucia, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Sudan, Spain, Sri Lanka, Sudan, Suriname, Sweden, Switzerland, Syria, Taiwan, Tajikistan, Tanzania, Thailand, Timor-Leste, Togo, Tonga, Trinidad and Tobago, Tunisia, Turkey, Turkmenistan, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom, United States, Uruguay, Uzbekistan, Vanuatu, Vatican City, Venezuela, Vietnam, Yemen, Zambia, Zimbabwe List of shipping addresses
Address line 1
Address line 2
Pincode
City
State. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details
Available options:
JAMMU AND KASHMIR, HIMACHAL PRADESH, PUNJAB, CHANDIGARH, UTTARAKHAND, HARYANA, DELHI, RAJASTHAN, UTTAR PRADESH, BIHAR, SIKKIM, ARUNACHAL PRADESH, NAGALAND, MANIPUR, MIZORAM, TRIPURA, MEGHALAYA, ASSAM, WEST BENGAL, JHARKHAND, ODISHA, CHHATTISGARH, MADHYA PRADESH, GUJARAT, DADRA & NAGAR HAVELI & DAMAN & DIU, MAHARASHTRA, ANDHRAPRADESH(BEFOREADDED), KARNATAKA, GOA, LAKSHWADEEP, KERALA, TAMIL NADU, PUDUCHERRY, ANDAMAN & NICOBAR, TELANGANA, ANDHRA PRADESH, LADAKH(NEWLYADDED), OTHER TERRITORY Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
Available options:
Afghanistan, Albania, Algeria, Andorra, Angola, Antigua and Barbuda, Argentina, Armenia, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bhutan, Bolivia, Bosnia and Herzegovina, Botswana, Brazil, Brunei, Bulgaria, Burkina Faso, Burundi, Cabo Verde, Cambodia, Cameroon, Canada, Central African Republic, Chad, Chile, China, Colombia, Comoros, Congo, Democratic Republic of the, Congo, Republic of the, Costa Rica, Croatia, Cuba, Cyprus, Czechia, Denmark, Djibouti, Dominica, Dominican Republic, Ecuador, Egypt, El Salvador, Equatorial Guinea, Eritrea, Estonia, Eswatini, Ethiopia, Fiji, Finland, France, Gabon, Gambia, Georgia, Germany, Ghana, Greece, Grenada, Guatemala, Guinea, Guinea-Bissau, Guyana, Haiti, Honduras, Hungary, Iceland, India, Indonesia, Iran, Iraq, Ireland, Israel, Italy, Jamaica, Japan, Jordan, Kazakhstan, Kenya, Kiribati, Korea, North, Korea, South, Kosovo, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Mauritania, Mauritius, Mexico, Micronesia, Moldova, Monaco, Mongolia, Montenegro, Morocco, Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands, New Zealand, Nicaragua, Niger, Nigeria, North Macedonia, Norway, Oman, Pakistan, Palau, Palestine, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Poland, Portugal, Qatar, Romania, Russia, Rwanda, Saint Kitts and Nevis, Saint Lucia, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Sudan, Spain, Sri Lanka, Sudan, Suriname, Sweden, Switzerland, Syria, Taiwan, Tajikistan, Tanzania, Thailand, Timor-Leste, Togo, Tonga, Trinidad and Tobago, Tunisia, Turkey, Turkmenistan, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom, United States, Uruguay, Uzbekistan, Vanuatu, Vatican City, Venezuela, Vietnam, Yemen, Zambia, Zimbabwe Credit[0] / Debit[1]
Dial code
Profile image URL
PAN
Notes
CC email addresses
Status