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.
Request
{
"vendorCode":"ErpVendorCode",
"name": "name",
"isExcessGrnAllowed":true/false,
"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
Search Vendor Master
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",
"name": "name",
"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"
}
}
HttpStatus : 200
...
Parameter Name
...
Data Type
...
Description
...
vendorCode
...
String
...
Code used by ERP to identify vendors
...
name
...
String
...
Name of vendor
...
address
...
Object
...
Address of vendor
...
address.name
...
String
...
Name of vendor
...
address.line1
...
String
...
1st line of vendor’s address
...
address.line2
...
String
...
2nd line of vendor’s address
...
address.line3
...
String
...
3rd line of vendor’s address
...
address.city
...
String
...
City of vendor
...
address.state
...
String
...
State of vendor
...
address.zip
...
String
...
ZIP/Pin code of vendor
...
address.country
...
String
...
Country of vendor
...
address.email
...
String
...
Email of vendor
...
address.phone
...
String
...
Child pages (Children Display) |
---|
What is a Vendor and Vendor location code for Increff?
Vendors
In Increff system both suppliers and customers are vendors.
Inward and outward orders can be placed against both with appropriate order type.
Vendor Locations
Each vendor can have multiple locations. If order is created with vendor codes then specifying the vendor location code is also mandatory. Vendor location code is unique for a vendor and can repeat for different vendors.
What is the significance of Vendor and Vendor Locations
While creating orders with Vendor codes, Vendor code and vendor location code is mandatory and its used to identify the sources and destination of Inward / outward orders.
For outward orders, Vendor and Vendor Location information is also used for generated Invoices documents and pack box label documents.
What happens on duplicate create requests for Customers and Vendors (Vendor)?
Duplicate calls to create Customers and Vendors (Vendor) are idempotent. No changes will be made to the existing Customers or Vendors and a 200-OK response will be sent by the API
Is Vendor Location creation mandatory and what to do if our (ERP) system don't have Vendor location code?
If you don't have VendorLocationCodes at your end then two approaches can be followed:
Use a single, constant Location Code for all the Vendors
Set the Location Code same as the Vendor code
What are the meanings of address(Vendor), billing(VendorLocation) and shipping address(VendorLocation) of Vendor and Vendor locations?
The Vendor’s Address represents the geographic location of a Vendor’s headquarters
The Vendor’s Location has two aspects - the billing address and the shipping address. The address that the Vendor desires to use for billing and shipping purposes must be specified in the Vendor’s billing and shipping address data. These three addresses might or might not be the same
What are the unique fields (primary key) in Vendor and Vendor location creation?
For Vendor, the name and VendorType values must be unique across all Vendor. For Vendor Location, no unique constraints exist.
What if GSTIN is not available for Vendor location creation?
The GSTIN field is a mandatory field. A value must be provided for this field