Get Started
Document V2
Payment V2
Customer V2
Vendor V2
Product V2
Inventory V2
Subscriptions V2
Utility V2
Update a customer
Copy
curl --request PUT \
--url https://app.getswipe.in/api/partner/v2/customer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer_id": "123",
"name": "TATA RATAN",
"phone": "1234567890",
"email": "[email protected]",
"discount": 10,
"gstin": "27AARCS7202C1ZD",
"company_name": "GSTN",
"opening_balance": "1245",
"credit_limit": 200,
"billing_address": [
{
"state": "State Name",
"country": "India",
"addr_id": -1,
"addr_id_v2": "addr1",
"address_line1": "",
"address_line2": "",
"pincode": "500075",
"city": ""
}
],
"shipping_address": [
{
"state": "State Name",
"country": "India",
"addr_id": -1,
"addr_id_v2": "addr1",
"address_line1": "",
"address_line2": "",
"pincode": "500075",
"city": ""
}
],
"opening_balance_type": 1,
"dial_code": "91",
"profile_image": "",
"pan": "ABCD1234F",
"notes": "Testing api",
"cc_emails": "[email protected],[email protected]",
"tags": [
"<string>"
],
"custom_fields": [
{
"label": "Custom Field 1",
"value": "Value 1"
}
],
"visibility": 1
}
'Copy
{
"success": true,
"message": "",
"error_code": "",
"errors": {},
"data": {
"message": "No data found!"
}
}Customer V2
Update a customer
PUT
/
v2
/
customer
Update a customer
Copy
curl --request PUT \
--url https://app.getswipe.in/api/partner/v2/customer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer_id": "123",
"name": "TATA RATAN",
"phone": "1234567890",
"email": "[email protected]",
"discount": 10,
"gstin": "27AARCS7202C1ZD",
"company_name": "GSTN",
"opening_balance": "1245",
"credit_limit": 200,
"billing_address": [
{
"state": "State Name",
"country": "India",
"addr_id": -1,
"addr_id_v2": "addr1",
"address_line1": "",
"address_line2": "",
"pincode": "500075",
"city": ""
}
],
"shipping_address": [
{
"state": "State Name",
"country": "India",
"addr_id": -1,
"addr_id_v2": "addr1",
"address_line1": "",
"address_line2": "",
"pincode": "500075",
"city": ""
}
],
"opening_balance_type": 1,
"dial_code": "91",
"profile_image": "",
"pan": "ABCD1234F",
"notes": "Testing api",
"cc_emails": "[email protected],[email protected]",
"tags": [
"<string>"
],
"custom_fields": [
{
"label": "Custom Field 1",
"value": "Value 1"
}
],
"visibility": 1
}
'Copy
{
"success": true,
"message": "",
"error_code": "",
"errors": {},
"data": {
"message": "No data found!"
}
}Authorizations
Bearer authentication header of the form Bearer
Body
application/json
Your Customer ID
Example:
"123"
Customer name
Example:
"TATA RATAN"
Phone number
Example:
"1234567890"
Email address
Example:
Discount
Example:
10
GSTIN
Example:
"27AARCS7202C1ZD"
Company name
Example:
"GSTN"
Opening balance
Example:
"1245"
Credit limit
Example:
200
List of billing addresses
Show child attributes
Show child attributes
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 Example:
"State Name"
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 Example:
"India"
Address ID. It will automatically update the existing address if the address ID already exists.
Example:
-1
Address ID. It must be alphanumeric, not empty, and up to 16 characters long.
Example:
"addr1"
Address line 1
Example:
""
Address line 2
Example:
""
Pincode
Example:
"500075"
City
Example:
""
List of shipping addresses
Show child attributes
Show child attributes
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 Example:
"State Name"
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 Example:
"India"
Address ID. It will automatically update the existing address if the address ID already exists.
Example:
-1
Address ID. It must be alphanumeric, not empty, and up to 16 characters long.
Example:
"addr1"
Address line 1
Example:
""
Address line 2
Example:
""
Pincode
Example:
"500075"
City
Example:
""
Credit[0] / Debit[1]
Example:
1
Dial code
Example:
"91"
Profile image URL
Example:
""
PAN
Example:
"ABCD1234F"
Notes
Example:
"Testing api"
CC email addresses
Example:
List of tags
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:
1
⌘I