List Purchasing Transactions

readByQuery

<readByQuery>
    <object>PODOCUMENT</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
    <docparid>Purchase Order</docparid>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use PODOCUMENT
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: Purchase Order). You must use this to take advantage of any custom fields on the specified document type.

Get Purchasing Transaction

read

<read>
    <object>PODOCUMENT</object>
    <keys>1</keys>
    <fields>*</fields>
    <docparid>Purchase Order</docparid>
</read>

Parameters

Name Required Type Description
object Required string Use PODOCUMENT
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: Purchase Order). You must use this to take advantage of any custom fields on the specified document type.

Create Purchasing Transaction (Legacy)

create_potransaction

<create_potransaction>
    <transactiontype>Purchase Requisition</transactiontype>
    <datecreated>
        <year>2013</year>
        <month>6</month>
        <day>19</day>
    </datecreated>
    <createdfrom></createdfrom>
    <vendorid>1001</vendorid>
    <documentno></documentno>
    <referenceno>1234</referenceno>
    <vendordocno>vendordocno001</vendordocno>
    <termname></termname>
    <datedue>
        <year>2013</year>
        <month>6</month>
        <day>20</day>
    </datedue>
    <message></message>
    <shippingmethod></shippingmethod>
    <returnto>
        <contactname></contactname>
    </returnto>
    <payto>
        <contactname></contactname>
    </payto>
    <supdocid></supdocid>
    <externalid></externalid>
    <basecurr></basecurr>
    <currency></currency>
    <exchratedate></exchratedate>
    <exchratetype>Intacct Daily Rate</exchratetype>
    <exchrate></exchrate>
    <customfields></customfields>
    <state></state>
    <potransitems>
        <potransitem>
            <itemid>75300GL</itemid>
            <itemdesc></itemdesc>
            <taxable></taxable>
            <warehouseid></warehouseid>
            <quantity>100</quantity>
            <unit>Each</unit>
            <price>1</price>
            <locationid>MGMT-US</locationid>
            <departmentid>IT</departmentid>
            <memo></memo>
            <itemdetails>
                <itemdetail>
                    <quantity/>
                    <serialno/>
                    <lotno/>
                    <aisle/>
                    <row/>
                    <bin/>
                    <itemexpiration/>
                </itemdetail>
            </itemdetails>
            <form1099></form1099>
            <customfields></customfields>
            <projectid></projectid>
            <customerid></customerid>
            <vendorid></vendorid>
            <employeeid></employeeid>
            <classid></classid>
            <billable></billable>
        </potransitem>
    </potransitems>
    <subtotals>
        <subtotal>
            <description></description>
            <total></total>
            <absval></absval>
            <percentval></percentval>
            <locationid></locationid>
            <departmentid></departmentid>
            <projectid></projectid>
            <customerid></customerid>
            <vendorid></vendorid>
            <employeeid></employeeid>
            <classid></classid>
            <itemid></itemid>
        </subtotal>
    </subtotals>
</create_potransaction>

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 Purchasing transaction document number to convert from
vendorid Required String Vendor ID
documentno Optional string Document number. Leave blank to use auto numbering if set in definition
referenceno Optional string Reference number
vendordocno Optional string Vendor document number
termname Optional string Payment term
datedue Required object Due date
message Optional string Message
shippingmethod Optional string Shipping method
returnto Required object Return to contact. Send it null to use vendor’s default.
payto Required object Pay to contact. Send it null to use vendor’s default.
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.
customfields Optional customfield[] Custom fields
state Optional string Action. Use Draft, Pending or Closed. (Default depends on transaction definition configuration)
potransitems Required potransitem[] 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

datedue

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

returnto

Name Required Type Description
contactname Required string Return to contact name

payto

Name Required Type Description
contactname Required string Pay to contact name

exchratedate

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

potransitem

