Add a vendor

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/vendor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vendor_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": ""
  },
  "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
}
'

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "message": "No data found!"
  }
}

POST

vendor

Add a vendor

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/vendor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vendor_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": ""
  },
  "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
}
'

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "message": "No data found!"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer , where is your auth token.

Body

application/json

vendor_id

string

required

Your Vendor ID

Example:

"123"

name

string

required

Vendor name

Example:

"TATA RATAN"

phone

string

Phone number

Example:

"1234567890"

string

Email address

Example:

"[email protected]"

discount

integer

Discount

Example:

10

gstin

string

GSTIN

Example:

"27AARCS7202C1ZD"

company_name

string

Company name

Example:

"GSTN"

opening_balance

string

Opening balance

Example:

"1245"

credit_limit

integer

Credit limit

Example:

200

billing_address

object

Show child attributes

billing_address.state

enum<string>

required

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"

billing_address.country

enum<string>

required

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"

billing_address.addr_id

integer

Address ID. It will automatically update the existing address if the address ID already exists.

Example:

-1

billing_address.addr_id_v2

string

Address ID. It must be alphanumeric, not empty, and up to 16 characters long.

Example:

"addr1"

billing_address.address_line1

string

Address line 1

Example:

""

billing_address.address_line2

string

Address line 2

Example:

""

billing_address.pincode

string

Pincode

Example:

"500075"

billing_address.city

string

City

Example:

""

opening_balance_type

integer

Credit[0] / Debit[1]

Example:

1

dial_code

string

Dial code

Example:

"91"

profile_image

string

Profile image URL

Example:

""

pan

string

PAN

Example:

"ABCD1234F"

notes

string

Notes

Example:

"Testing api"

cc_emails

string

CC email addresses

Example:

"[email protected],[email protected]"

Response

Success

success

boolean

Success flag

Example:

true

message

string

Response message

Example:

""

error_code

string

Error Code

Example:

""

errors

object

Errors

data

object

Show child attributes

data.message

string

Response message

Example:

"No data found!"

Update a vendor Get payment ledger

⌘I

Get Started

Document V2

Payment V2

EwayBill

Customer V2

Vendor V2

Product V2

Inventory V2

Subscriptions V2

Utility V2

Add a vendor

Authorizations

Body

Response