Provides the relevant information for a savings account, such as the account ID, account number, associated GL account, and so forth.


List Savings Accounts

readByQuery

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

Parameters

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

read

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

Parameters

Name Required Type Description
object Required string Use SAVINGSACCOUNT
keys Required string 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 Savings Account by Name

readByName

<readByName>
    <object>SAVINGSACCOUNT</object>
    <keys>SBB</keys>
    <fields>*</fields>
</readByName>

Parameters

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

Create Savings Account (Legacy)

create_savingsaccount

<create_savingsaccount>
    <bankaccountid>SBB</bankaccountid>
    <bankaccountno>100-768</bankaccountno>
    <bankname>Savings Bank of Braunville</bankname>
    <currency>USD</currency>
</create_savingsaccount>

Parameters

Name Required Type Description
bankaccountid Required string Bank account ID
bankaccountno Optional string Bank account number
locationid Optional string Location ID. Required if multi-entity enabled.
bankname Required string Bank name
routingno Optional string Routing number
branchid Optional string Branch ID
phone Optional string Bank phone number
currency Optional string Currency code if multi-currency is enabled.
mailaddress Optional object Mail address
status Optional string Status. Use active for Active or inactive for Inactive. (Default: active)
disableiet Optional boolean Disable inter-entity transfers. Use true to disable transfers, false to enable. (Default: false)
financialdata Optional object Default financial settings
glaccountno Optional string GL account number
servicechargeglaccount Optional string GL account for service charges. Do not provide if using servicechargeaccountlabel.
servicechargeaccountlabel Optional string GL account label for service charges. Do not provide if using servicechargeglaccount.
interestearnedglaccount Optional string GL account for earned interest. Do not provide if using interestearnedaccountlabel.
interestearnedaccountlabel Optional string GL account label for earned interest. Do not provide if using interestearnedglaccount.
departmentid Optional string Department ID
visibility Optional object Restrictions

mailaddress

Name Required Type Description
address1 Optional string Address line 1
address2 Optional string Address line 2
city Optional string City
state Optional string State/province
zip Optional string Zip/postal code
country Optional string Country
isocountrycode Optional string ISO country code
latitude Optional string Latitude
longitude Optional string Longitude

financialdata

Name Required Type Description
reconmode Optional string Reconciliation mode. Use Manual, Automatch or AutomatchReview. (Default is Manual)
apjournal Optional string Default Accounts Payable journal
arjournal Optional string Default Accounts Receivable journal

visibility

visibility_type Required string Restriction type. Use Unrestricted, RootOnly, or Restricted.
restricted_locs Optional locationid[0...n] Restricted location ID’s
restricted_depts Optional departmentid[0...n] Restricted department ID’s

Update Savings Account (Legacy)

update_savingsaccount

<update_savingsaccount bankaccountid="SBB">
    <phone>1(408)123-1234</phone>
</update_savingsaccount>

Parameters

Name Required Type Description
bankaccountid Required string Bank account ID to update
bankaccountno Optional string Bank account number
locationid Optional string Location ID. Required if multi-entity enabled.
bankname Optional string Bank name
routingno Optional string Routing number
branchid Optional string Branch ID
phone Optional string Bank phone number
currency Optional string Currency code if multi-currency is enabled.
mailaddress Optional object Mail address
status Optional string Status. Use active for Active or inactive for Inactive. (Default: active)
disableiet Optional boolean Disable inter-entity transfers. Use true to disable transfers, false to enable. (Default: false)
financialdata Optional object Default journal settings
glaccountno Optional string GL account number
servicechargeglaccount Optional string GL account for service charges. Do not provide if using servicechargeaccountlabel.
servicechargeaccountlabel Optional string GL account label for service charges. Do not provide if using servicechargeglaccount.
interestearnedglaccount Optional string GL account for earned interest. Do not provide if using interestearnedaccountlabel.
interestearnedaccountlabel Optional string GL account label for earned interest. Do not provide if using interestearnedglaccount.
departmentid Optional string Department ID
visibility Optional object Restrictions

mailaddress

Name Required Type Description
address1 Optional string Address line 1
address2 Optional string Address line 2
city Optional string City
state Optional string State/province
zip Optional string Zip/postal code
country Optional string Country
isocountrycode Optional string ISO country code
latitude Optional string Latitude
longitude Optional string Longitude

financialdata

Name Required Type Description
reconmode Optional string Reconciliation mode. Use Manual, Automatch or AutomatchReview. (Default is Manual)
apjournal Optional string Default Accounts Payable journal
arjournal Optional string Default Accounts Receivable journal

visibility

visibility_type Required string Restriction type. Use Unrestricted, RootOnly, or Restricted.
restricted_locs Optional locationid[0...n] Restricted location ID’s
restricted_depts Optional departmentid[0...n] Restricted department ID’s

Delete Savings Account (Legacy)

delete_savingsaccount

<delete_savingsaccount bankaccountid="SBB"></delete_savingsaccount>

Parameters

Name Required Type Description
key Required string Savings bank account ID to delete

Reconcile Savings Account

reconcile_bank

<reconcile_bank>
    <bankaccountid>SBB</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 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[1...n] 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