An AP bill is a transaction that tracks money owed to a vendor.


List Bills

readByQuery

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

Parameters

Name Required Type Description
object Required string Use APBILL
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 Set a custom page size between 1 and 1000 items (Default: 100)

Get Bill

read

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

Parameters

Name Required Type Description
object Required string Use APBILL
keys Required string The bill 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.

Create Bill

create

<create>
    <APBILL>
        <WHENCREATED>12/15/2016</WHENCREATED>
        <WHENPOSTED>12/15/2016</WHENPOSTED>
        <VENDORID>20000</VENDORID>
        <RECORDID>1234</RECORDID>
        <DOCNUMBER>Ref 5678</DOCNUMBER>
        <DESCRIPTION>My bill</DESCRIPTION>
        <TERMNAME>N30</TERMNAME>
        <RECPAYMENTDATE>12/23/2016</RECPAYMENTDATE>
        <SUPDOCID>A1234</SUPDOCID>
        <WHENDUE>12/25/2016</WHENDUE>
        <PAYMENTPRIORITY>high</PAYMENTPRIORITY>
        <ONHOLD>false</ONHOLD>
        <CURRENCY>USD</CURRENCY>
        <BASECURR>USD</BASECURR>
        <APBILLITEMS>
            <APBILLITEM>
                <ACCOUNTNO>6220</ACCOUNTNO>
                <TRX_AMOUNT>100.12</TRX_AMOUNT>
                <ENTRYDESCRIPTION>Line 1 of my bill</ENTRYDESCRIPTION>
                <LOCATIONID>110</LOCATIONID>
                <DEPARTMENTID>D300</DEPARTMENTID>
            </APBILLITEM>
        </APBILLITEMS>
    </APBILL>
</create>

Parameters

Name Required Type Description
APBILL Optional object The object to create

APBILL

Name Required Type Description
WHENCREATED Required string Transaction date in format mm/dd/yyyy
WHENPOSTED Optional string GL posting date in format mm/dd/yyyy. Not used if PRBATCH provided.
VENDORID Required string Vendor ID
BILLTOPAYTOCONTACTNAME Optional string Pay to contact
SHIPTORETURNTOCONTACTNAME Optional string Return to contact
RECORDID Optional string Bill number
DOCNUMBER Optional string Reference number
DESCRIPTION Optional string Description
TERMNAME Optional string Payment term
RECPAYMENTDATE Optional string Recommended to pay on date in format mm/dd/yyyy
SUPDOCID Optional string Attachments ID
WHENDUE Optional string Due date in format mm/dd/yyyy
PAYMENTPRIORITY Optional string Payment priority. Use either urgent, high, normal, low. (Default: normal)
ONHOLD Optional boolean On hold. Use false for No, true for Yes. (Default: false)
PRBATCH Optional string Summary name to post into. Required if bill summary option is set to user specified in AP config.
CURRENCY Optional string Transaction currency code
BASECURR Optional string Base currency code
EXCH_RATE_DATE Optional string Exchange rate date in format mm/dd/yyyy
EXCH_RATE_TYPE_ID Optional string Exchange rate type. Do not use if EXCHANGE_RATE is set. (Leave blank to use Intacct Daily Rate)
EXCHANGE_RATE Optional currency Exchange rate value. Do not use if EXCH_RATE_TYPE_ID is set.
ACTION Optional string Action to execute on create. Use Draft or Submit. (Default: Submit)
APBILLITEMS Required APBILLITEM[] Bill lines, must have at least 1.
Custom fields Optional varies This object supports custom fields.

APBILLITEM

