AR Summaries

Summaries are collections of the same type of transactions, grouped together for processing.

Get Invoice Summaries Object Definition

lookup

List all the fields and relationships for the AR invoice summary object:

<lookup>
    <object>ARINVOICEBATCH</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use ARINVOICEBATCH

List Invoice Summaries

query

List the record number, title, and status for each active and open invoice summary:

<query>
    <object>ARINVOICEBATCH</object>
    <select>
        <field>RECORDNO</field>
        <field>TITLE</field>
        <field>STATUS</field>
    </select>
    <filter>
        <and>
            <equalto>
                <field>STATUS</field>
                <value>active</value>
            </equalto>
            <equalto>
                <field>OPEN</field>
                <value>Open</value>
            </equalto>
        </and>
    </filter>
</query>

Parameters

Name Required Type Description
object Required string Use ARINVOICEBATCH
select Required sequence One or more field names and an optional aggregate function such as count or sum. Returning all fields is not supported.
filter Optional object Query filter expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
        <field>RECORDNO</field>
        <descending/>
</order>
options Optional object Set the caseinsensitive element to true for a case-insensitive query:
    <caseinsensitive>true</caseinsensitive>
In a multi-entity company, set the showprivate element to true to query data in private entities:
   <showprivate>true</showprivate>
pagesize Optional integer Custom page size between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

List Invoice Summaries (Legacy)

readByQuery

List active and open invoice summaries:

<readByQuery>
    <object>ARINVOICEBATCH</object>
    <fields>*</fields>
    <query>STATUS = 'T' AND OPEN = 'T'</query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use ARINVOICEBATCH
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. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

List Invoice Summaries (Legacy)

get_list

<get_list object="invoicebatch" maxitems="10">
</get_list>

Parameters

Name Required Type Description
object Required string Use invoicebatch
start Optional integer Start at item, zero-based integer
maxitems Optional integer Max items to return
showprivate Optional boolean Show entity private records if running this at top level. Use either true or false. (Default: false)
filter Optional object Filter(s) to use in list
sorts Optional sortfield[] Field(s) to sort by in response
fields Optional field[] Field(s) to return in response

filter

Name Required Type Description
logical Optional object Logical filter. Required if not using expression.
expression Optional object Expression filter. Required if not using logical.

logical

Name Required Type Description
logical_operator Required string Operator. Use either and or or.
object Optional string Object of operator
Logical Filter/Expression Required (logical | expression)[1...n] Additional logical objects or expressions to filter by

expression

Name Required Type Description
field Required string Field
operator Required string Operator
value Required string Value. Use either =, !=, <, <=, >=, >, like or is null.

sortfield

Name Required Type Description
order Required string Sort by order. Use either asc or desc.

Get Invoice Summary

read

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

Parameters

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

create_invoicebatch

<create_invoicebatch>
    <batchtitle>Invoices for 2017 Week 03</batchtitle>
    <datecreated>
        <year>2017</year>
        <month>01</month>
        <day>20</day>
    </datecreated>
</create_invoicebatch>

Parameters

Name Required Type Description
batchtitle Required string Invoice summary title
datecreated Required object GL posting date

datecreated

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

List AR Adjustment Summaries (Legacy)

get_list

<get_list object="aradjustmentbatch" maxitems="10">
</get_list>

Parameters

Name Required Type Description
object Required string Use aradjustmentbatch
start Optional integer Start at item, zero-based integer
maxitems Optional integer Max items to return
showprivate Optional boolean Show entity private records if running this at top level. Use either true or false. (Default: false)
filter Optional object Filter(s) to use in list
sorts Optional sortfield[] Field(s) to sort by in response
fields Optional field[] Field(s) to return in response

filter

Name Required Type Description
logical Optional object Logical filter. Required if not using expression.
expression Optional object Expression filter. Required if not using logical.

logical

Name Required Type Description
logical_operator Required string Operator. Use either and or or.
object Optional string Object of operator
Logical Filter/Expression Required (logical | expression)[1...n] Additional logical objects or expressions to filter by

expression

Name Required Type Description
field Required string Field
operator Required string Operator
value Required string Value. Use either =, !=, <, <=, >=, >, like or is null.

sortfield

Name Required Type Description
order Required string Sort by order. Use either asc or desc.

Create AR Adjustment Summary (Legacy)

create_aradjustmentbatch

<create_aradjustmentbatch>
    <batchtitle>AR Adjustments for 2017 Week 03</batchtitle>
    <datecreated>
        <year>2017</year>
        <month>01</month>
        <day>20</day>
    </datecreated>
</create_aradjustmentbatch>

Parameters

Name Required Type Description
batchtitle Required string AR adjustment summary title
datecreated Required object GL posting date

datecreated

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

Create AR Payment Summary (Legacy)

create_arpaymentbatch

<create_arpaymentbatch>
    <batchtitle>AR Payments for 2017 Week 03 - CHK-BA1433</batchtitle>
    <bankaccountid>CHK-BA1433</bankaccountid>
    <datecreated>
        <year>2017</year>
        <month>01</month>
        <day>20</day>
    </datecreated>
</create_arpaymentbatch>

Parameters

Name Required Type Description
batchtitle Required string AR payment summary title
bankaccountid Optional string Bank account ID. Required if not using undepfundsacct.
undepfundsacct Optional string Undeposited funds GL account. Required if not using bankaccountid.
datecreated Required object GL posting date

datecreated

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

Provide feedback