Vendor by ID

Prev Next
Get
/public/v1/inventory/vendors/{id}

Retrieves a specified vendor

Security

The requesting user must have the following permission to retrieve a vendor:

  • 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.

Path parameters
id
string (uuid) Required

The identifier of the vendor

Responses
200

The vendor entity

Expand All
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
Expand All
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
Expand All
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
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.