List Inventory Transactions

readByQuery

<readByQuery>
    <object>INVDOCUMENT</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
    <docparid>Beginning Balance</docparid>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use INVDOCUMENT
fields Required string Comma separated list of fields on the object to list. Use * to return all fields.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)
docparid Optional string Used to indicate the document type (Ex: Inventory Transfer). You must use this to take advantage of any custom fields on the specified document type.

Get Inventory Transaction

read

<read>
    <object>INVDOCUMENT</object>
    <keys>1</keys>
    <fields>*</fields>
    <docparid>Beginning Balance</docparid>
</read>

Parameters

Name Required Type Description
object Required string Use INVDOCUMENT
keys Required string The transaction RECORDNO to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.
docparid Optional string Used to indicate the document type (Ex: Inventory Transfer). You must use this to take advantage of any custom fields on the specified document type.

Create Inventory Transaction (Legacy)

create_ictransaction

<create_ictransaction>
    <transactiontype>Inventory Transfer</transactiontype>
    <datecreated>
        <year>2013</year>
        <month>5</month>
        <day>28</day>
    </datecreated>
    <createdfrom></createdfrom>
    <documentno></documentno>
    <referenceno></referenceno>
    <message></message>
    <basecurr>USD</basecurr>
    <state>Pending</state>
    <ictransitems>
        <ictransitem>
            <itemid>I123</itemid>
            <itemdesc></itemdesc>
            <warehouseid>W100</warehouseid>
            <quantity>10</quantity>
            <unit>Each</unit>
            <cost>49.99</cost>
            <locationid>L200</locationid>
            <departmentid>D20</departmentid>
            <projectid></projectid>
            <customerid></customerid>
            <vendorid></vendorid>
            <employeeid></employeeid>
            <classid></classid>
            <contractid></contractid>
        </ictransitem>
    </ictransitems>
</create_ictransaction>

Parameters

Name Required Type Description
transactiontype Required string Transaction definition to use
datecreated Required object Transaction date
createdfrom Optional string Inventory transaction document number to convert from
documentno Optional string Document number. Leave blank to use auto numbering if set in definition
referenceno Optional string Reference number
message Optional string Message
externalid Optional string External ID
basecurr Optional string Base currency code
customfields Optional customfield[] Custom fields
state Optional string Action. Use Draft, Pending or Closed. (Default depends on transaction definition configuration)
ictransitems Required ictransitem[] Transaction lines, must have at least 1.
subtotals Optional subtotal[] Subtotal lines

datecreated

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

ictransitem

Name Required Type Description
itemid Required string Item ID
itemdesc Optional string Item description
warehouseid Required string Warehouse ID
quantity Required number Quantity
unit Optional string Unit of measure to base quantity off
cost Optional currency Cost
locationid Optional string Location ID
departmentid Optional string Department ID
itemdetails Optional itemdetail[] Array of item details
customfields Optional customfield[] Custom fields
projectid Optional string Project ID
customerid Optional string Customer ID
vendorid Optional string Vendor ID
employeeid Optional string Employee ID
classid Optional string Class ID
contractid Optional string Contract ID

itemdetail

Name Required Type Description
quantity Optional number Quantity
serialno Optional string Serial number. Only used if not using lotno.
lotno Optional string Lot number. Only used if not using serialno.
aisle Optional string Aisle
row Optional string Row
bin Optional string Bin
itemexpiration Optional object Item expiration

itemexpiration

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

subtotal

Name Required Type Description
description Required string Description
total Required currency Total
absval Optional number Absolute value
percentval Optional number Percent value
locationid Optional string Location ID
departmentid Optional string Department ID
projectid Optional string Project ID
customerid Optional string Customer ID
vendorid Optional string Vendor ID
employeeid Optional string Employee ID
classid Optional string Class ID
itemid Optional string Item ID
contractid Optional string Contract ID
customfields Optional customfield[] Custom fields

Update Inventory Transaction (Legacy)

update_ictransaction

<update_ictransaction key="Beginning Balance-BB1234">
    <updateictransitems>
        <updateictransitem line_num="1">
            <memo>Testing1234</memo>
        </updateictransitem>
    </updateictransitems>
</update_ictransaction>

Parameters

Name Required Type Description
key Required string Document ID to update
datecreated Optional object Transaction date
referenceno Optional string Reference number
message Optional string Message
externalid Optional string External ID
customfields Optional customfield[] Custom fields
state Optional string Action. Use Draft, Pending or Closed. (Default depends on transaction definition configuration)
updateictransitems Optional array[updateictransitem, ictransitem] To update an existing line use updateictransitem otherwise to create a new line use ictransitem
updatesubtotals Optional updatesubtotal[] Subtotal lines

