An AR invoice represents an invoice received from a customer.

Certain types of transaction definitions in Order Entry (e.g. Sales Invoice, Contract Invoice, Sales Credit Memo) are configured to create corresponding invoices in the Accounts Receivable module. When a transaction is updated in Order Entry, the related AR transaction is deleted and recreated. As a result, the AR transaction will have a new RECORDNO. Integrations relying on these records should consider using a MODULEKEY filter outlined below.


List Invoices

readByQuery

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

Parameters

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

query

Name Required Type Description
MODULEKEY Optional string Source module transaction created from. Use 4.AR for Accounts Receivable or 8.SO for Order Entry

Get Invoice

read

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

Parameters

Name Required Type Description
object Required string Use ARINVOICE
keys Required string Invoice 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 Invoice (Legacy)

create_invoice

<create_invoice>
    <customerid>CUSTOMER1</customerid>
    <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>
    <batchkey>20323</batchkey>
    <action>Submit</action>
    <invoiceno>234</invoiceno>
    <ponumber>234235</ponumber>
    <description>Some description</description>
    <externalid>20394</externalid>
    <billto>
        <contactname>28952</contactname>
    </billto>
    <shipto>
        <contactname>289533</contactname>
    </shipto>
    <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>6942</supdocid>
    <customfields>
        <customfield>
            <customfieldname>customfield1</customfieldname>
            <customfieldvalue>customvalue1</customfieldvalue>
        </customfield>
    </customfields>
    <invoiceitems>
        <lineitem>
            <accountlabel>TestBill Account1</accountlabel>
            <offsetglaccountno>93590253</offsetglaccountno>
            <amount>76343.43</amount>
            <memo>Just another memo</memo>
            <locationid>Location1</locationid>
            <departmentid>Department1</departmentid>
            <key>Key1</key>
            <totalpaid>23484.93</totalpaid>
            <totaldue>0</totaldue>
            <customfields>
                <customfield>
                    <customfieldname>customfield1</customfieldname>
                    <customfieldvalue>customvalue1</customfieldvalue>
                </customfield>
            </customfields>
            <revrectemplate>RevRec1</revrectemplate>
            <defrevaccount>2100</defrevaccount>
            <revrecstartdate>
                <year>2016</year>
                <month>06</month>
                <day>01</day>
            </revrecstartdate>
            <revrecenddate>
                <year>2017</year>
                <month>05</month>
                <day>31</day>
            </revrecenddate>
            <projectid>Project1</projectid>
            <customerid>Customer1</customerid>
            <vendorid>Vendor1</vendorid>
            <employeeid>Employee1</employeeid>
            <itemid>Item1</itemid>
            <classid>Class1</classid>
            <warehouseid>Warehouse1</warehouseid>
        </lineitem>
    </invoiceitems>
</create_invoice>

Parameters

Name Required Type Description
customerid Required string Customer ID
datecreated Required object Transaction date
dateposted Optional object GL posting date
datedue Optional object Due date
termname Optional string Payment term
batchkey Optional integer Summary RECORDNO
action Optional string Action. Use Draft or Submit. (Default: Submit)
invoiceno Optional string Invoice number
ponumber Optional string Reference number
description Optional string Description
externalid Optional string External ID
billto Optional object Bill to contact
shipto Optional object Ship 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[0...n] Custom fields
invoiceitems Required lineitem[1...n] 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

datedue

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

billto

Name Required Type Description
contactname Required string Bill to contact name

shipto

Name Required Type Description
contactname Required string Ship to contact name

exchratedate

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

customfield

Name Required Type Description
customfieldname Optional string Custom field ID
customfieldvalue Optional varies Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#.

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
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[0...n] Custom fields
revrectemplate Optional string Rev rec template ID
defrevaccount Optional string Deferred revenue GL account number
revrecstartdate Optional object Rev rec start date
revrecenddate Optional object Rev rec end date
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

revrecstartdate

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

revrecenddate

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

Update Invoice (Legacy)

update_invoice

<update_invoice key="123">
    <updateinvoiceitems>
        <updatelineitem line_num="1">
            <memo>hello world</memo>
        </updatelineitem>
    </updateinvoiceitems>
</update_invoice>

Parameters

Name Required Type Description
key Required integer Invoice RECORDNO to update
customerid Optional string Customer 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)
invoiceno Optional string Invoice number
ponumber Optional string Reference number
description Optional string Description
payto Optional object Bill to contact
returnto Optional object Ship 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.
supdocid Optional string Attachments ID
customfields Optional customfield[0...n] Custom fields
updateinvoiceitems Required (updatelineitem | lineitem)[1...n] To update an existing line use updatelineitem otherwise to create a new line use lineitem. You can mix types in the array.

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 Bill to contact name

returnto

Name Required Type Description
contactname Required string Ship to contact name

exchratedate

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

customfield

Name Required Type Description
customfieldname Optional string Custom field ID
customfieldvalue Optional varies Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#.

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
customfields Optional customfield[0...n] Custom fields
revrectemplate Optional string Rev rec template ID
defrevaccount Optional string Deferred revenue GL account number
revrecstartdate Optional object Rev rec start date
revrecenddate Optional object Rev rec end date
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
allocationid Optional string Allocation ID
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[0...n] Custom fields
revrectemplate Optional string Rev rec template ID
defrevaccount Optional string Deferred revenue GL account number
revrecstartdate Optional object Rev rec start date
revrecenddate Optional object Rev rec end date
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

revrecstartdate

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

revrecenddate

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

Reverse Invoice (Legacy)

reverse_invoice

<reverse_invoice key="1234">
    <datereversed>
        <year>2015</year>
        <month>06</month>
        <day>30</day>
    </datereversed>
</reverse_invoice>

Parameters

Name Required Type Description
key Required integer Invoice RECORDNO to reverse
datereversed Required object Reverse date
description Optional string Memo

datereversed

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

Delete Invoice

delete

<delete>
    <object>ARINVOICE</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use ARINVOICE
keys Required string Invoice RECORDNO to delete

Delete Invoice (Legacy)

delete_invoice

<delete_invoice key="1234"></delete_invoice>

Parameters

Name Required Type Description
key Required string Invoice RECORDNO to delete

Provide feedback