POST VendorList/GetVendorList

Returns a list of Vendors

Request Information

URI Parameters

Body Parameters

A JSON string containing one or more Vendor IDs

Name	Description	Type	Additional Information
VendorID	ID of a vendor.	string	Max length: 10

Request Formats

application/json, text/json

Sample:

[
  {
    "VendorID": "sample string 1"
  },
  {
    "VendorID": "sample string 1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfVendorListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.AP">
  <VendorListRequest>
    <VendorID>sample string 1</VendorID>
  </VendorListRequest>
  <VendorListRequest>
    <VendorID>sample string 1</VendorID>
  </VendorListRequest>
</ArrayOfVendorListRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

Returns a list of Vendors

AgvVendorList

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many Vendors.	string
VendorRecords	JSON dictionary of VendorRecords.	Collection of clsVendor

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "VendorRecords": [
    {
      "VendorGUID": "44a39020-2e73-4bdb-9ac8-0025e423970a",
      "VendorID": "sample string 2",
      "Location": "sample string 3",
      "AccountNum": "sample string 4",
      "Name": "sample string 5",
      "Addr1": "sample string 6",
      "Addr2": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "Zipcode": "sample string 10",
      "Phone": "sample string 11",
      "Phone2": "sample string 12",
      "Fax": "sample string 13",
      "Web": "sample string 14",
      "Email": "sample string 15",
      "Notes": "sample string 16",
      "XRef1": "sample string 17",
      "XRef2": "sample string 18",
      "XRef3": "sample string 19",
      "XRef4": "sample string 20",
      "TermsCode": "sample string 21",
      "InActive": true,
      "Country": "sample string 23",
      "CompanyName1099": "sample string 27",
      "HoldPaymentYN": true,
      "OneBillPerCheck": true,
      "Pay2BankAcctNum": "sample string 30",
      "Pay2BankAcctType": "sample string 31",
      "Pay2ACHRouteNum": "sample string 32",
      "ACHEmailAddr": "sample string 33",
      "CurrentBalance": 34.1,
      "BeginningBalance": 35.1,
      "PrePay": 36.1,
      "BeginningPrePay": 37.1,
      "Month1Balance": 38.1,
      "Month2Balance": 39.1,
      "Month3Balance": 40.1,
      "Month4Balance": 41.1,
      "Month5Balance": 42.1,
      "Month6Balance": 43.1,
      "Month7Balance": 44.1,
      "Month8Balance": 45.1,
      "Month9Balance": 46.1,
      "Month10Balance": 47.1,
      "Month11Balance": 48.1,
      "Month12Balance": 49.1,
      "PrePayMonth1Balance": 50.1,
      "PrePayMonth2Balance": 51.1,
      "PrePayMonth3Balance": 52.1,
      "PrePayMonth4Balance": 53.1,
      "PrePayMonth5Balance": 54.1,
      "PrePayMonth6Balance": 55.1,
      "PrePayMonth7Balance": 56.1,
      "PrePayMonth8Balance": 57.1,
      "PrePayMonth9Balance": 58.1,
      "PrePayMonth10Balance": 59.1,
      "PrePayMonth11Balance": 60.1,
      "PrePayMonth12Balance": 61.1,
      "Type1099": "sample string 62",
      "TaxID": "sample string 63",
      "Paid1099": 64.1,
      "PaidTotal": 65.1,
      "AcctID": "sample string 66",
      "PayBy": "sample string 67",
      "ACHEmail": true,
      "ACHType": "sample string 70",
      "ACHFax": true,
      "ElectronicPO": true,
      "LocationName": "sample string 73",
      "AccountDescription": "sample string 74",
      "UniqueKey": 75,
      "VendorClass": [
        {
          "VendorClassKey": 1,
          "MasterClassNamesKey": 2,
          "VendorID": "sample string 3",
          "ClassName": "sample string 4"
        },
        {
          "VendorClassKey": 1,
          "MasterClassNamesKey": 2,
          "VendorID": "sample string 3",
          "ClassName": "sample string 4"
        }
      ],
      "VendorAttribute": [
        {
          "VendAttributesKey": 1,
          "VendorID": "sample string 2",
          "MasterCrossRefNamesKey": 3,
          "CrossRef": "sample string 4",
          "AttributeValue": "sample string 5"
        },
        {
          "VendAttributesKey": 1,
          "VendorID": "sample string 2",
          "MasterCrossRefNamesKey": 3,
          "CrossRef": "sample string 4",
          "AttributeValue": "sample string 5"
        }
      ]
    },
    {
      "VendorGUID": "44a39020-2e73-4bdb-9ac8-0025e423970a",
      "VendorID": "sample string 2",
      "Location": "sample string 3",
      "AccountNum": "sample string 4",
      "Name": "sample string 5",
      "Addr1": "sample string 6",
      "Addr2": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "Zipcode": "sample string 10",
      "Phone": "sample string 11",
      "Phone2": "sample string 12",
      "Fax": "sample string 13",
      "Web": "sample string 14",
      "Email": "sample string 15",
      "Notes": "sample string 16",
      "XRef1": "sample string 17",
      "XRef2": "sample string 18",
      "XRef3": "sample string 19",
      "XRef4": "sample string 20",
      "TermsCode": "sample string 21",
      "InActive": true,
      "Country": "sample string 23",
      "CompanyName1099": "sample string 27",
      "HoldPaymentYN": true,
      "OneBillPerCheck": true,
      "Pay2BankAcctNum": "sample string 30",
      "Pay2BankAcctType": "sample string 31",
      "Pay2ACHRouteNum": "sample string 32",
      "ACHEmailAddr": "sample string 33",
      "CurrentBalance": 34.1,
      "BeginningBalance": 35.1,
      "PrePay": 36.1,
      "BeginningPrePay": 37.1,
      "Month1Balance": 38.1,
      "Month2Balance": 39.1,
      "Month3Balance": 40.1,
      "Month4Balance": 41.1,
      "Month5Balance": 42.1,
      "Month6Balance": 43.1,
      "Month7Balance": 44.1,
      "Month8Balance": 45.1,
      "Month9Balance": 46.1,
      "Month10Balance": 47.1,
      "Month11Balance": 48.1,
      "Month12Balance": 49.1,
      "PrePayMonth1Balance": 50.1,
      "PrePayMonth2Balance": 51.1,
      "PrePayMonth3Balance": 52.1,
      "PrePayMonth4Balance": 53.1,
      "PrePayMonth5Balance": 54.1,
      "PrePayMonth6Balance": 55.1,
      "PrePayMonth7Balance": 56.1,
      "PrePayMonth8Balance": 57.1,
      "PrePayMonth9Balance": 58.1,
      "PrePayMonth10Balance": 59.1,
      "PrePayMonth11Balance": 60.1,
      "PrePayMonth12Balance": 61.1,
      "Type1099": "sample string 62",
      "TaxID": "sample string 63",
      "Paid1099": 64.1,
      "PaidTotal": 65.1,
      "AcctID": "sample string 66",
      "PayBy": "sample string 67",
      "ACHEmail": true,
      "ACHType": "sample string 70",
      "ACHFax": true,
      "ElectronicPO": true,
      "LocationName": "sample string 73",
      "AccountDescription": "sample string 74",
      "UniqueKey": 75,
      "VendorClass": [
        {
          "VendorClassKey": 1,
          "MasterClassNamesKey": 2,
          "VendorID": "sample string 3",
          "ClassName": "sample string 4"
        },
        {
          "VendorClassKey": 1,
          "MasterClassNamesKey": 2,
          "VendorID": "sample string 3",
          "ClassName": "sample string 4"
        }
      ],
      "VendorAttribute": [
        {
          "VendAttributesKey": 1,
          "VendorID": "sample string 2",
          "MasterCrossRefNamesKey": 3,
          "CrossRef": "sample string 4",
          "AttributeValue": "sample string 5"
        },
        {
          "VendAttributesKey": 1,
          "VendorID": "sample string 2",
          "MasterCrossRefNamesKey": 3,
          "CrossRef": "sample string 4",
          "AttributeValue": "sample string 5"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AgvVendorList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Vendor">
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
  <VendorRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AP">
    <d2p1:Vendor>
      <d2p1:ACHEmail>true</d2p1:ACHEmail>
      <d2p1:ACHEmailAddr>sample string 33</d2p1:ACHEmailAddr>
      <d2p1:ACHFax>true</d2p1:ACHFax>
      <d2p1:ACHType>sample string 70</d2p1:ACHType>
      <d2p1:AccountDescription>sample string 74</d2p1:AccountDescription>
      <d2p1:AccountNum>sample string 4</d2p1:AccountNum>
      <d2p1:AcctID>sample string 66</d2p1:AcctID>
      <d2p1:Addr1>sample string 6</d2p1:Addr1>
      <d2p1:Addr2>sample string 7</d2p1:Addr2>
      <d2p1:BeginningBalance>35.1</d2p1:BeginningBalance>
      <d2p1:BeginningPrePay>37.1</d2p1:BeginningPrePay>
      <d2p1:City>sample string 8</d2p1:City>
      <d2p1:CompanyName1099>sample string 27</d2p1:CompanyName1099>
      <d2p1:Country>sample string 23</d2p1:Country>
      <d2p1:CurrentBalance>34.1</d2p1:CurrentBalance>
      <d2p1:ElectronicPO>true</d2p1:ElectronicPO>
      <d2p1:Email>sample string 15</d2p1:Email>
      <d2p1:Fax>sample string 13</d2p1:Fax>
      <d2p1:HoldPaymentYN>true</d2p1:HoldPaymentYN>
      <d2p1:InActive>true</d2p1:InActive>
      <d2p1:Location>sample string 3</d2p1:Location>
      <d2p1:LocationName>sample string 73</d2p1:LocationName>
      <d2p1:Month10Balance>47.1</d2p1:Month10Balance>
      <d2p1:Month11Balance>48.1</d2p1:Month11Balance>
      <d2p1:Month12Balance>49.1</d2p1:Month12Balance>
      <d2p1:Month1Balance>38.1</d2p1:Month1Balance>
      <d2p1:Month2Balance>39.1</d2p1:Month2Balance>
      <d2p1:Month3Balance>40.1</d2p1:Month3Balance>
      <d2p1:Month4Balance>41.1</d2p1:Month4Balance>
      <d2p1:Month5Balance>42.1</d2p1:Month5Balance>
      <d2p1:Month6Balance>43.1</d2p1:Month6Balance>
      <d2p1:Month7Balance>44.1</d2p1:Month7Balance>
      <d2p1:Month8Balance>45.1</d2p1:Month8Balance>
      <d2p1:Month9Balance>46.1</d2p1:Month9Balance>
      <d2p1:Name>sample string 5</d2p1:Name>
      <d2p1:Notes>sample string 16</d2p1:Notes>
      <d2p1:OneBillPerCheck>true</d2p1:OneBillPerCheck>
      <d2p1:Paid1099>64.1</d2p1:Paid1099>
      <d2p1:PaidTotal>65.1</d2p1:PaidTotal>
      <d2p1:Pay2ACHRouteNum>sample string 32</d2p1:Pay2ACHRouteNum>
      <d2p1:Pay2BankAcctNum>sample string 30</d2p1:Pay2BankAcctNum>
      <d2p1:Pay2BankAcctType>sample string 31</d2p1:Pay2BankAcctType>
      <d2p1:PayBy>sample string 67</d2p1:PayBy>
      <d2p1:Phone>sample string 11</d2p1:Phone>
      <d2p1:Phone2>sample string 12</d2p1:Phone2>
      <d2p1:PrePay>36.1</d2p1:PrePay>
      <d2p1:PrePayMonth10Balance>59.1</d2p1:PrePayMonth10Balance>
      <d2p1:PrePayMonth11Balance>60.1</d2p1:PrePayMonth11Balance>
      <d2p1:PrePayMonth12Balance>61.1</d2p1:PrePayMonth12Balance>
      <d2p1:PrePayMonth1Balance>50.1</d2p1:PrePayMonth1Balance>
      <d2p1:PrePayMonth2Balance>51.1</d2p1:PrePayMonth2Balance>
      <d2p1:PrePayMonth3Balance>52.1</d2p1:PrePayMonth3Balance>
      <d2p1:PrePayMonth4Balance>53.1</d2p1:PrePayMonth4Balance>
      <d2p1:PrePayMonth5Balance>54.1</d2p1:PrePayMonth5Balance>
      <d2p1:PrePayMonth6Balance>55.1</d2p1:PrePayMonth6Balance>
      <d2p1:PrePayMonth7Balance>56.1</d2p1:PrePayMonth7Balance>
      <d2p1:PrePayMonth8Balance>57.1</d2p1:PrePayMonth8Balance>
      <d2p1:PrePayMonth9Balance>58.1</d2p1:PrePayMonth9Balance>
      <d2p1:State>sample string 9</d2p1:State>
      <d2p1:TaxID>sample string 63</d2p1:TaxID>
      <d2p1:TermsCode>sample string 21</d2p1:TermsCode>
      <d2p1:Type1099>sample string 62</d2p1:Type1099>
      <d2p1:UniqueKey>75</d2p1:UniqueKey>
      <d2p1:VendorAttribute>
        <d2p1:Attributes>
          <d2p1:AttributeValue>sample string 5</d2p1:AttributeValue>
          <d2p1:CrossRef>sample string 4</d2p1:CrossRef>
          <d2p1:MasterCrossRefNamesKey>3</d2p1:MasterCrossRefNamesKey>
          <d2p1:VendAttributesKey>1</d2p1:VendAttributesKey>
          <d2p1:VendorID>sample string 2</d2p1:VendorID>
        </d2p1:Attributes>
        <d2p1:Attributes>
          <d2p1:AttributeValue>sample string 5</d2p1:AttributeValue>
          <d2p1:CrossRef>sample string 4</d2p1:CrossRef>
          <d2p1:MasterCrossRefNamesKey>3</d2p1:MasterCrossRefNamesKey>
          <d2p1:VendAttributesKey>1</d2p1:VendAttributesKey>
          <d2p1:VendorID>sample string 2</d2p1:VendorID>
        </d2p1:Attributes>
      </d2p1:VendorAttribute>
      <d2p1:VendorClass>
        <d2p1:Classifications>
          <d2p1:ClassName>sample string 4</d2p1:ClassName>
          <d2p1:MasterClassNamesKey>2</d2p1:MasterClassNamesKey>
          <d2p1:VendorClassKey>1</d2p1:VendorClassKey>
          <d2p1:VendorID>sample string 3</d2p1:VendorID>
        </d2p1:Classifications>
        <d2p1:Classifications>
          <d2p1:ClassName>sample string 4</d2p1:ClassName>
          <d2p1:MasterClassNamesKey>2</d2p1:MasterClassNamesKey>
          <d2p1:VendorClassKey>1</d2p1:VendorClassKey>
          <d2p1:VendorID>sample string 3</d2p1:VendorID>
        </d2p1:Classifications>
      </d2p1:VendorClass>
      <d2p1:VendorGUID>44a39020-2e73-4bdb-9ac8-0025e423970a</d2p1:VendorGUID>
      <d2p1:VendorID>sample string 2</d2p1:VendorID>
      <d2p1:Web>sample string 14</d2p1:Web>
      <d2p1:XRef1>sample string 17</d2p1:XRef1>
      <d2p1:XRef2>sample string 18</d2p1:XRef2>
      <d2p1:XRef3>sample string 19</d2p1:XRef3>
      <d2p1:XRef4>sample string 20</d2p1:XRef4>
      <d2p1:Zipcode>sample string 10</d2p1:Zipcode>
    </d2p1:Vendor>
    <d2p1:Vendor>
      <d2p1:ACHEmail>true</d2p1:ACHEmail>
      <d2p1:ACHEmailAddr>sample string 33</d2p1:ACHEmailAddr>
      <d2p1:ACHFax>true</d2p1:ACHFax>
      <d2p1:ACHType>sample string 70</d2p1:ACHType>
      <d2p1:AccountDescription>sample string 74</d2p1:AccountDescription>
      <d2p1:AccountNum>sample string 4</d2p1:AccountNum>
      <d2p1:AcctID>sample string 66</d2p1:AcctID>
      <d2p1:Addr1>sample string 6</d2p1:Addr1>
      <d2p1:Addr2>sample string 7</d2p1:Addr2>
      <d2p1:BeginningBalance>35.1</d2p1:BeginningBalance>
      <d2p1:BeginningPrePay>37.1</d2p1:BeginningPrePay>
      <d2p1:City>sample string 8</d2p1:City>
      <d2p1:CompanyName1099>sample string 27</d2p1:CompanyName1099>
      <d2p1:Country>sample string 23</d2p1:Country>
      <d2p1:CurrentBalance>34.1</d2p1:CurrentBalance>
      <d2p1:ElectronicPO>true</d2p1:ElectronicPO>
      <d2p1:Email>sample string 15</d2p1:Email>
      <d2p1:Fax>sample string 13</d2p1:Fax>
      <d2p1:HoldPaymentYN>true</d2p1:HoldPaymentYN>
      <d2p1:InActive>true</d2p1:InActive>
      <d2p1:Location>sample string 3</d2p1:Location>
      <d2p1:LocationName>sample string 73</d2p1:LocationName>
      <d2p1:Month10Balance>47.1</d2p1:Month10Balance>
      <d2p1:Month11Balance>48.1</d2p1:Month11Balance>
      <d2p1:Month12Balance>49.1</d2p1:Month12Balance>
      <d2p1:Month1Balance>38.1</d2p1:Month1Balance>
      <d2p1:Month2Balance>39.1</d2p1:Month2Balance>
      <d2p1:Month3Balance>40.1</d2p1:Month3Balance>
      <d2p1:Month4Balance>41.1</d2p1:Month4Balance>
      <d2p1:Month5Balance>42.1</d2p1:Month5Balance>
      <d2p1:Month6Balance>43.1</d2p1:Month6Balance>
      <d2p1:Month7Balance>44.1</d2p1:Month7Balance>
      <d2p1:Month8Balance>45.1</d2p1:Month8Balance>
      <d2p1:Month9Balance>46.1</d2p1:Month9Balance>
      <d2p1:Name>sample string 5</d2p1:Name>
      <d2p1:Notes>sample string 16</d2p1:Notes>
      <d2p1:OneBillPerCheck>true</d2p1:OneBillPerCheck>
      <d2p1:Paid1099>64.1</d2p1:Paid1099>
      <d2p1:PaidTotal>65.1</d2p1:PaidTotal>
      <d2p1:Pay2ACHRouteNum>sample string 32</d2p1:Pay2ACHRouteNum>
      <d2p1:Pay2BankAcctNum>sample string 30</d2p1:Pay2BankAcctNum>
      <d2p1:Pay2BankAcctType>sample string 31</d2p1:Pay2BankAcctType>
      <d2p1:PayBy>sample string 67</d2p1:PayBy>
      <d2p1:Phone>sample string 11</d2p1:Phone>
      <d2p1:Phone2>sample string 12</d2p1:Phone2>
      <d2p1:PrePay>36.1</d2p1:PrePay>
      <d2p1:PrePayMonth10Balance>59.1</d2p1:PrePayMonth10Balance>
      <d2p1:PrePayMonth11Balance>60.1</d2p1:PrePayMonth11Balance>
      <d2p1:PrePayMonth12Balance>61.1</d2p1:PrePayMonth12Balance>
      <d2p1:PrePayMonth1Balance>50.1</d2p1:PrePayMonth1Balance>
      <d2p1:PrePayMonth2Balance>51.1</d2p1:PrePayMonth2Balance>
      <d2p1:PrePayMonth3Balance>52.1</d2p1:PrePayMonth3Balance>
      <d2p1:PrePayMonth4Balance>53.1</d2p1:PrePayMonth4Balance>
      <d2p1:PrePayMonth5Balance>54.1</d2p1:PrePayMonth5Balance>
      <d2p1:PrePayMonth6Balance>55.1</d2p1:PrePayMonth6Balance>
      <d2p1:PrePayMonth7Balance>56.1</d2p1:PrePayMonth7Balance>
      <d2p1:PrePayMonth8Balance>57.1</d2p1:PrePayMonth8Balance>
      <d2p1:PrePayMonth9Balance>58.1</d2p1:PrePayMonth9Balance>
      <d2p1:State>sample string 9</d2p1:State>
      <d2p1:TaxID>sample string 63</d2p1:TaxID>
      <d2p1:TermsCode>sample string 21</d2p1:TermsCode>
      <d2p1:Type1099>sample string 62</d2p1:Type1099>
      <d2p1:UniqueKey>75</d2p1:UniqueKey>
      <d2p1:VendorAttribute>
        <d2p1:Attributes>
          <d2p1:AttributeValue>sample string 5</d2p1:AttributeValue>
          <d2p1:CrossRef>sample string 4</d2p1:CrossRef>
          <d2p1:MasterCrossRefNamesKey>3</d2p1:MasterCrossRefNamesKey>
          <d2p1:VendAttributesKey>1</d2p1:VendAttributesKey>
          <d2p1:VendorID>sample string 2</d2p1:VendorID>
        </d2p1:Attributes>
        <d2p1:Attributes>
          <d2p1:AttributeValue>sample string 5</d2p1:AttributeValue>
          <d2p1:CrossRef>sample string 4</d2p1:CrossRef>
          <d2p1:MasterCrossRefNamesKey>3</d2p1:MasterCrossRefNamesKey>
          <d2p1:VendAttributesKey>1</d2p1:VendAttributesKey>
          <d2p1:VendorID>sample string 2</d2p1:VendorID>
        </d2p1:Attributes>
      </d2p1:VendorAttribute>
      <d2p1:VendorClass>
        <d2p1:Classifications>
          <d2p1:ClassName>sample string 4</d2p1:ClassName>
          <d2p1:MasterClassNamesKey>2</d2p1:MasterClassNamesKey>
          <d2p1:VendorClassKey>1</d2p1:VendorClassKey>
          <d2p1:VendorID>sample string 3</d2p1:VendorID>
        </d2p1:Classifications>
        <d2p1:Classifications>
          <d2p1:ClassName>sample string 4</d2p1:ClassName>
          <d2p1:MasterClassNamesKey>2</d2p1:MasterClassNamesKey>
          <d2p1:VendorClassKey>1</d2p1:VendorClassKey>
          <d2p1:VendorID>sample string 3</d2p1:VendorID>
        </d2p1:Classifications>
      </d2p1:VendorClass>
      <d2p1:VendorGUID>44a39020-2e73-4bdb-9ac8-0025e423970a</d2p1:VendorGUID>
      <d2p1:VendorID>sample string 2</d2p1:VendorID>
      <d2p1:Web>sample string 14</d2p1:Web>
      <d2p1:XRef1>sample string 17</d2p1:XRef1>
      <d2p1:XRef2>sample string 18</d2p1:XRef2>
      <d2p1:XRef3>sample string 19</d2p1:XRef3>
      <d2p1:XRef4>sample string 20</d2p1:XRef4>
      <d2p1:Zipcode>sample string 10</d2p1:Zipcode>
    </d2p1:Vendor>
  </VendorRecords>
</AgvVendorList>