Name Required Type Description
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
price Optional currency Price
sourcelinekey Optional integer Source line to convert this line from. Use the record number of the line.
overridetaxamount Optional currency Override tax amount
tax Optional currency Tax amount
locationid Optional string Location ID
departmentid Optional string Department ID
memo Optional string Memo
itemdetails Optional itemdetail[] Array of item details
form1099 Optional boolean Form 1099. Use false for No, true for Yes. Vendor must be setup for 1099s.
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
billable Optional boolean Billable. Use false for No, true for Yes. (Default: false)

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

update_potransaction

<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
datecreated Optional object Transaction date
dateposted Optional object GL posting date
referenceno Optional string Reference number
vendordocno Optional string Vendor document number
termname Optional string Payment term
datedue Optional object Due date
message Optional string Message
shippingmethod Optional string Shipping method
returnto Optional object Return to contact
payto Optional object Pay 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.
customfields Optional customfield[] Custom fields
state Optional string Action. Use Draft, Pending or Closed. (Default depends on transaction definition configuration)
updatepotransitems optional array[updatepotransitem, potransitem] To update an existing line use updatepotransitem otherwise to create a new line use potransitem
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

datedue

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

returnto

Name Required Type Description
contactname Required string Return to contact name

payto

Name Required Type Description
contactname Required string Pay to contact name

exchratedate

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

updatepotransitem

Name Required Type Description
line_num Required integer Line number to update
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
price Optional currency Price
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
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
billable Optional boolean Billable. Use false for No, true for Yes. (Default: false)

potransitem

Name Required Type Description
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
price Optional currency Price
sourcelinekey Optional integer Source line to convert this line from. Use the record number of the line.
overridetaxamount Optional currency Override tax amount
tax Optional currency Tax amount
locationid Optional string Location ID
departmentid Optional string Department ID
memo Optional string Memo
itemdetails Optional itemdetail[] Array of item details
form1099 Optional boolean Form 1099. Use false for No, true for Yes. Vendor must be setup for 1099s.
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
billable Optional boolean Billable. Use false for No, true for Yes. (Default: false)

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

Partial Update Purchasing Transaction (Legacy)

This function is used to partially update a purchasing transaction, usually adjusting its GL posting date.

partialupdate_potransaction

<partialupdate_potransaction key="Vendor Invoice-VI1234">
    <dateposted>
        <year>2017</year>
        <month>3</month>
        <day>1</day>
    </dateposted>
</partialupdate_potransaction>

Parameters

Name Required Type Description
key Required string Document ID of transaction to update
dateposted Optional object GL posting date

dateposted

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

Delete Purchasing Transaction

delete

<delete>
    <object>PODOCUMENT</object>
    <keys>112</keys>
</delete>

Parameters

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

Delete Purchasing Transaction (Legacy)

delete_potransaction

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

Parameters

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

List Purchasing Transaction Lines

readByQuery

<readByQuery>
    <object>PODOCUMENTENTRY</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
    <docparid>Purchase Order</docparid>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use PODOCUMENTENTRY
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: Purchase Order). You must use this to take advantage of any custom fields on the specified document type.

Get Purchasing Transaction Line

read

<read>
    <object>PODOCUMENTENTRY</object>
    <keys>1</keys>
    <fields>*</fields>
    <docparid>Purchase Order</docparid>
</read>

Parameters

Name Required Type Description
object Required string Use PODOCUMENTENTRY
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: Purchase Order). You must use this to take advantage of any custom fields on the specified document type.

List Purchasing Transaction Subtotals

readByQuery

<readByQuery>
    <object>PODOCUMENTSUBTOTALS</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
    <docparid>Purchase Order</docparid>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use PODOCUMENTSUBTOTALS
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: Purchase Order). You must use this to take advantage of any custom fields on the specified document type.

Get Purchasing Transaction Subtotal

read

<read>
    <object>PODOCUMENTSUBTOTALS</object>
    <keys>1</keys>
    <fields>*</fields>
    <docparid>Purchase Order</docparid>
</read>

Parameters

Name Required Type Description
object Required string Use PODOCUMENTSUBTOTALS
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: Purchase Order). You must use this to take advantage of any custom fields on the specified document type.

Provide feedback