Item Transfers

Prev Next
Get
/public/v1/inventory/item-transfers

Retrieves a list of item transfers

Security

The requesting user must have the following permission to retrieve item transfers:

  • Food → Item Transfers → View Item Transfers
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.

transferDateStart
string (date)

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

transferDateEnd
string (date)

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

locationIds
string (uuid)

Identifier of the location to filter by

status
string

The item transfer status, one of 'In Progress', 'Completed', 'Approved', 'Pending', or 'Rejected'

pageSize
integer (int32)

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

Minimum1.0
Maximum250.0
Default250
continuationToken
string
Responses
200

list of item transfer entities

Expand All
object

A response containing item transfers.

items
Array of object | null

Collection of public item transfers records returned in this page.

object

Item Transfer

id
integer (int64)

The unique identifier for the Item Transfer.

number
string | null

The Item Transfer Number.

template
object (ItemTransferTemplateReference)

A reference to an Item Transfer Template.

id
integer (int64)

Unique identifier of the item transfer template.

name
string | null

Display name of the item transfer template.

date
string (date)

Item Transfer Date.

fromLocation
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

toLocation
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

totalAmount
number (double)

Total Amount.

lastComment
string | null

Last Comment.

details
Array of object | null

List of Item Transfer Details.

object

Item Transfer Detail

id
integer (int64)

The unique identifier for the Item Transfer detail.

item
object (ItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the item.

name
string | null

Display name of the item.

number
string | null

Number assigned to the item.

itemType
integer (int32)

The types for an item.

Valid values[ 1, 2 ]
unitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

quantity
number (double)

Quantity.

eachAmount
number (double)

Each Amount.

totalAmount
number (double)

Total Amount.

comment
string | null

Comment.

status
string | null

Item Transfer status.

transactionId
string (uuid)

The transaction id for the item transfer.

completedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

completedOn
string (date-time) | null

The date and time the item transfer was completed.

createdBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

createdOn
string (date-time)

The date and time the item transfer was created.

modifiedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date and time the item transfer was last modified.

approvedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

approvedOn
string (date-time) | null

The date and time the item transfer was approved.

nextLink
string | null

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

Expand All
object

A response containing item transfers.

items
Array of object | null

Collection of public item transfers records returned in this page.

object

Item Transfer

id
integer (int64)

The unique identifier for the Item Transfer.

number
string | null

The Item Transfer Number.

template
object (ItemTransferTemplateReference)

A reference to an Item Transfer Template.

id
integer (int64)

Unique identifier of the item transfer template.

name
string | null

Display name of the item transfer template.

date
string (date)

Item Transfer Date.

fromLocation
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

toLocation
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

totalAmount
number (double)

Total Amount.

lastComment
string | null

Last Comment.

details
Array of object | null

List of Item Transfer Details.

object

Item Transfer Detail

id
integer (int64)

The unique identifier for the Item Transfer detail.

item
object (ItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the item.

name
string | null

Display name of the item.

number
string | null

Number assigned to the item.

itemType
integer (int32)

The types for an item.

Valid values[ 1, 2 ]
unitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

quantity
number (double)

Quantity.

eachAmount
number (double)

Each Amount.

totalAmount
number (double)

Total Amount.

comment
string | null

Comment.

status
string | null

Item Transfer status.

transactionId
string (uuid)

The transaction id for the item transfer.

completedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

completedOn
string (date-time) | null

The date and time the item transfer was completed.

createdBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

createdOn
string (date-time)

The date and time the item transfer was created.

modifiedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date and time the item transfer was last modified.

approvedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

approvedOn
string (date-time) | null

The date and time the item transfer was approved.

nextLink
string | null

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

Expand All
object

A response containing item transfers.

items
Array of object | null

Collection of public item transfers records returned in this page.

object

Item Transfer

id
integer (int64)

The unique identifier for the Item Transfer.

number
string | null

The Item Transfer Number.

template
object (ItemTransferTemplateReference)

A reference to an Item Transfer Template.

id
integer (int64)

Unique identifier of the item transfer template.

name
string | null

Display name of the item transfer template.

date
string (date)

Item Transfer Date.

fromLocation
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

toLocation
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

totalAmount
number (double)

Total Amount.

lastComment
string | null

Last Comment.

details
Array of object | null

List of Item Transfer Details.

object

Item Transfer Detail

id
integer (int64)

The unique identifier for the Item Transfer detail.

item
object (ItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the item.

name
string | null

Display name of the item.

number
string | null

Number assigned to the item.

itemType
integer (int32)

The types for an item.

Valid values[ 1, 2 ]
unitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

quantity
number (double)

Quantity.

eachAmount
number (double)

Each Amount.

totalAmount
number (double)

Total Amount.

comment
string | null

Comment.

status
string | null

Item Transfer status.

transactionId
string (uuid)

The transaction id for the item transfer.

completedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

completedOn
string (date-time) | null

The date and time the item transfer was completed.

createdBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

createdOn
string (date-time)

The date and time the item transfer was created.

modifiedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date and time the item transfer was last modified.

approvedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

approvedOn
string (date-time) | null

The date and time the item transfer was approved.

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.