List Order Entry Transactions

readByQuery

<readByQuery>
    <object>SODOCUMENT</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
    <docparid>Sales Order</docparid>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use SODOCUMENT
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. 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 Custom page size between 1 and 1000 items (Default: 100)
docparid Optional string Used to indicate the document type (Ex: Sales Order). You must use this to take advantage of any custom fields on the specified document type.

Get Order Entry Transaction

read

<read>
    <object>SODOCUMENT</object>
    <keys>1</keys>
    <fields>*</fields>
    <docparid>Sales Order</docparid>
</read>

Parameters

Name Required Type Description
object Required string Use SODOCUMENT
keys Required string The transaction RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
docparid Optional string Used to indicate the document type (Ex: Sales Order). You must use this to take advantage of any custom fields on the specified document type.

Create Order Entry Transaction (Legacy)

create_sotransaction

<create_sotransaction>
    <transactiontype>Sales Invoice</transactiontype>
    <datecreated>
        <year>2017</year>
        <month>3</month>
        <day>8</day>
    </datecreated>
    <createdfrom>Sales Order-SO1234</createdfrom>
    <customerid>C1000</customerid>
    <documentno>docno001</documentno>
    <origdocdate>
        <year>2017</year>
        <month>3</month>
        <day>8</day>
    </origdocdate>
    <referenceno>1234</referenceno>
    <termname>Net 30</termname>
    <datedue>
        <year>2016</year>
        <month>4</month>
        <day>7</day>
    </datedue>
    <message>hello world</message>
    <shippingmethod>FedEx</shippingmethod>
    <shipto>
        <contactname>Ship to contact</contactname>
    </shipto>
    <billto>
        <contactname>Bill to contact</contactname>
    </billto>
    <supdocid></supdocid>
    <basecurr>USD</basecurr>
    <currency>USD</currency>
    <exchratedate></exchratedate>
    <exchratetype>Intacct Daily Rate</exchratetype>
    <exchrate></exchrate>
    <vsoepricelist></vsoepricelist>
    <customfields></customfields>
    <state>Pending</state>
    <sotransitems>
        <sotransitem>
            <bundlenumber></bundlenumber>
            <itemid>R0044</itemid>
            <itemdesc></itemdesc>
            <taxable></taxable>
            <warehouseid></warehouseid>
            <quantity>1</quantity>
            <unit>Each</unit>
            <discountpercent></discountpercent>
            <price>100</price>
            <discsurchargememo></discsurchargememo>
            <locationid>ARL-VA-US</locationid>
            <departmentid>ADM</departmentid>
            <memo></memo>
            <revrectemplate></revrectemplate>
            <revrecstartdate></revrecstartdate>
            <revrecenddate></revrecenddate>
            <renewalmacro></renewalmacro>
            <projectid></projectid>
            <customerid></customerid>
            <vendorid></vendorid>
            <employeeid></employeeid>
            <classid></classid>
            <fulfillmentstatus></fulfillmentstatus>
            <taskno></taskno>
            <billingtemplate></billingtemplate>
        </sotransitem>
    </sotransitems>
    <subtotals>
        <subtotal>
            <description>Shipping</description>
            <total>20</total>
            <absval></absval>
            <percentval></percentval>
            <locationid>ARL-VA-US</locationid>
            <departmentid>ADM</departmentid>
            <projectid></projectid>
            <customerid></customerid>
            <vendorid></vendorid>
            <employeeid></employeeid>
            <classid></classid>
            <itemid></itemid>
        </subtotal>
    </subtotals>
</create_sotransaction>

Parameters

Name Required Type Description
transactiontype Required string Transaction definition to use
datecreated Required object Transaction date
dateposted Optional object GL posting date
createdfrom Optional string Order Entry transaction document number to convert from
customerid Required String Customer ID
documentno Optional string Document number. Leave blank to use auto numbering if set in definition
origdocdate Optional object Original document date
referenceno Optional string Reference number
termname Optional string Payment term
datedue Optional object Due date
message Optional string Message
shippingmethod Optional string Shipping method
shipto Optional object Ship to contact
billto Optional object Bill to contact
supdocid Optional string Attachments ID
externalid Optional string External ID
basecurr Optional string Base currency code
currency Optional string Transaction currency code
exchratedate Optional object Exchange rate date.
exchratetype Optional string Exchange rate type. Do not use if exchrate is set. (Leave blank to use Intacct Daily Rate)
exchrate Optional currency Exchange rate value. Do not use if exchangeratetype is set.
vsoepricelist Optional string VSOE price list
customfields Optional customfield[] Custom fields
state Optional string Action. Use Draft, Pending or Closed. (Default depends on transaction definition configuration)
projectid Optional string Project ID
sotransitems Required sotransitem[] 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