Name Required Type Description
ACCOUNTNO Optional string GL account number. Required if not using ACCOUNTLABEL.
ACCOUNTLABEL Optional string AP account label. Required if not using ACCOUNTNO.
OFFSETGLACCOUNTNO Optional string AP account number
TRX_AMOUNT Required currency Transaction amount
ENTRYDESCRIPTION Optional string Memo
FORM1099 Optional boolean Form 1099. Use false for No, true for Yes. Vendor must be setup for 1099s.
FORM1099TYPE Optional string Form 1099 type
FORM1099BOX Optional string Form 1099 box
BILLABLE Optional boolean Billable. Use false for No, true for Yes. (Default: false)
ALLOCATION Optional string Allocation ID
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
ITEMID Optional string Item ID
CLASSID Optional string Class ID
CONTRACTID Optional string Contract ID
WAREHOUSEID Optional string Warehouse ID
GLDIM* Optional integer User defined dimension id field. UDD object integration name usually appended to GLDIM
Custom fields Optional varies This object supports custom fields.

Create Bill (Legacy)

create_bill

<create_bill>
    <vendorid>V1234</vendorid>
    <datecreated>
        <year>2015</year>
        <month>06</month>
        <day>30</day>
    </datecreated>
    <dateposted>
        <year>2015</year>
        <month>06</month>
        <day>30</day>
    </dateposted>
    <datedue>
        <year>2020</year>
        <month>09</month>
        <day>24</day>
    </datedue>
    <termname>N30</termname>
    <action>Submit</action>
    <batchkey></batchkey>
    <billno>1234</billno>
    <ponumber>234235</ponumber>
    <onhold>false</onhold>
    <description>Some description</description>
    <externalid></externalid>
    <payto>
        <contactname>jsmith</contactname>
    </payto>
    <returnto>
        <contactname>bsmith</contactname>
    </returnto>
    <basecurr>USD</basecurr>
    <currency>USD</currency>
    <exchratedate>
        <year>2015</year>
        <month>06</month>
        <day>30</day>
    </exchratedate>
    <exchratetype>Intacct Daily Rate</exchratetype>
    <nogl>false</nogl>
    <supdocid>A1111</supdocid>
    <customfields>
        <customfield>
            <customfieldname>customfield1</customfieldname>
            <customfieldvalue>customvalue1</customfieldvalue>
        </customfield>
    </customfields>
    <billitems>
        <lineitem>
            <glaccountno>6700</glaccountno>
            <offsetglaccountno>2010</offsetglaccountno>
            <amount>76343.43</amount>
            <memo>Just another memo</memo>
            <locationid>Location1</locationid>
            <departmentid>Department1</departmentid>
            <item1099>true</item1099>
            <key></key>
            <totalpaid></totalpaid>
            <totaldue></totaldue>
            <customfields>
                <customfield>
                    <customfieldname>customfield1</customfieldname>
                    <customfieldvalue>customvalue1</customfieldvalue>
                </customfield>
            </customfields>
            <projectid>Project1</projectid>
            <customerid>Customer1</customerid>
            <vendorid>Vendor1</vendorid>
            <employeeid>Employee1</employeeid>
            <itemid>Item1</itemid>
            <classid>Class1</classid>
            <contractid>Contract1</contractid>
            <warehouseid>Warehouse1</warehouseid>
            <billable>true</billable>
        </lineitem>
    </billitems>
</create_bill>

Parameters

Name Required Type Description
vendorid Required string Vendor ID
datecreated Required object Transaction date
dateposted Optional object GL posting date
datedue Optional object Due date
termname Optional string Payment term
action Optional string Action. Use Draft or Submit. (Default: Submit)
batchkey Optional integer Summary record number
billno Optional string Bill number
ponumber Optional string Reference number
onhold Optional boolean On hold. Use false for No, true for Yes. (Default: false)
description Optional string Description
externalid Optional string External ID
payto Optional object Pay to contact
returnto Optional object Return to contact
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.
nogl Optional boolean Do not post to GL. Use false for No, true for Yes. (Default: false)
supdocid Optional string Attachments ID
customfields Optional customfield[] Custom fields
billitems Required lineitem[] Bill lines, must have at least 1.

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

payto

Name Required Type Description
contactname Required string Pay to contact name

returnto

Name Required Type Description
contactname Required string Return to contact name

exchratedate

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

lineitem

