POST api/Vendor/Add

Add Vendor. If the vendor does not pass the validation rules, the error message will contain the vendor code and a list of errors for that vendor code.

Request Information

URI Parameters

None.

Body Parameters

Vendor

Name	Description	Type	Additional information
ClientId	Client Id required.	integer	Required
VendorGuid	Vendor Guid Not required. System generated.	globally unique identifier	None.
CompanyId	Company Id Not required. System generated.	integer	None.
CompanyCode	Company Code Only required when multiple companies are used and vendors are unique by company	string	None.
VendorCode	Vendor Code Required: Max Length 50 characters	string	Required
VendorName	Vendor Name Required: Max Length 200 characters	string	Required
Address1	Remit to Address Line 1	string	Required
Address2	Remit to Address Line 2	string	None.
City	Remit to Address City	string	Required
State	Remit to Address State	string	Required
Zip	Remit to Address Zip/Postal Code	string	Required
Country	Remit to Address Country code	string	None.
ContactName	Vendor Contact Name	string	None.
ContactPhone	Vendor Contact Phone	string	None.
ContactEmail	Vendor Contact Email	string	None.
AccountNumber	Default customer account number	string	None.
RoutingNumber	Vendor payment routing number	string	None.
BankAccount	Vendor payment bank account number	string	None.
RemitType	Remit Type	string	None.
PaymentMethod	Default payment method	string	None.
PaymentTerms	Vendor payment Terms	string	None.
Notes	Vendor notes	string	None.
UserDefined1	User Defined field 1 - See implemenation documentation	string	None.
UserDefined2	User Defined field 2 - See implemenation documentation	string	None.
UserDefined3	User Defined field 3 - See implemenation documentation	string	None.
UserDefined4	User Defined field 4 - See implemenation documentation	string	None.
UserDefined5	User Defined field 5 - See implemenation documentation	string	None.
UserDefined6	User Defined field 6 - See implemenation documentation	string	None.
UserDefined7	User Defined field 7 - See implemenation documentation	string	None.
UserDefined8	User Defined field 8 - See implemenation documentation	string	None.
UserDefined9	User Defined field 9 - See implemenation documentation	string	None.
UserDefined10	User Defined field 10 - See implemenation documentation	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "VendorGuid": "ff1a1a48-0244-4fc9-adf4-8b77d8c5f404",
  "CompanyId": 1,
  "CompanyCode": "sample string 2",
  "VendorCode": "sample string 3",
  "VendorName": "sample string 4",
  "Address1": "sample string 5",
  "Address2": "sample string 6",
  "City": "sample string 7",
  "State": "sample string 8",
  "Zip": "sample string 9",
  "Country": "sample string 10",
  "ContactName": "sample string 11",
  "ContactPhone": "sample string 12",
  "ContactEmail": "sample string 13",
  "AccountNumber": "sample string 14",
  "RoutingNumber": "sample string 15",
  "BankAccount": "sample string 16",
  "RemitType": "sample string 17",
  "PaymentMethod": "sample string 18",
  "PaymentTerms": "sample string 19",
  "Notes": "sample string 20",
  "UserDefined1": "sample string 21",
  "UserDefined2": "sample string 22",
  "UserDefined3": "sample string 23",
  "UserDefined4": "sample string 24",
  "UserDefined5": "sample string 25",
  "UserDefined6": "sample string 26",
  "UserDefined7": "sample string 27",
  "UserDefined8": "sample string 28",
  "UserDefined9": "sample string 29",
  "UserDefined10": "sample string 30"
}

application/xml, text/xml

Sample:

<VendorController.Vendor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers">
  <AccountNumber>sample string 14</AccountNumber>
  <Address1>sample string 5</Address1>
  <Address2>sample string 6</Address2>
  <BankAccount>sample string 16</BankAccount>
  <City>sample string 7</City>
  <ClientId>1</ClientId>
  <CompanyCode>sample string 2</CompanyCode>
  <CompanyId>1</CompanyId>
  <ContactEmail>sample string 13</ContactEmail>
  <ContactName>sample string 11</ContactName>
  <ContactPhone>sample string 12</ContactPhone>
  <Country>sample string 10</Country>
  <Notes>sample string 20</Notes>
  <PaymentMethod>sample string 18</PaymentMethod>
  <PaymentTerms>sample string 19</PaymentTerms>
  <RemitType>sample string 17</RemitType>
  <RoutingNumber>sample string 15</RoutingNumber>
  <State>sample string 8</State>
  <UserDefined1>sample string 21</UserDefined1>
  <UserDefined10>sample string 30</UserDefined10>
  <UserDefined2>sample string 22</UserDefined2>
  <UserDefined3>sample string 23</UserDefined3>
  <UserDefined4>sample string 24</UserDefined4>
  <UserDefined5>sample string 25</UserDefined5>
  <UserDefined6>sample string 26</UserDefined6>
  <UserDefined7>sample string 27</UserDefined7>
  <UserDefined8>sample string 28</UserDefined8>
  <UserDefined9>sample string 29</UserDefined9>
  <VendorCode>sample string 3</VendorCode>
  <VendorGuid>ff1a1a48-0244-4fc9-adf4-8b77d8c5f404</VendorGuid>
  <VendorName>sample string 4</VendorName>
  <Zip>sample string 9</Zip>
</VendorController.Vendor>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Processing results

APIResult

Name	Description	Type	Additional information
IsValid	API call result	boolean	None.
Comments	Comments about the activities of the API call	string	None.
Errors	List of 0 to many errors encountered processing the API call	Collection of ErrorMessage	None.

Response Formats

application/json, text/json

Sample:

{
  "IsValid": true,
  "Comments": "sample string 2",
  "Errors": [
    {
      "Message": "sample string 1"
    },
    {
      "Message": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<APIResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextProcess.Web.API.Controllers.Util">
  <Comments>sample string 2</Comments>
  <Errors>
    <APIResult.ErrorMessage>
      <Message>sample string 1</Message>
    </APIResult.ErrorMessage>
    <APIResult.ErrorMessage>
      <Message>sample string 1</Message>
    </APIResult.ErrorMessage>
  </Errors>
  <IsValid>true</IsValid>
</APIResult>