dateposted

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

origdocdate

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

datedue

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

shipto

Name Required Type Description
contactname Required string Ship to contact name

billto

Name Required Type Description
contactname Required string Bill to contact name

exchratedate

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

sotransitem

Name Required Type Description
bundlenumber Optional string Bundle number
itemid Required string Item ID
itemdesc Optional string Item description
taxable Optional boolean Taxable. Use false for No, true for Yes. Customer must be setup for taxable.
warehouseid Optional string Warehouse ID
quantity Required number Quantity
unit Optional string Unit of measure to base quantity off
discountpercent Optional number Discount percentage
price Optional currency Price
sourcelinekey Optional integer Source line to convert this line from. Use the record number of the line from the createdfrom transaction document.
discsurchargememo Optional string Discount/surcharge memo
locationid Optional string Location ID
departmentid Optional string Department ID
memo Optional string Memo
itemdetails Optional itemdetail[] Array of item details
customfields Optional customfield[] Custom fields
revrectemplate Optional string Rev rec template ID
revrecstartdate Optional object Rev rec start date
revrecenddate Optional object Rev rec end date
renewalmacro Optional string Renewal macro
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
fulfillmentstatus Optional object Fulfillment Status
taskno Optional string Task record number
billingtemplate Optional string Billing template
dropship Optional boolean Drop ship. Use false for No, true for Yes.
shipto Optional string Ship to contact name for the transaction line, which overrides the ship to contact name on the transaction.

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

fulfillmentstatus

Name Required Type Description
deliverystatus Optional string Delivery status. Use either Delivered or Undelivered
deliverydate Optional object Delivery date
deferralstatus Optional string Deferral status. Use either Defer until item is delivered or Defer bundle until item is delivered
kitstatus Optional object Kit status

kitstatus

Name Required Type Description
line_num Required integer Line number
invoiceprice Optional currency Invoice price
deliverystatus Optional string Delivery status. Use either Delivered or Undelivered
deliverydate Optional object Delivery date
deferralstatus Optional string Deferral status. Use either Defer until item is delivered or Defer bundle until item is delivered

deliverydate

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 Order Entry Transaction (Legacy)

update_sotransaction

<update_sotransaction key="Sales Order-SO1234">
    <updatesotransitems>
        <updatesotransitem line_num="1">
            <memo>Testing1234</memo>
        </updatesotransitem>
    </updatesotransitems>
</update_sotransaction>

Parameters

Name Required Type Description
key Required string Document ID to update
disablevalidation Optional boolean Disable transaction validation on update. Use false for No, true for Yes.
datecreated Optional object Transaction date
dateposted Optional object GL posting date
referenceno Optional string Reference number
termname Optional string Payment term
datedue Optional object Due date
origdocdate Optional object Original document date
message Optional string Message
shippingmethod Optional string Shipping method
shipto Optional object Ship to contact
billto Optional object Bill to contact
supdocid Optional string Attachments ID
externalid Optional string External ID
basecurr Optional string Base currency code
currency Optional string Transaction currency code
exchratedate Optional object Exchange rate date.
exchratetype Optional string Exchange rate type. Do not use if exchrate is set. (Leave blank to use Intacct Daily Rate)
exchrate Optional currency Exchange rate value. Do not use if exchangeratetype is set.
vsoepricelist Optional string VSOE price list
customfields Optional customfield[] Custom fields
state Optional string Action. Use Draft, Pending or Closed. (Default depends on transaction definition configuration)
projectid Optional string Project ID
updatesotransitems Required array[updatesotransitem, sotransitem] To update an existing line use updatesotransitem otherwise to create a new line use sotransitem
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

dateposted

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

origdocdate

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

datedue

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

shipto

Name Required Type Description
contactname Required string Ship to contact name

billto

Name Required Type Description
contactname Required string Bill to contact name

exchratedate

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

updatesotransitem

