Vendor restricted locations

In shared multi-entity companies, vendors can be restricted to specific locations or location groups to prevent the vendor from being used in the wrong entity.

Create and maintain vendor restricted locations from the owning vendor object.

List vendor restricted locations

get/objects/accounts-payable/vendor-restricted-location

Returns a collection with a key, ID, and link for each vendor restricted location. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "200",
      • "id": "200",
      • "href": "/objects/accounts-payable/vendor-restricted-location/200"
      },
    • {
      • "key": "198",
      • "id": "198",
      • "href": "/objects/accounts-payable/vendor-restricted-location/198"
      },
    • {
      • "key": "196",
      • "id": "196",
      • "href": "/objects/accounts-payable/vendor-restricted-location/196"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Get a vendor restricted location
get/objects/accounts-payable/vendor-restricted-location/{key}
Returns detailed information for a specified vendor restricted location.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the vendor restricted location.


 
 Example:  142
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "142",
    • "id": "142",
    • "location": {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/company-config/location/3"
      },
    • "locationGroup": {
      • "key": null,
      • "id": null
      },
    • "vendor": {
      • "key": "330",
      • "id": "vendor-16521",
      • "href": "/objects/accounts-payable/vendor/330"
      },
    • "href": "/objects/accounts-payable/vendor-restricted-location/142"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}