datecreated

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

updateictransitem

Name Required Type Description
line_num Required integer Line number to update
itemid Optional string Item ID
itemdesc Optional string Item description
warehouseid Optional string Warehouse ID
quantity Optional number Quantity
unit Optional string Unit of measure to base quantity off
cost Optional currency Cost
locationid Optional string Location ID
departmentid Optional string Department ID
itemdetails Optional itemdetail[] Array of item details
customfields Optional customfield[] Custom fields
projectid Optional string Project ID
customerid Optional string Customer ID
vendorid Optional string Vendor ID
employeeid Optional string Employee ID
classid Optional string Class ID
contractid Optional string Contract ID

ictransitem

Name Required Type Description
itemid Required string Item ID
itemdesc Optional string Item description
warehouseid Required string Warehouse ID
quantity Required number Quantity
unit Optional string Unit of measure to base quantity off
cost Optional currency Cost
locationid Optional string Location ID
departmentid Optional string Department ID
itemdetails Optional itemdetail[] Array of item details
customfields Optional customfield[] Custom fields
projectid Optional string Project ID
customerid Optional string Customer ID
vendorid Optional string Vendor ID
employeeid Optional string Employee ID
classid Optional string Class ID
contractid Optional string Contract ID

itemdetail

Name Required Type Description
quantity Optional number Quantity
serialno Optional string Serial number. Only used if not using lotno.
lotno Optional string Lot number. Only used if not using serialno.
aisle Optional string Aisle
row Optional string Row
bin Optional string Bin
itemexpiration Optional object Item expiration

itemexpiration

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

updatesubtotal

Name Required Type Description
description Required string Description
total Required currency Total
absval Optional number Absolute value
percentval Optional number Percent value
locationid Optional string Location ID
departmentid Optional string Department ID
projectid Optional string Project ID
customerid Optional string Customer ID
vendorid Optional string Vendor ID
employeeid Optional string Employee ID
classid Optional string Class ID
itemid Optional string Item ID
contractid Optional string Contract ID
customfields Optional customfield[] Custom fields

Delete Inventory Transaction

delete

<delete>
    <object>INVDOCUMENT</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use INVDOCUMENT
keys Required string The transaction RECORDNO to delete

Delete Inventory Transaction (Legacy)

delete_ictransaction

<delete_ictransaction key="Beginning Balance-BB1234"></delete_ictransaction>

Parameters

Name Required Type Description
key Required string The transaction DOCID to delete

List Inventory Transaction Lines

readByQuery

<readByQuery>
    <object>INVDOCUMENTENTRY</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
    <docparid>Beginning Balance</docparid>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use INVDOCUMENTENTRY
fields Required string Comma separated list of fields on the transaction line to list. Use * to return all fields.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)
docparid Optional string Used to indicate the document type (Ex: Inventory Transfer). You must use this to take advantage of any custom fields on the specified document type.

Get Inventory Transaction Line

read

<read>
    <object>INVDOCUMENTENTRY</object>
    <keys>1</keys>
    <fields>*</fields>
    <docparid>Beginning Balance</docparid>
</read>

Parameters

Name Required Type Description
object Required string Use INVDOCUMENTENTRY
keys Required string The transaction line RECORDNO to get
fields Required string Comma separated list of fields on the transaction line to get. Use * to return all fields.
docparid Optional string Used to indicate the document type (Ex: Inventory Transfer). You must use this to take advantage of any custom fields on the specified document type.

List Inventory Transaction Subtotals

readByQuery

<readByQuery>
    <object>INVDOCUMENTSUBTOTALS</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
    <docparid>Beginning Balance</docparid>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use INVDOCUMENTSUBTOTALS
fields Required string Comma separated list of fields on the transaction subtotal to list. Use * to return all fields.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)
docparid Optional string Used to indicate the document type (Ex: Inventory Transfer). You must use this to take advantage of any custom fields on the specified document type.

Get Inventory Transaction Subtotal

read

<read>
    <object>INVDOCUMENTSUBTOTALS</object>
    <keys>1</keys>
    <fields>*</fields>
    <docparid>Beginning Balance</docparid>
</read>

Parameters

Name Required Type Description
object Required string Use INVDOCUMENTSUBTOTALS
keys Required string The transaction subtotal RECORDNO to get
fields Required string Comma separated list of fields on the transaction subtotal to get. Use * to return all fields.
docparid Optional string Used to indicate the document type (Ex: Inventory Transfer). You must use this to take advantage of any custom fields on the specified document type.

Provide feedback