Inventory transfers

A request to move inventory between locations or sites.

Fields

The API name is what the API, MCP and the CLI use.

Name	API name	Type	Required	Description
ID	`id`	Record ID	Yes
Name	`label`	Text
Transfer number	`uid`	Text		The number is a human-readable, unique identifier for the record.
Day	`date`	Date	Yes	Calendar date for this value.
Requested by	`userId`	User
Class	`class`	Constant	Yes	Primary class of the record within its table, as defined by the applicable option list.
Priority	`priority`	Constant	Yes	Whole number without fractional part.
Transit loss amount	`amount`	Currency	Yes	Monetary amount in the applicable currency for this record.
Inventory site (supplying)	`siteIdFrom`	Reference	Yes
Status	`status`	Constant	Yes	Transfer state: maintained by the system from document timestamps and per-line quantities.
Close reason	`closeReason`	Constant		Value from the table catalog for this field.
Tags	`tagIds`	Tags
Description	`description`	Text Area
Data	`data`	Data
Created by	`createdBy`	User
Created at	`createdAt`	Date and Time	Yes
Updated by	`updatedBy`	User
Updated at	`updatedAt`	Date and Time	Yes
Ended by	`endedBy`	User
Ended at	`endedAt`	Date and Time
Processed by	`processedBy`	User
Processed at	`processedAt`	Date and Time
Sent by	`sentBy`	User
Sent at	`sentAt`	Date and Time
Closed by	`closedBy`	User
Closed at	`closedAt`	Date and Time
Canceled by	`canceledBy`	User
Canceled at	`canceledAt`	Date and Time
Blocked by	`blockedBy`	User
Blocked at	`blockedAt`	Date and Time
Archived by	`archivedBy`	User
Archived at	`archivedAt`	Date and Time

Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.

Field	Points to	Kind
Requested by `userId`	Users	reference
Inventory site (supplying) `siteIdFrom`	Sites	reference
Tags `tagIds`	Tags	reference

What you can do with a record. Every action also sends the webhook event inventorytransfers.<action>. Reads (find, get, count) work on every table.

Name	API name	Description	Where
Create	`create`	Add a new transfer.	App · API · MCP · CLI
Edit	`update`	Save changes to this transfer.	App · API · MCP · CLI
Send	`send`	Send this transfer to the customer.	App · API · MCP · CLI
Process	`process`	Post this transfer. You cannot undo it.	App · API · MCP · CLI
Receive	`end`	Process open receipt executions at the requesting site.	App · API · MCP · CLI
Close	`close`	Close this transfer and record the transit loss.	App · API · MCP · CLI
Reopen	`unclose`	Allow new references to this transfer again.	App · API · MCP · CLI
Cancel	`cancel`	Reverse the posted effect of this transfer.	App · API · MCP · CLI
Block	`block`	Stop edits and deletion of this transfer. It stays visible and can still appear on existing documents. Unblock to edit again.	App · API · MCP · CLI
Unblock	`unblock`	Allow edits and deletion of this transfer again.	App · API · MCP · CLI
Archive	`archive`	Retire this transfer from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it.	App · API · MCP · CLI
Restore	`unarchive`	Return this transfer to active lists and actions.	App · API · MCP · CLI
Delete	`delete`	Delete this transfer and the data that belongs with it. This cannot be undone.	App · API · MCP · CLI

How a record moves from state to state. Archive and block can happen in any state.