Vendors

Prev Next
Get
/public/v1/inventory/vendors

Retrieves a list of vendors

Security

The requesting user must have the following permission to retrieve vendors:

  • Accounts Payable → Vendors → View Vendors
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Query parameters
modifiedOnStart
string (date-time)

Starting datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the upper bound.

modifiedOnEnd
string (date-time)

Ending datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the lower bound.

pageSize
integer (int32)

Maximum number of top-level objects to return in one page.

Minimum1.0
Maximum250.0
Default250
continuationToken
string
Responses
200

The list of vendors

Expand All
object
items
Array of object | null

Collection of query continuation response vendor records returned in this page.

object
id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

comment
string | null

Free-text comment associated with the vendor.

createdBy
object (InventoryUserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

createdOn
string (date-time) | null

Timestamp when the vendor was created.

modifiedBy
object (InventoryUserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

modifiedOn
string (date-time) | null

Timestamp when the vendor was last modified.

address
object (VendorAddress)
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
stateOrProvince
string | null
country
string | null
postalCode
string | null
nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

Expand All
object
items
Array of object | null

Collection of query continuation response vendor records returned in this page.

object
id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

comment
string | null

Free-text comment associated with the vendor.

createdBy
object (InventoryUserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

createdOn
string (date-time) | null

Timestamp when the vendor was created.

modifiedBy
object (InventoryUserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

modifiedOn
string (date-time) | null

Timestamp when the vendor was last modified.

address
object (VendorAddress)
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
stateOrProvince
string | null
country
string | null
postalCode
string | null
nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

Expand All
object
items
Array of object | null

Collection of query continuation response vendor records returned in this page.

object
id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

comment
string | null

Free-text comment associated with the vendor.

createdBy
object (InventoryUserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

createdOn
string (date-time) | null

Timestamp when the vendor was created.

modifiedBy
object (InventoryUserReference)
id
string (uuid)

Unique identifier of the user.

name
string | null

Display name of the user.

modifiedOn
string (date-time) | null

Timestamp when the vendor was last modified.

address
object (VendorAddress)
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
city
string | null
stateOrProvince
string | null
country
string | null
postalCode
string | null
nextLink
string | null

URL to retrieve the next page of results, or null when this is the last page.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.