GEgetswipe
Vendor V2

Add a vendor

Changed on

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

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/vendor
  • Auth
    HTTP bearer

Request body

vendor_idstring required

Your Vendor ID

namestring required

Vendor 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

statusstring

Status

tagsstring[]

List of tags

visibilityinteger

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 request

{
  "vendor_id": "123",
  "name": "TATA RATAN",
  "email": "reddi@reddi.reddi",
  "discount": 10,
  "gstin": "27AARCS7202C1ZD",
  "company_name": "GSTN",
  "opening_balance": "1245",
  "credit_limit": 200,
  "billing_address": {
    "addr_id": -1,
    "addr_id_v2": "addr1",
    "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",
  "status": "Active",
  "custom_fields": [
    {
      "label": "Custom Field 1",
      "value": "Value 1"
    }
  ],
  "visibility": 1
}

Response

Success

successboolean

Success flag

messagestring

Response message

error_codestring

Error Code

errorsobject

Errors

Example response

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

Changes

  • 0bcdbc62187bRevision changes
    • breaking

      removed the enum value Korea North of the request property /

    • breaking

      removed the enum value Korea South of the request property /

    • info

      api operation id v2_post_vendor removed and replaced with post_vendor

    • info

      added the new optional request property

    • info

      the request property / became optional

    • info

      the request property / became optional

    • info

      added the new LADAKH(NEWLY ADDED) enum value to the request property /

    • info

      added the new Republic of Korea (South Korea) enum value to the request property /

    • info

      removed the pattern ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+(\.[a-zA-Z]{2,5})+$ from the request property