Name Required Type Description
line_num Required integer Line number to update.
bundlenumber Optional string Bundle number
itemid Optional string Item ID
itemdesc Optional string Item description
taxable Optional boolean Taxable. Use false for No, true for Yes. Customer must be setup for taxable.
warehouseid Optional string Warehouse ID
quantity Optional number Quantity
unit Optional string Unit of measure to base quantity off
discountpercent Optional number Discount percentage
price Optional currency Price
discsurchargememo Optional string Discount/surcharge memo
locationid Optional string Location ID
departmentid Optional string Department ID
memo Optional string Memo
itemdetails Optional itemdetail[] Array of item details
customfields Optional customfield[] Custom fields
revrectemplate Optional string Rev rec template ID
revrecstartdate Optional object Rev rec start date
revrecenddate Optional object Rev rec end date
renewalmacro Optional string Renewal macro
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
fulfillmentstatus Optional object Fulfillment Status
taskno Optional string Task record number
billingtemplate Optional string Billing template
dropship Optional boolean Drop ship. Use false for No, true for Yes.

sotransitem

Name Required Type Description
bundlenumber Optional string Bundle number
itemid Required string Item ID
itemdesc Optional string Item description
taxable Optional boolean Taxable. Use false for No, true for Yes. Customer must be setup for taxable.
warehouseid Optional string Warehouse ID
quantity Required number Quantity
unit Optional string Unit of measure to base quantity off
discountpercent Optional number Discount percentage
price Optional currency Price
sourcelinekey Optional integer Source line to convert this line from. Use the record number of the line from the createdfrom transaction document.
discsurchargememo Optional string Discount/surcharge memo
locationid Optional string Location ID
departmentid Optional string Department ID
memo Optional string Memo
itemdetails Optional itemdetail[] Array of item details
customfields Optional customfield[] Custom fields
revrectemplate Optional string Rev rec template ID
revrecstartdate Optional object Rev rec start date
revrecenddate Optional object Rev rec end date
renewalmacro Optional string Renewal macro
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
fulfillmentstatus Optional object Fulfillment Status
taskno Optional string Task record number
billingtemplate Optional string Billing template
dropship Optional boolean Drop ship. Use false for No, true for Yes.

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

fulfillmentstatus

Name Required Type Description
deliverystatus Optional string Delivery status. Use either Delivered or Undelivered
deliverydate Optional object Delivery date
deferralstatus Optional string Deferral status. Use either Defer until item is delivered or Defer bundle until item is delivered
kitstatus Optional object Kit status

kitstatus

Name Required Type Description
line_num Required integer Line number
invoiceprice Optional currency Invoice price
deliverystatus Optional string Delivery status. Use either Delivered or Undelivered
deliverydate Optional object Delivery date
deferralstatus Optional string Deferral status. Use either Defer until item is delivered or Defer bundle until item is delivered

deliverydate

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 Order Entry Transaction

delete

<delete>
    <object>SODOCUMENT</object>
    <keys>112</keys>
</delete>

Parameters

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

Delete Order Entry Transaction (Legacy)

delete_sotransaction

<delete_sotransaction key="Sales Order-SO1234"></delete_sotransaction>

Parameters

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

List Order Entry Transaction Lines

readByQuery

<readByQuery>
    <object>SODOCUMENTENTRY</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
    <docparid>Sales Order</docparid>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use SODOCUMENTENTRY
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. 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 Custom page size between 1 and 1000 items (Default: 100)
docparid Optional string Used to indicate the document type (Ex: Sales Order). You must use this to take advantage of any custom fields on the specified document type.

Get Order Entry Transaction Line

read

<read>
    <object>SODOCUMENTENTRY</object>
    <keys>1</keys>
    <fields>*</fields>
    <docparid>Sales Order</docparid>
</read>

Parameters

Name Required Type Description
object Required string Use SODOCUMENTENTRY
keys Required string The transaction line RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
docparid Optional string Used to indicate the document type (Ex: Sales Order). You must use this to take advantage of any custom fields on the specified document type.

List Order Entry Transaction Subtotals

readByQuery

<readByQuery>
    <object>SODOCUMENTSUBTOTALS</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
    <docparid>Sales Order</docparid>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use SODOCUMENTSUBTOTALS
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. 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 Custom page size between 1 and 1000 items (Default: 100)
docparid Optional string Used to indicate the document type (Ex: Sales Order). You must use this to take advantage of any custom fields on the specified document type.

Get Order Entry Transaction Subtotal

read

<read>
    <object>SODOCUMENTSUBTOTALS</object>
    <keys>1</keys>
    <fields>*</fields>
    <docparid>Sales Order</docparid>
</read>

Parameters

Name Required Type Description
object Required string Use SODOCUMENTSUBTOTALS
keys Required string The transaction subtotal RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
docparid Optional string Used to indicate the document type (Ex: Sales Order). You must use this to take advantage of any custom fields on the specified document type.

Provide feedback