Help Page Home - ItemTransfers
PUT ItemTransfer/id
Update an item transfer.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| WsAccessKey | The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. | string |
Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred. |
| FileId | Specifies the file id of the file to perform the operation upon. | integer |
Required |
| id | The id/key of the item transfer. | integer |
Required |
Body Parameters
TransferDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| Items | The items associated with this transfer transaction. | Collection of TransferItem |
Required |
| Notes | Textual notes set by the user. | string |
None. |
| Id | The Id/key of the transfer transaction. This data is returned only and cannot be added or updated when issuing a POST or PUT. | integer |
None. |
| LastUpdatedId | A data field used to check concurreny when performing updates. This data is returned only and used for concurrency checking when performing an update/PUT. | string |
None. |
| Date | Date of this transaction. | date |
Required |
| Summary | Item transfer summary. | string |
None. |
| Tags | List of tags associated with this resource. | Collection of string |
None. |
| RequiresFollowUp | Transfer transaction requires follow up. | boolean |
None. |
| CreatedDateUtc | The date and time this resource was created in UTC. This data is returned only and cannot be added or updated when issuing a POST or PUT. | date |
None. |
| LastModifiedDateUtc | The date and time this resource was last modified in UTC. This data is returned only and cannot be added or updated when issuing a POST or PUT. | date |
None. |
| _links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Request Formats
application/json, text/json
Sample:
{
"Items": [
{
"Quantity": 2.0,
"InventoryItemId": 123,
"UnitCost": 10.0,
"LineTotal": 20.0,
"_links": []
},
{
"Quantity": 3.0,
"InventoryItemId": 456,
"UnitCost": 11.0,
"LineTotal": 33.0,
"_links": []
}
],
"Notes": "Test item transfer note",
"Id": 123456,
"LastUpdatedId": "AAAAAAAKgc=",
"Date": "2016-10-01T00:00:00",
"Summary": "Test Item transfer entry 1",
"Tags": [
"Note",
"Building Combo"
],
"RequiresFollowUp": false,
"CreatedDateUtc": "2025-10-25T18:00:11.5447477Z",
"LastModifiedDateUtc": "2025-10-26T18:00:11.5447477Z",
"_links": []
}
application/xml, text/xml
Sample:
<TransferDetail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<_links />
<Id>123456</Id>
<LastUpdatedId>AAAAAAAKgc=</LastUpdatedId>
<Date>2016-10-01T00:00:00</Date>
<Summary>Test Item transfer entry 1</Summary>
<Tags>
<string>Note</string>
<string>Building Combo</string>
</Tags>
<RequiresFollowUp>false</RequiresFollowUp>
<CreatedDateUtc>2025-10-25T18:00:11.5447477Z</CreatedDateUtc>
<LastModifiedDateUtc>2025-10-26T18:00:11.5447477Z</LastModifiedDateUtc>
<Items>
<TransferItem>
<_links />
<Quantity>2</Quantity>
<InventoryItemId>123</InventoryItemId>
<UnitCost>10.00</UnitCost>
<LineTotal>20.00</LineTotal>
</TransferItem>
<TransferItem>
<_links />
<Quantity>3</Quantity>
<InventoryItemId>456</InventoryItemId>
<UnitCost>11.00</UnitCost>
<LineTotal>33.00</LineTotal>
</TransferItem>
</Items>
<Notes>Test item transfer note</Notes>
</TransferDetail>
Response Information
Resource Description
UpdateItemTransferResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | Updated item transfer id | integer |
None. |
| LastUpdatedId | The unique identifier generated as part of the update. This value is required when submitting subsequent update to prevent concurrency errors. | string |
None. |
| UtcLastModified | The date and time this resource was modified in UTC. | date |
None. |
| _links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 0,
"LastUpdatedId": "AAAAYhg=",
"UtcLastModified": "2025-10-21T18:00:11.5614069Z",
"_links": [
{
"rel": "self",
"href": "https://api.saasu.com/ItemTransfer/321?FileId=123",
"method": "PUT",
"title": null
},
{
"rel": "delete",
"href": "https://api.saasu.com/ItemTransfer/321?FileId=123",
"method": "DELETE",
"title": null
},
{
"rel": "list",
"href": "https://api.saasu.com/ItemTransfers?FileId=123",
"method": "GET",
"title": null
}
]
}
application/xml, text/xml
Sample:
<UpdateItemTransferResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<_links>
<Link>
<rel>self</rel>
<href>https://api.saasu.com/ItemTransfer/321?FileId=123</href>
<method>PUT</method>
</Link>
<Link>
<rel>delete</rel>
<href>https://api.saasu.com/ItemTransfer/321?FileId=123</href>
<method>DELETE</method>
</Link>
<Link>
<rel>list</rel>
<href>https://api.saasu.com/ItemTransfers?FileId=123</href>
<method>GET</method>
</Link>
</_links>
<LastUpdatedId>AAAAYhg=</LastUpdatedId>
<UtcLastModified>2025-10-21T18:00:11.5614069Z</UtcLastModified>
<Id>0</Id>
</UpdateItemTransferResult>