Name Required Type Description
glaccountno Optional string GL account number. Required if not using accountlabel.
accountlabel Optional string AP account label. Required if not using glaccountno.
offsetglaccountno Optional string Offset GL account number
amount Required currency Transaction amount
allocationid Optional string Allocation ID
memo Optional string Memo
locationid Optional string Location ID
departmentid Optional string Department ID
item1099 Optional boolean Form 1099. Use false for No, true for Yes. Vendor must be setup for 1099s.
form1099type Optional string Form 1099 type
form1099box Optional string Form 1099 box
key Optional string Key
totalpaid Optional currency Total paid. Used when nogl on bill is true
totaldue Optional currency Total due. Used when nogl on bill is true
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
itemid Optional string Item ID
classid Optional string Class ID
contractid Optional string Contract ID
warehouseid Optional string Warehouse ID
billable Optional boolean Billable. Use false for No, true for Yes. (Default: false)

Update Bill

update

<update>
    <APBILL>
        <RECORDNO>65</RECORDNO>
        <DESCRIPTION>Changing the description</DESCRIPTION>
        <RECPAYMENTDATE>12/25/2016</RECPAYMENTDATE>
        <WHENDUE>12/31/2016</WHENDUE>
        <APBILLITEMS>
            <APBILLITEM>
                <LINE_NO>1</LINE_NO>
                <ACCOUNTNO>6225</ACCOUNTNO>
                <TRX_AMOUNT>100.12</TRX_AMOUNT>
                <ENTRYDESCRIPTION>Line 1 of my bill</ENTRYDESCRIPTION>
                <LOCATIONID>110</LOCATIONID>
                <DEPARTMENTID>D300</DEPARTMENTID>
            </APBILLITEM>
        </APBILLITEMS>
    </APBILL>
</update>

Parameters

Name Required Type Description
APBILL Optional object The object to update

APBILL

Name Required Type Description
RECORDNO Required integer Record number of object
WHENCREATED Optional string Transaction date in format mm/dd/yyyy
WHENPOSTED Optional string GL posting date in format mm/dd/yyyy. Not used if PRBATCH provided.
VENDORID Optional string Vendor ID
BILLTOPAYTOCONTACTNAME Optional string Pay to contact
SHIPTORETURNTOCONTACTNAME Optional string Return to contact
RECORDID Optional string Bill number
DOCNUMBER Optional string Reference number
DESCRIPTION Optional string Description
TERMNAME Optional string Payment term
RECPAYMENTDATE Optional string Recommended to pay on date in format mm/dd/yyyy
SUPDOCID Optional string Attachments ID
WHENDUE Optional string Due date in format mm/dd/yyyy
PAYMENTPRIORITY Optional string Payment priority. Use either urgent, high, normal, low. (Default: normal)
ONHOLD Optional boolean On hold. Use false for No, true for Yes. (Default: false)
PRBATCH Optional string Summary name to post into.
CURRENCY Optional string Transaction currency code
BASECURR Optional string Base currency code
EXCH_RATE_DATE Optional string Exchange rate date in format mm/dd/yyyy
EXCH_RATE_TYPE_ID Optional string Exchange rate type. Do not use if EXCHANGE_RATE is set. (Leave blank to use Intacct Daily Rate)
EXCHANGE_RATE Optional currency Exchange rate value. Do not use if EXCH_RATE_TYPE_ID is set.
ACTION Optional string Action to execute on create. Use Draft or Submit. (Default: Submit)
APBILLITEMS Optional APBILLITEM[] Bill lines
Custom fields Optional varies This object supports custom fields.

APBILLITEM

