Bank Feeds
- Get Bank Feed Object Definition
- List Bank Feeds
- List Bank Feeds (Legacy)
- Get Bank Feed
- Create Bank Feed
- Delete Bank Feed
With bank feeds, you can access transaction records for bank reconciliation directly using Sage Cloud Services, or you can provide your own transaction records as XML elements.
Bank feeds are currently supported for checking account reconciliation.
When you create a bank feed, the bank transactions become available for matching against existing transactions during reconciliation.
Note: In the UI, transactions available for matching are found under Cash Management > All > Reconciliation > Bank.
Get Bank Feed Object Definition
lookup
List all the fields and relationships for the bank feed object:
<lookup>
<object>BANKACCTTXNFEED</object>
</lookup>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BANKACCTTXNFEED |
docparid | Optional | string | Used to indicate the document type, such as Inventory Transfer , Sales Order , Purchase Order and so forth . You must use this to take advantage of any custom fields on the specified document type. |
List Bank Feeds
query
List the record number and bank account ID for each bank feed for the given date:
<query>
<object>BANKACCTTXNFEED</object>
<select>
<field>RECORDNO</field>
<field>FINANCIALENTITY</field>
</select>
<filter>
<equalto>
<field>FEEDDATE</field>
<value>01-27-2020</value>
</equalto>
</filter>
</query>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BANKACCTTXNFEED |
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 ) |
docparid | Optional | string | Document type, such as Sales Order , Purchase Order , or Inventory Transfer |
List Bank Feeds (Legacy)
readByQuery
<readByQuery>
<object>BANKACCTTXNFEED</object>
<fields>*</fields>
<query/>
<pagesize>100</pagesize>
</readByQuery>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BANKACCTTXNFEED |
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 ) |
Get Bank Feed
read
<read>
<object>BANKACCTTXNFEED</object>
<keys>91</keys>
<fields>*</fields>
</read>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BANKACCTTXNFEED |
keys | Required | string | Bank feed 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 Bank Feed
You create a bank feed using one of the following approaches:
- Set the feed type to
onl
to fetch transactions from a bank subscribed to Sage Cloud Services. - Set the feed type to
xml
and provide XML bank transactions directly in the create call.
create
Create a bank feed by providing transactions as XML elements:
<create>
<BANKACCTTXNFEED>
<FINANCIALENTITY>BOV</FINANCIALENTITY>
<FEEDDATE>05/15/2020</FEEDDATE>
<FEEDTYPE>xml</FEEDTYPE>
<BANKACCTTXNRECORDS>
<BANKACCTTXNRECORD>
<POSTINGDATE>04/09/2020</POSTINGDATE>
<TRANSACTIONTYPE>withdrawal</TRANSACTIONTYPE>
<DOCTYPE>Check</DOCTYPE>
<DOCNO>198</DOCNO>
<AMOUNT>-184.00</AMOUNT>
<DESCRIPTION>Office supplies</DESCRIPTION>
</BANKACCTTXNRECORD>
<BANKACCTTXNRECORD>
<POSTINGDATE>04/09/2020</POSTINGDATE>
<TRANSACTIONTYPE>withdrawal</TRANSACTIONTYPE>
<DOCTYPE>Check</DOCTYPE>
<DOCNO>222</DOCNO>
<AMOUNT>-211.14</AMOUNT>
<DESCRIPTION>Computer service call</DESCRIPTION>
</BANKACCTTXNRECORD>
<BANKACCTTXNRECORD>
<POSTINGDATE>04/17/2020</POSTINGDATE>
<TRANSACTIONTYPE>deposit</TRANSACTIONTYPE>
<DOCTYPE>Check</DOCTYPE>
<DOCNO>220</DOCNO>
<AMOUNT>2000.00</AMOUNT>
<DESCRIPTION>From account CH to account BOV</DESCRIPTION>
</BANKACCTTXNRECORD>
</BANKACCTTXNRECORDS>
</BANKACCTTXNFEED>
</create>
Create a bank feed by fetching transactions from the Sage Intacct banking cloud:
<create>
<BANKACCTTXNFEED>
<FINANCIALENTITY>BOA</FINANCIALENTITY>
<FEEDDATE>05/15/2020</FEEDDATE>
<FEEDTYPE>onl</FEEDTYPE>
</BANKACCTTXNFEED>
</create>
Parameters
Name | Required | Type | Description |
---|---|---|---|
BANKACCTTXNFEED | Required | object | Object to create |
BANKACCTTXNFEED
Name | Required | Type | Description |
---|---|---|---|
FINANCIALENTITY | Required | string | Bank account ID |
FEEDDATE | Required | Date | Feed date in format mm/dd/yyyy |
FEEDTYPE | Required | string | Feed type to create. Use xml to provide the transactions in XML format, or use onl to use online bank feeds through Sage Cloud Services. |
FILENAME | Optional | string | File name that displays in the UI when using automatch with review (AutomatchReview ) as the reconciliation mode. |
BANKACCTTXNRECORDS | Optional | BANKACCTTXNRECORD[1..n] |
Bank account transaction records. Required only if the feed type is xml . |
BANKACCTTXNRECORD
Name | Required | Type | Description |
---|---|---|---|
TRANSACTIONID | Optional | integer | Transaction ID of the bank feed transaction. This is available only for banking cloud transactions. |
POSTINGDATE | Optional | date | Transaction posting date in format mm/dd/yyyy |
TRANSACTIONTYPE | Required | string | Transaction type. Use withdrawal or deposit . |
DOCTYPE | Optional | string | Document type |
DOCNO | Optional | string | Document number |
PAYEE | Optional | string | Payee |
AMOUNT | Required | currency | Transaction amount. For a withdrawal, use a negative number. |
DESCRIPTION | Optional | string | Description |
CURRENCY | Optional | string | Currency |
Delete Bank Feed
You can delete a bank feed object created with a feed type of xml
if the transactions have not yet been reconciled. You cannot delete an online bank feed from Sage Cloud Services.
<delete>
<object>BANKACCTTXNFEED</object>
<keys>91</keys>
</delete>
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use BANKACCTTXNFEED |
keys | Required | string | Record number of the xml bank feed |