Add a vendor

Creates a vendor keyed by your own id. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor party.id.

POST /v2/vendor

Add a vendor

cURL

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"
}
'

201

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

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

email · string

Email address

Example:

"[e-mail]"

discount · integer

Discount

Example:

10

gstin · string

GSTIN

Pattern: ^(|[0-9A-Z]{15})$

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

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:

"[e-mail],[e-mail]"

status · string

Status

Example:

"Active"

tags · string[]

List of tags

custom_fields · object[]

Vendor Custom Fields. Custom fields should already be added in Swipe Portal.

Show child attributes

Example:

[
  {
    "label": "Custom Field 1",
    "value": "Value 1"
  }
]

visibility · integer

Vendor visibility status: If the value is 1, the vendor will be visible to all branches; otherwise, it will only be visible in the main branch.

Example:

1

Response

201

application/json

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