Name Required Type Description
LINE_NO Optional integer Line number to update otherwise leave blank to add a new line.
ACCOUNTNO Optional string GL account number. Required if not using ACCOUNTLABEL.
ACCOUNTLABEL Optional string AP account label. Required if not using ACCOUNTNO.
OFFSETGLACCOUNTNO Optional string AP account number
TRX_AMOUNT Required currency Transaction amount
ENTRYDESCRIPTION Optional string Memo
FORM1099 Optional boolean Form 1099. Use false for No, true for Yes. Vendor must be setup for 1099s.
FORM1099TYPE Optional string Form 1099 type
FORM1099BOX Optional string Form 1099 box
BILLABLE Optional boolean Billable. Use false for No, true for Yes. (Default: false)
ALLOCATION Optional string Allocation ID
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
ITEMID Optional string Item ID
CLASSID Optional string Class ID
CONTRACTID Optional string Contract ID
WAREHOUSEID Optional string Warehouse ID
GLDIM* Optional integer User defined dimension id field. UDD object integration name usually appended to GLDIM
Custom fields Optional varies This object supports custom fields.

Update Bill (Legacy)

update_bill

<update_bill key="1234">
    <updatebillitems>
        <updatelineitem line_num="1">
            <glaccountno>7940</glaccountno>
        </updatelineitem>
    </updatebillitems>
</update_bill>

Parameters

Name Required Type Description
key Required integer Record number of bill to update
vendorid Optional string Vendor ID
datecreated Optional object Transaction date
dateposted Optional object GL posting date
datedue Optional object Due date
termname Optional string Payment term
action Optional string Action. Use Draft or Submit. (Default: Submit)
billno Optional string Bill number
ponumber Optional string Reference number
onhold Optional boolean On hold. Use false for No, true for Yes. (Default: false)
description Optional string Description
payto Optional object Pay to contact
returnto Optional object Return to contact
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.
supdocid Optional string Attachments ID
customfields Optional customfield[] Custom fields
updatebillitems Required array[updatelineitem, lineitem] To update an existing line use updatelineitem otherwise to create a new line use lineitem

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

payto

Name Required Type Description
contactname Required string Pay to contact name

returnto

Name Required Type Description
contactname Required string Return to contact name

exchratedate

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

updatelineitem

Name Required Type Description
line_num Required integer Line number to update
glaccountno Optional string GL account number. Cannot use if using accountlabel.
accountlabel Optional string AP account label. Cannot use if using glaccountno.
offsetglaccountno Optional string Offset GL account number
amount Optional currency Transaction amount
memo Optional string Memo
locationid Optional string Location ID
departmentid Optional string Department ID
item1099 Optional boolean Form 1099. Use false for No, true for Yes. Vendor must be setup for 1099s.
form1099type Optional string Form 1099 type
form1099box Optional string Form 1099 box
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
itemid Optional string Item ID
classid Optional string Class ID
contractid Optional string Contract ID
warehouseid Optional string Warehouse ID
billable Optional boolean Billable. Use false for No, true for Yes. (Default: false)

lineitem

Name Required Type Description
glaccountno Optional string GL account number. Required if not using accountlabel.
accountlabel Optional string AP account label. Required if not using glaccountno.
offsetglaccountno Optional string Offset GL account number
amount Required currency Transaction amount
allocationid Optional string Allocation ID
memo Optional string Memo
locationid Optional string Location ID
departmentid Optional string Department ID
item1099 Optional boolean Form 1099. Use false for No, true for Yes. Vendor must be setup for 1099s.
form1099type Optional string Form 1099 type
form1099box Optional string Form 1099 box
key Optional string Key
totalpaid Optional currency Total paid. Used when nogl on bill is true
totaldue Optional currency Total due. Used when nogl on bill is true
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
itemid Optional string Item ID
classid Optional string Class ID
contractid Optional string Contract ID
warehouseid Optional string Warehouse ID
billable Optional boolean Billable. Use false for No, true for Yes. (Default: false)

Delete Bill

delete

<delete>
    <object>APBILL</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use APBILL
keys Required string The bill RECORDNO to delete

List Bill Lines

readByQuery

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

Parameters

Name Required Type Description
object Required string Use APBILLITEM
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 Set a custom page size between 1 and 1000 items (Default: 100)

Get Bill Line

read

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

Parameters

Name Required Type Description
object Required string Use APBILLITEM
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.

Provide feedback