An AR adjustment is a transaction that applies a credit or debit in order to modify the amount owed to a customer.


List AR Adjustments

readByQuery

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

Parameters

Name Required Type Description
object Required string Use ARADJUSTMENT
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)

Get AR Adjustment

read

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

Parameters

Name Required Type Description
object Required string Use ARADJUSTMENT
keys Required string The adjustment 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 AR Adjustment (Legacy)

create_aradjustment

<create_aradjustment>
    <customerid>1000</customerid>
    <datecreated>
        <year>2013</year>
        <month>5</month>
        <day>28</day>
    </datecreated>
    <adjustmentno></adjustmentno>
    <invoiceno></invoiceno>
    <description></description>
    <basecurr>USD</basecurr>
    <currency>USD</currency>
    <aradjustmentitems>
        <lineitem>
            <glaccountno>4000</glaccountno>
            <amount>1234.56</amount>
            <memo>test line 1</memo>
            <locationid>ARL-VA-US</locationid>
            <departmentid>SAL</departmentid>
            <projectid></projectid>
            <customerid></customerid>
            <vendorid></vendorid>
            <employeeid></employeeid>
            <itemid></itemid>
            <classid></classid>
        </lineitem>
    </aradjustmentitems>
</create_aradjustment>

Parameters

Name Required Type Description
customerid Required string Customer ID
datecreated Required object Transaction date
dateposted Optional object GL posting date
batchkey Optional integer Summary record number
adjustmentno Optional string Adjustment number
action Optional string Action. Use Draft or Submit. (Default: Submit)
invoiceno Optional string Invoice number
description Optional string Description
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.
nogl Optional boolean Do not post to GL. Use false for No, true for Yes. (Default: false)
aradjustmentitems Required lineitem[] Invoice 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

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
memo Optional string Memo
locationid Optional string Location ID
departmentid Optional string Department ID
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

Update AR Adjustment (Legacy)

update_aradjustment

<update_aradjustment key="123">
    <customerid>C1234</customerid>
    <datecreated>
        <year>2015</year>
        <month>06</month>
        <day>30</day>
    </datecreated>
    <dateposted>
        <year>2015</year>
        <month>06</month>
        <day>30</day>
    </dateposted>
    <adjustmentno></adjustmentno>
    <action>Posted</action>
    <invoiceno></invoiceno>
    <description>my adjustment</description>
    <currency>USD</currency>
    <exchratetype>Intacct Daily Rate</exchratetype>
    <updatearadjustmentitems>
        <updatelineitem line_num="1">
            <glaccountno>4000</glaccountno>
            <amount>100.25</amount>
            <memo>line 1</memo>
            <locationid>L100</locationid>
            <departmentid>D200</departmentid>
        </updatelineitem>
        <lineitem>
            <glaccountno>4000</glaccountno>
            <amount>20.99</amount>
            <memo>add a new line</memo>
            <locationid>L100</locationid>
            <departmentid>D200</departmentid>
        </lineitem>
    </updatearadjustmentitems>
</update_aradjustment>

Parameters

Name Required Type Description
key Required integer Record number of bill to update
customerid Optional string Customer ID
datecreated Optional object Transaction date
dateposted Optional object GL posting date
adjustmentno Optional string Adjustment number
action Optional string Action. Use Draft or Submit. (Default: Submit)
invoiceno Optional string Invoice number
description Optional string Description
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.
updatearadjustmentitems Optional 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

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 Required currency Transaction amount
memo Optional string Memo
locationid Optional string Location ID
departmentid Optional string Department ID
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

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
memo Optional string Memo
locationid Optional string Location ID
departmentid Optional string Department ID
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

Delete AR Adjustment

delete

<delete>
    <object>ARADJUSTMENT</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use ARADJUSTMENT
keys Required string The adjustment RECORDNO to delete

Delete AR Adjustment (Legacy)

delete_aradjustment

<delete_aradjustment key="123"></delete_aradjustment>

Parameters

Name Required Type Description
key Required integer Record number of adjustment to delete

List AR Adjustment Lines

readByQuery

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

Parameters

Name Required Type Description
object Required string Use ARADJUSTMENTITEM
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)

Get AR Adjustment Line

read

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

Parameters

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