Transaction record for a deposit.


List Deposits

readByQuery

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

Parameters

Name Required Type Description
object Required string Use DEPOSIT
fields Required string Comma separated list of fields on the object to list. Use * to return all fields.
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 Set a custom page size between 1 and 1000 items (Default: 100)

Get Deposit

read

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

Parameters

Name Required Type Description
object Required string Use DEPOSIT
keys Required string The object RECORDNO to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Create Deposit (Legacy)

record_deposit

<record_deposit>
    <bankaccountid>BA1145</bankaccountid>
    <depositdate>
        <year>2015</year>
        <month>06</month>
        <day>30</day>
    </depositdate>
    <depositid>Deposit Slip 2015-06-30</depositid>
    <receiptkeys>
        <receiptkey>1234</receiptkey>
    </receiptkeys>
    <description>Desc</description>
    <supdocid>AT111</supdocid>
    <customfields>
        <customfield>
            <customfieldname>customfield1</customfieldname>
            <customfieldvalue>customvalue1</customfieldvalue>
        </customfield>
    </customfields>
</record_deposit>

Parameters

Name Required Type Description
bankaccountid Required string Bank account ID
depositdate Required object Deposit date
depositid Required string Deposit slip ID
receiptkeys Required receiptkey[] Record numbers of undeposited AR payments/other receipts you want to deposit
description Optional string Description
supdocid Optional string Attachments ID
customfields Optional object Custom fields

depositdate

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

List Deposit Lines

readByQuery

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

Parameters

Name Required Type Description
object Required string Use DEPOSITENTRY
fields Required string Comma separated list of fields on the object to list. Use * to return all fields.
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 Set a custom page size between 1 and 1000 items (Default: 100)

Get Deposit Line

read

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

Parameters

Name Required Type Description
object Required string Use DEPOSITENTRY
keys Required string The object RECORDNO to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Provide feedback