Vendors

GetVendors

This method will return information about vendors for the specified property. All properties in a given account share the same set of vendors but access to specific vendors is defined on a property by property basis. For this reason, we require the vendors to be requested for a specific property.

Request

Data is requested by performing a HTTP Post to https://api.myresman.com/Vendors/GetVendors supplying the listed parameters below in the body of the request. Please refer to the Request Example portion at the beginning of this document for an example on how to make such a request.

Parameters

Name	Description	Example	Required
IntegrationPartnerID	The ID assigned to your company by ResMan	1000	Yes
ApiKey	The API key assigned to your company by ResMan	a5w7d9g2m04…	Yes
AccountID	The AccountID associated with the management company	400	Yes
PropertyID	The PropertyID associated with the property	07413576-f764-44c6-be35-df4139deec01	Yes
Date	(New: April2018) Request a limited set of vendors that only include vendors changed since this posted date.	04/19/2018	No

Response

The response will be provided in the format requested based upon the Accept HTTP header; either json or xml. The response will contain information about the method called, the parameters supplied as well as a list of the vendors associated with the indicated property.

Name	Description
VendorID	The ResMan ID used to identify the vendor
TaxID	The federal Tax ID associated with the vendor
Abbreviation	The vendor abbreviation. This is to be used when posting to the MITS/AccountsPayable4_0 method to identify a vendor.
CompanyName	The vendor name
CustomerNumber	The vendor customer number
StreetAddress	The vendor street address
City	The vendor city
State	The vendor state
Zip	The vendor zip
Status	(New: April2018) The vendor status in ResMan “Active” or “Inactive”. Accounts don’t delete vendors, but they set vendors to “Inactive” which hides vendors on the account while not in use.
Compliance	(New: April2018) Compliance status in Resman either “Approved” or “Not Approved”. Vendors not approved, depending on the accounts settings, aren’t available to users though still visible on the account.

Below are examples of the response you can expect from this method.

JSON Response

{

"Vendors": [

{

"VendorID": "48203ab3-f764-44c6-be35-df4139deec01",

"TaxID": "32-123412",

"Abbreviation": "ABC",

"CompanyName": "ABC Painting",

"CustomerNumber": "123",

"StreetAddress": "1234 Main St",

"City": "Dallas",

"State": "TX",

"Zip": "75194"

"Status": "Active"

"Compliance": "Approved"

{

"VendorID": "2048294-f764-44c6-be35-df4139deec01",

"TaxID": "12-432342",

"Abbreviation": "CCP",

"CompanyName": "Crystal Clear Pools",

"CustomerNumber": "456",

"StreetAddress": "5678 State St",

"City": "Dallas",

"State": "TX",

"Zip": "75194"

"Status": "Inactive"

"Compliance": "Not Approved"

{

"VendorID": "3829c3e2-f764-44c6-be35-df4139deec01",

"TaxID": "23-4893923",

"Abbreviation": "LMS",

"CompanyName": "Lucky Maid Service",

"CustomerNumber": "789",

"StreetAddress": "9876 Center St",

"City": "Dallas",

"State": "TX",

"Zip": "75194"

"Status": "Active"

"Compliance": "Not Approved"

}

"MethodName": "GetVendors",

"Status": "Success",

"AccountID": 400,

"PropertyID": "07413576-f764-44c6-be35-df4139deec01",

}

XML Response

<ResMan

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<MethodName>GetVendors</MethodName>

<Status>Success</Status>

<CompanyName>ABC Painting</CompanyName>

<City>Dallas</StreetAddress>

<Status>Active</Status>

<Compliance>Not Approved</Compliance>

</Vendor>

<CompanyName>Crystal Clear Pools</CompanyName>

<StreetAddress>5678 State St</StreetAddress>

<City>Dallas</StreetAddress>

<Status>Inactive</Status>

<Compliance>Not Approved</Compliance>

</Vendor>

<CompanyName>Lucky Maid Service</CompanyName>

<StreetAddress>9876 Center St</StreetAddress>

<City>Dallas</StreetAddress>

<Status>Active</Status>

<Compliance>Approved</Compliance>

</Vendor>

</Charts>

</ResMan>

Possible Error Codes

Listed below are the possible error codes and descriptions that can be returned from GetVendors method.

-Access to the provided property is not permitted

Possible Issue 1- Either the accountID or Property ID is incorrect, so the API was called up for a property that doesn’t exist, resulting in an error.

Possible Issue 2- Another possibility is that the integration partner hasn’t been set up; Check Admin>Integration Partners- then find the vender and see what the settings are to ensure the vender has been enabled for the property in question. Then go to Admin>Settings>Vendor and update the setting from "ResMan data" to "Integration Partner Recommendation".

XML Response

<MethodName> GetVendors</MethodName>

<ErrorDescription>Access to the provided property is not permitted</ErrorDescription>

<Status>Failed</Status>

JSON Response

{

"MethodName" => "GetVendors"

"ErrorDescription" => "Access to the provided property is not permitted"

"Status" => "Failed"

"AccountID" => 1234

"PropertyID" => "00000000-0000-0000-0000-000000000000"

}