Bank Feed Transactions
The BankFeedTransaction object is used to represent transactions linked to a bank feed account. This includes details about the transaction such as the date, amount, description, and type.
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
bank_feed_accountUUID
The bank feed account associated with the transaction.
transaction_dateDateTime (ISO 8601)
The date that the transaction occurred.
posted_dateDateTime (ISO 8601)
The date the transaction was posted to the bank account.
amountNumber
The amount of the transaction.
descriptionString
The description of the transaction.
transaction_typeString
The underlying type of the transaction.
payeeString
The person or merchant who initiated the transaction, or alternatively, to whom the transaction was paid.
credit_or_debitEnum
If the transaction is of type debit or credit. Possible values include: CREDIT, DEBIT. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
source_transaction_idString
The customer’s identifier for the transaction.
remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
is_processedBoolean
Whether or not this transaction has been processed by the external system. For example, NetSuite writes this field as True when the SuiteApp has processed the transaction.
GET
/bank-feed-transactions
Beta

https://api.merge.dev/api/accounting/v1/bank-feed-transactions

US
EU
APAC

Returns a list of BankFeedTransaction objects.


Query & path parameters
created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_processedBoolean
Optional
If provided, will only return bank feed transactions with this is_processed value
modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
remote_idString
Optional
The API provider's ID for the given object.
POST
/bank-feed-transactions
Beta

https://api.merge.dev/api/accounting/v1/bank-feed-transactions

US
EU
APAC

Creates a BankFeedTransaction object with the given values. To run asynchronously, see our guide.


Query & path parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.
bank_feed_accountUUID
The bank feed account associated with the transaction. Must pass in a valid Merge ID, which can be obtained from the id field in the BankFeedAccount object.
transaction_dateDateTime (ISO 8601)
The date that the transaction occurred.
posted_dateDateTime (ISO 8601)
The date the transaction was posted to the bank account.
amountNumber
The amount of the transaction.
descriptionString
The description of the transaction.
transaction_typeString
The underlying type of the transaction.
payeeString
The person or merchant who initiated the transaction, or alternatively, to whom the transaction was paid.
credit_or_debitEnum
If the transaction is of type debit or credit. Must pass in one of the following choices: CREDIT, DEBIT.
source_transaction_idString
The customer’s identifier for the transaction.
integration_paramsObject
linked_account_paramsObject
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Xero
Xero
Not seeing an integration that you're looking for?
To include the correct model fields when making POST requests, use the GET /bank-feed-transactions/meta/post endpoint. Learn more in our /meta guide.
GET
/bank-feed-transactions/{id}
Beta

https://api.merge.dev/api/accounting/v1/bank-feed-transactions/{id}

US
EU
APAC

Returns a BankFeedTransaction object with the given id.


Query & path parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
GET
/bank-feed-transactions/batch/{batch_id}/objects
Beta

https://api.merge.dev/api/accounting/v1/bank-feed-transactions/batch/{batch_id}/objects

US
EU
APAC

Returns a list of BankFeedTransaction objects.


Query & path parameters
batch_idUUID
Required
created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_processedBoolean
Optional
If provided, will only return bank feed transactions with this is_processed value
modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
remote_idString
Optional
The API provider's ID for the given object.
GET
/bank-feed-transactions/meta/post
Beta

https://api.merge.dev/api/accounting/v1/bank-feed-transactions/meta/post

US
EU
APAC

Returns metadata for BankFeedTransaction POSTs.


Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
QuickBooks Online
QuickBooks Online
Xero
Xero
Not seeing an integration that you're looking for?
Previous
Bank Feed Accounts
Next Up
Cash Flow Statements