Add New Vendor | DICE | Documentation

curl -X POST https://heimdall.eka.io/apis/external/vendor/addVendor \
     -H "DICE-APP-ID: {{Company Code}}" \
     -H "X-CLIENT-ID: {{API Client ID}}" \
     -H "X-CLIENT-SECRET: {{API Client Secret}}" \
     -H "Content-Type: application/json" \
     -d '{
  "request": {
    "id": "INDIAN-0001",
    "connection": "true ",
    "basic": {
      "name": "INDIAN",
      "tradeName": "INDIAN",
      "email": "indian@gmail.com",
      "mobile": "0000000000",
      "currency": "INR"
    },
    "address": {
      "address": "Pune",
      "city": "Pune",
      "contact": "1234567890",
      "pincode": "123456",
      "lat": 0,
      "lng": 0
    },
    "bank": {
      "account": "1234567890",
      "ifsc": "abc1234567",
      "name": "prime",
      "bankName": "abcd bank"
    },
    "others": {
      "msme": "",
      "msmeNumber": "",
      "categories": [
        1,
        2
      ],
      "paymentTerms": {}
    },
    "tax": {
      "gst": "",
      "gstinCertificate": "",
      "pan": ""
    },
    "validGst": false,
    "validMobile": false,
    "validPan": false
  },
  "paymentTerm": 30,
  "roleList": []
}'

Add Vendor

This API facilitates the addition of a vendor to the DIce.

By utilizing this endpoint, you can seamlessly add a new vendor to the Dice database.

Request Body

Param	Required	Type	Description
id	Mandatory	String	The unique identifier for the vendor.
connection	Mandatory	String	The connection information for the vendor.
basic.name	Mandatory	String	The name of the vendor.
basic.tradeName	Mandatory	String	The trade name of the vendor.
basic.email	Mandatory	String	The email address of the vendor.
basic.mobile	Mandatory	String	The mobile number of the vendor.
basic.currency	Mandatory	String	The currency used by the vendor.
address.address	Mandatory	String	The address of the vendor.
address.city	Mandatory	String	The city of the vendor.
address.contact	Mandatory	String	The contact information for the vendor.
address.pincode	Mandatory	String	The pin code of the vendor.
address.lat	Optional	Number	The latitude coordinate of the vendor’s location.
address.lng	Optional	Number	The longitude coordinate of the vendor’s location.
bank.account	Optional	String	The bank account number of the vendor.
bank.ifsc	Optional	String	The IFSC code of the vendor’s bank.
bank.name	Optional	String	The name associated with the bank account.
bank.bankName	Optional	String	The name of the vendor’s bank.
others.msme	Optional	String	Additional MSME information for the vendor.
others.msmeNumber	Optional	String	The MSME number for the vendor.
others.categories	Mandatory	Array	The categories associated with the vendor.
others.paymentTerms	Optional	Object	The payment terms for the vendor.
tax.gst	Optional	String	The GST number of the vendor.
tax.gstinCertificate	Optional	String	The GSTIN certificate for the vendor.
tax.pan	Optional	String	The PAN number of the vendor.
validGst	Optional	Boolean	Indicates whether the GST number is valid.
validMobile	Optional	Boolean	Indicates whether the mobile number is valid.
validPan	Optional	Boolean	Indicates whether the PAN number is valid.
roleList	Optional	Array	RoleList of Vendor
paymentTerm	Optional	Number	Vendor payment terms in Days

Response

success (boolean): Indicates whether the vendor addition was successful.

Example

1 {
2     "success": true
3 }

