Provides the relevant information for a bank account.


List Checking Accounts

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CHECKINGACCOUNT
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 Checking Account

read

<read>
    <object>CHECKINGACCOUNT</object>
    <keys>40</keys>
    <fields>*</fields>
</read>

Parameters

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

Get Checking Account by Name

readByName

<readByName>
    <object>CHECKINGACCOUNT</object>
    <keys>BOFA-1234</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use CHECKINGACCOUNT
keys Required string The account BANKACCOUNTID 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.

Reconcile Checking Account

reconcile_bank

<reconcile_bank>
    <bankaccountid>BOFACHECK-0827</bankaccountid>
    <cutoffdate>
        <year>2013</year>
        <month>06</month>
        <day>30</day>
    </cutoffdate>
    <statementendingdate>
        <year>2013</year>
        <month>07</month>
        <day>31</day>
    </statementendingdate>
    <reconmode>AutomatchReview</reconmode>
    <statementendingbalance>1000</statementendingbalance>
    <banktxns>
        <banktxn>
            <postingdate>
                <year>2013</year>
                <month>07</month>
                <day>15</day>
            </postingdate>
            <txntype></txntype>
            <doctype></doctype>
            <document>1234</document>
            <payee>Payee</payee>
            <amount>10.99</amount>
            <description>description</description>
        </banktxn>
    </banktxns>
</reconcile_bank>

Parameters

Name Required Type Description
bankaccountid Required string The account BANKACCOUNTID to reconcile
cutoffdate Optional object Beginning balance cut off date
statementendingdate Required object Statement ending date
reconmode Required string Reconciliation mode. Use Automatch or AutomatchReview. Default depends on mode set on checking account. If Automatch, then the entire reconciliation must clear otherwise you will get an error. Recommended to use Automatch with review. When user reviewing in UI, they must check the “Use previous uploaded file” to see this.
statementendingbalance Required currency Statement ending balance
banktxns Required banktxn[] Bank statement transactions to reconcile with

cutoffdate

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

banktxn

Name Required Type Description
postingdate Required object Posting date
txntype Required string Transaction type. Use withdrawal or deposit. If blank, the system will determine this based on the Amount being positive or negative.
doctype Required string Document type. Use check, card, ach, or leave blank.
document Required string Document number, like the check number or electronic transaction ID.
payee Required string(80) Name of payee
amount Required currency Amount. Must be non-zero.
description Optional string(80) Memo

postingdate

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

Provide feedback