Create Vendor Master
Inbound | POST | /master/vendors
Summary
This API creates vendor masters in Assure.
Description
ERP systems recognise their vendors/suppliers with a code which is commonly referred to as vendor code. This API can be used to create vendors corresponding to the ERP vendors in Assure.
Request body
| Code Block | ||
|---|---|---|
| ||
{
"vendorCode": "ErpVendorCode",
"name": "name",
"isExcessGrnAllowed": true,
"address": {
"name": "vendor",
"line1": "address line 1",
"line2": "address line 2",
"line3": "address line 3",
"city": "Bengaluru",
"state": "Karnataka",
"zip": "560076",
"country": "INDIA",
"email": "email.com",
"phone": "9999999999"
}
} |
...
Parameter Name
...
Data Type
...
Description
...
Mandatory
...
vendorCode
...
String
...
Code used by ERP to identify vendors
...
yes
...
name
...
String
...
Name of vendor
...
yes
...
isExcessGrnAllowed
...
boolean
...
isExcessGrnAllowed for the supplier
...
No
...
address
...
Object
...
Address of vendor
...
yes
...
address.name
...
String
...
Name of vendor
...
yes
...
address.line1
...
String
...
1st line of vendor’s address
...
yes
...
address.line2
...
String
...
2nd line of vendor’s address
...
no
...
address.line3
...
String
...
3rd line of vendor’s address
...
no
...
address.city
...
String
...
City of vendor
...
yes
...
address.state
...
String
...
State of vendor
...
yes
...
address.zip
...
String
...
ZIP/Pin code of vendor
...
yes
...
address.country
...
String
...
Country of vendor
...
yes
...
address.email
...
String
...
Email of vendor
...
yes
...
address.phone
...
String
...
Phone Number of vendor
...
no
Response
EmptyBody
HttpStatus : 200
Update Vendor Master
Inbound | PUT | /master/vendors
Summary
This API updates vendor masters in Assure.
Description
This API can be used to update vendors which were already created by Create Vendor Master API. Except vendorCode, all fields are updatable.
...
Parameter Name | Data Type | Description | Mandatory |
| String | Code used by ERP to identify vendors | yes |
| String | Name of vendor | yes |
| boolean | isExcessGrnAllowed for the supplier | No |
| Object | Address of vendor | yes |
| String | Name of vendor | yes |
| String | 1st line of vendor’s address | yes |
| String | 2nd line of vendor’s address | no |
| String | 3rd line of vendor’s address | no |
| String | City of vendor | yes |
| String | State of vendor | yes |
| String | ZIP/Pin code of vendor | yes |
| String | Country of vendor | yes |
| String | Email of vendor | yes |
| String | Phone Number of vendor | no |
Response
EmptyBody
HttpStatus : 200
...
Inbound | GET | /master/vendors/{vendorCode}
Summary
This API returns vendor master data available for a vendor code in Assure.
Description
This API returns vendor master data available for a vendor code in Assure.
Request
EmptyBody
Response
{
"vendorCode":"ErpVendorCode",
...