### Add Vendor This API facilitates the addition of a vendor to the DIce. By utilizing this endpoint, you can seamlessly add a new vendor to the Dice database. ### Request Body | Param | Required | Type | Description | | --- | --- | --- | --- | | id | Mandatory | String | The unique identifier for the vendor. | | connection | Mandatory | String | The connection information for the vendor. | | basic.name | Mandatory | String | The name of the vendor. | | basic.tradeName | Mandatory | String | The trade name of the vendor. | | basic.email | Mandatory | String | The email address of the vendor. | | basic.mobile | Mandatory | String | The mobile number of the vendor. | | basic.currency | Mandatory | String | The currency used by the vendor. | | address.address | Mandatory | String | The address of the vendor. | | address.city | Mandatory | String | The city of the vendor. | | address.contact | Mandatory | String | The contact information for the vendor. | | address.pincode | Mandatory | String | The pin code of the vendor. | | address.lat | Optional | Number | The latitude coordinate of the vendor's location. | | address.lng | Optional | Number | The longitude coordinate of the vendor's location. | | bank.account | Optional | String | The bank account number of the vendor. | | bank.ifsc | Optional | String | The IFSC code of the vendor's bank. | | bank.name | Optional | String | The name associated with the bank account. | | bank.bankName | Optional | String | The name of the vendor's bank. | | others.msme | Optional | String | Additional MSME information for the vendor. | | others.msmeNumber | Optional | String | The MSME number for the vendor. | | others.categories | Mandatory | Array | The categories associated with the vendor. | | others.paymentTerms | Optional | Object | The payment terms for the vendor. | | tax.gst | Optional | String | The GST number of the vendor. | | tax.gstinCertificate | Optional | String | The GSTIN certificate for the vendor. | | tax.pan | Optional | String | The PAN number of the vendor. | | validGst | Optional | Boolean | Indicates whether the GST number is valid. | | validMobile | Optional | Boolean | Indicates whether the mobile number is valid. | | validPan | Optional | Boolean | Indicates whether the PAN number is valid. | | roleList | Optional | Array | RoleList of Vendor | | paymentTerm | Optional | Number | Vendor payment terms in Days | ### Response - `success` (boolean): Indicates whether the vendor addition was successful. ### Example ``` json { "success": true } ```

Request

This endpoint expects an object.

requestobjectRequired

paymentTermintegerRequired

roleListlist of anyRequired

Response

successboolean

Param

Required

Type

Description

Mandatory

String

The unique identifier for the vendor.

connection

Mandatory

String

The connection information for the vendor.

basic.name

Mandatory

String

The name of the vendor.

basic.tradeName

Mandatory

String

The trade name of the vendor.

basic.email

Mandatory

String

The email address of the vendor.

basic.mobile

Mandatory

String

The mobile number of the vendor.

basic.currency

Mandatory

String

The currency used by the vendor.

address.address

Mandatory

String

The address of the vendor.

address.city

Mandatory

String

The city of the vendor.

address.contact

Mandatory

String

The contact information for the vendor.

address.pincode

Mandatory

String

The pin code of the vendor.

address.lat

Optional

Number

The latitude coordinate of the vendor’s location.

address.lng

Optional

Number

The longitude coordinate of the vendor’s location.

bank.account

Optional

String

The bank account number of the vendor.

bank.ifsc

Optional

String

The IFSC code of the vendor’s bank.

bank.name

Optional

String

The name associated with the bank account.

bank.bankName

Optional

String

The name of the vendor’s bank.

others.msme

Optional

String

Additional MSME information for the vendor.

others.msmeNumber

Optional

String

The MSME number for the vendor.

others.categories

Mandatory

Array

The categories associated with the vendor.

others.paymentTerms

Optional

Object

The payment terms for the vendor.

tax.gst

Optional

String

The GST number of the vendor.

tax.gstinCertificate

Optional

String

The GSTIN certificate for the vendor.

tax.pan

Optional

String

The PAN number of the vendor.

validGst

Optional

Boolean

Indicates whether the GST number is valid.

validMobile

Optional

Boolean

Indicates whether the mobile number is valid.

validPan

Optional

Boolean

Indicates whether the PAN number is valid.

roleList

Optional

Array

RoleList of Vendor

paymentTerm

Optional

Number

Vendor payment terms in Days

Add Vendor

Request Body

Response

Example

Headers

Request

Response

Add Vendor

Request Body

Response

Example