Warehouse Transfers

Warehouse transfers let you move inventory from one warehouse to another, either as an immediate transfer or allowing for time in transit.

Get Warehouse Transfer Object Definition

lookup

List all the fields and relationships for the warehouse transfer object:

<lookup>
    <object>ICTRANSFERITEM</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use ICTRANSFER

Get Warehouse Transfer Item Object Definition

lookup

List all the fields and relationships for the warehouse transfer item object:

<lookup>
    <object>ICTRANSFERITEM</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use ICTRANSFERITEM

Query and List Warehouse Transfers

query

List the record number and description for each warehouse transfer:

<query>
    <object>ICTRANSFER</object>
    <select>
        <field>RECORDNO</field>
        <field>DESCRIPTION</field>
    </select>
</query>

Parameters

Name Required Type Description
object Required string Use ICTRANSFER
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Query and List Warehouse Transfers (Legacy)

readByQuery

<readByQuery>
    <object>ICTRANSFER</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use ICTRANSFER
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Warehouse Transfer

read

<read>
    <object>ICTRANSFER</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use ICTRANSFER
keys Required string Comma-separated list of warehouse RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Create Warehouse Transfer

Release Changes
2021 Release 3 Added TRANSFERTYPE, OUTDATE, INDATE, ACTION

create

Immediate transfer of 200 widgets from warehouse WH101 to warehouse WH102:

<create>
    <ICTRANSFER>
        <TRANSACTIONDATE>07/26/2021</TRANSACTIONDATE>
        <TRANSFERTYPE>Immediate</TRANSFERTYPE>
        <DESCRIPTION>Moving widgets to Warehouse WH102</DESCRIPTION>
        <ICTRANSFERITEMS>
            <ICTRANSFERITEM>
                <IN_OUT>O</IN_OUT>
                <ITEMID>x2</ITEMID>
                <WAREHOUSEID>WH101</WAREHOUSEID>
                <QUANTITY>200</QUANTITY>
                <UNIT>Each</UNIT>
                <LOCATIONID>100</LOCATIONID>
            </ICTRANSFERITEM>
            <ICTRANSFERITEM>
                <IN_OUT>I</IN_OUT>
                <ITEMID>x2</ITEMID>
                <WAREHOUSEID>WH102</WAREHOUSEID>
                <QUANTITY>200</QUANTITY>
                <UNIT>Each</UNIT>
                <LOCATIONID>100</LOCATIONID>
            </ICTRANSFERITEM>
        </ICTRANSFERITEMS>
    </ICTRANSFER>
</create>

In transit transfer of 200 widgets between warehouses with different base currencies using a custom exchange rate:

<create>
    <ICTRANSFER>
        <TRANSACTIONDATE>07/26/2021</TRANSACTIONDATE>
        <TRANSFERTYPE>In transit</TRANSFERTYPE>
        <ACTION>Draft</ACTION>
        <OUTDATE>07/26/2021</OUTDATE>
        <INDATE>07/29/2021</INDATE>
        <DESCRIPTION>Moving widgets to Warehouse WH102</DESCRIPTION>
        <EXCH_RATE_DATE>07/16/2021</EXCH_RATE_DATE>
        <EXCHANGE_RATE>1.9</EXCHANGE_RATE>
        <ICTRANSFERITEMS>
            <ICTRANSFERITEM>
                <IN_OUT>O</IN_OUT>
                <ITEMID>x2</ITEMID>
                <WAREHOUSEID>WH101</WAREHOUSEID>
                <QUANTITY>200</QUANTITY>
                <UNIT>Each</UNIT>
                <LOCATIONID>100</LOCATIONID>
            </ICTRANSFERITEM>
            <ICTRANSFERITEM>
                <IN_OUT>I</IN_OUT>
                <ITEMID>x2</ITEMID>
                <WAREHOUSEID>WH102</WAREHOUSEID>
                <QUANTITY>200</QUANTITY>
                <UNIT>Each</UNIT>
                <LOCATIONID>100</LOCATIONID>
            </ICTRANSFERITEM>
        </ICTRANSFERITEMS>
    </ICTRANSFER>
</create>

Parameters

Name Required Type Description
ICTRANSFER Required object Use ICTRANSFER

ICTRANSFER

Name Required Type Description
TRANSACTIONDATE Required string Date of Immediate transfers, creation date of In transit transfers.
REFERENCENO Optional String Reference number for the transfer
DESCRIPTION Optional string Description
TRANSFERTYPE Optional string Specify whether this is an Immediate or In transit transfer. (Default: Immediate)
ACTION Optional string Sets the TRANSFERSTATE of the transfer.

If TRANSFERTYPE = Immediate
• valid values are Draft or Post
• default value is Post.

If TRANSFERTYPE = In transit
• valid values are Draft, Transfer out or Transfer in
• If current TRANSFERSTATE = Draft, default value is Transfer in.
• If current TRANSFERSTATE = In transit, default value is Transfer out.

Note: You cannot change the TRANSFERSTATE of a Posted transfer, and you cannot set an In transit transfer back to Draft.
OUTDATE Optional string Estimated date that the shipment will leave the originating warehouse. Required when TRANSFERTYPE = In transit. Cannot be earlier than TRANSACTIONDATE.
INDATE Optional string Estimated date that the shipment arrives at the receiving warehouse. Required when TRANSFERTYPE = In transit. Cannot be earlier than OUTDATE.
EXCH_RATE_TYPE_ID Optional string Exchange rate type. Do not use if EXCHANGE_RATE is set. (Default: Intacct Daily Rate)
EXCH_RATE_DATE Optional string Exchange rate date in format mm/dd/yyyy (Default: TRANSACTIONDATE)
EXCHANGE_RATE Optional currency Exchange rate with precision up to 10 decimals. Do not use if EXCH_RATE_TYPE_ID is set.
ICTRANSFERITEMS Required ICTRANSFERITEM[2...n] Warehouse transfer lines. Must be one or more matched pairs (with one outgoing and one incoming (ICTRANSFERITEM).

ICTRANSFERITEM

Name Required Type Description
IN_OUT Required string Specifies whether this side of the pair represents the warehouse sending the inventory (outgoing) or the warehouse receiving the inventory (incoming). Use O for outgoing and I for incoming.
ITEMID Required string Item ID for the inventory to transfer
WAREHOUSEID Required string Warehouse ID
MEMO Optional string Memo
QUANTITY Required number Quantity
UNIT Required string Unit of measure on which to base quantity
LOCATIONID Optional string Location ID
DEPARTMENTID Optional string Department ID
PROJECTID Optional string Project ID
CUSTOMERID Optional string Customer ID
VENDDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
CLASSID Optional string Class ID

Update Warehouse Transfer

Release Changes
2021 Release 3 Added TRANSFERTYPE, OUTDATE, INDATE, ACTION

Update the transfer to move fewer (only 50) widgets, change the description, and show the item as transferred out of the originating warehouse:

update

<update>
    <ICTRANSFER>
        <RECORDNO>3</RECORDNO>
        <DESCRIPTION>Reducing the number of widgets to transfer</DESCRIPTION>
        <ACTION>Transfer out</ACTION>
        <ICTRANSFERITEMS>
            <ICTRANSFERITEM>
                <IN_OUT>O</IN_OUT>
                <ITEMID>x2</ITEMID>
                <WAREHOUSEID>WH102</WAREHOUSEID>
                <QUANTITY>50</QUANTITY>
                <UNIT>Each</UNIT>
                <LOCATIONID>100</LOCATIONID>
            </ICTRANSFERITEM>
            <ICTRANSFERITEM>
                <IN_OUT>I</IN_OUT>
                <ITEMID>x2</ITEMID>
                <WAREHOUSEID>WH101</WAREHOUSEID>
                <QUANTITY>50</QUANTITY>
                <UNIT>Each</UNIT>
                <LOCATIONID>100</LOCATIONID>
            </ICTRANSFERITEM>
        </ICTRANSFERITEMS>
    </ICTRANSFER>
</update>

Parameters

Name Required Type Description
ICTRANSFER Required object Use ICTRANSFER

ICTRANSFER

Name Required Type Description
RECORDNO Required integer Record number of the warehouse transfer
ACTION Optional string Sets the TRANSFERSTATE of the transfer.

If TRANSFERTYPE = Immediate
• valid values are Draft or Post
• default value is Post.

If TRANSFERTYPE = In transit
• valid values are Draft, Transfer out or Transfer in
• If current TRANSFERSTATE = Draft, default value is Transfer in.
• If current TRANSFERSTATE = In transit, default value is Transfer out.

Note: You cannot change the TRANSFERSTATE of a Posted transfer, and you cannot set an In transit transfer back to Draft.
TRANSACTIONDATE Optional string Date of the transfer
OUTDATE Optional string Date that the shipment left the originating warehouse. Can be estimated when creating Draft transfers and then updated when TRANSFERSTATE is changed to Posted. Required when TRANSFERTYPE = In transit. Cannot be earlier than TRANSACTIONDATE.
INDATE Optional string Date that the shipment arrived at the receiving warehouse. Can be estimated when creating Draft transfers and then updated when TRANSFERSTATE is changed to Posted. Required when TRANSFERTYPE = In transit. Cannot be earlier than OUTDATE.
REFERENCENO Optional String Reference number for the transfer
DESCRIPTION Optional string Description
EXCH_RATE_TYPE_ID Optional string Exchange rate type. Do not use if EXCHANGE_RATE is set. (Default: Intacct Daily Rate)
EXCH_RATE_DATE Optional string Exchange rate date in format mm/dd/yyyy (Default: TRANSACTIONDATE)
EXCHANGE_RATE Optional currency Exchange rate with precision up to 10 decimals. Do not use if EXCH_RATE_TYPE_ID is set.
ICTRANSFERITEMS Optional ICTRANSFERITEM[2...n] Warehouse transfer lines. Must be one or more matched pairs (with one outgoing and one incoming (ICTRANSFERITEM).

ICTRANSFERITEM

Name Required Type Description
IN_OUT Required integer Specifies whether this side of the pair represents the warehouse sending the inventory (outgoing) or the warehouse receiving the inventory (incoming). Use O for outgoing and I for incoming.
ITEMID Required string Item ID for the inventory to transfer
WAREHOUSEID Required string Warehouse ID
MEMO Optional string Memo
QUANTITY Required number Quantity
UNIT Required string Unit of measure on which to base quantity
LOCATIONID Optional string Location ID
DEPARTMENTID Optional string Department ID
PROJECTID Optional string Project ID
CUSTOMERID Optional string Customer ID
VENDDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
CLASSID Optional string Class ID

Delete Warehouse Transfer

delete

<delete>
    <object>ICTRANSFER</object>
    <keys>1</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use ICTRANSFER
keys Required string Comma-separated list of warehouse transfer RECORDNO to delete

Provide feedback