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
idUUIDremote_idStringThe 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_accountUUIDThe 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.
amountNumberThe amount of the transaction.
descriptionStringThe description of the transaction.
transaction_typeStringThe underlying type of the transaction.
payeeStringThe person or merchant who initiated the transaction, or alternatively, to whom the transaction was paid.
credit_or_debitEnumIf 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_idStringThe customer’s identifier for the transaction.
remote_was_deletedBooleanIndicates 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_processedBooleanWhether 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
Betahttps://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.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
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_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_processedBooleanOptional
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_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
remote_idStringOptional
The API provider's ID for the given object.
POST
/bank-feed-transactions
Betahttps://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_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.bank_feed_accountUUIDThe 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.
amountNumberThe amount of the transaction.
descriptionStringThe description of the transaction.
transaction_typeStringThe underlying type of the transaction.
payeeStringThe person or merchant who initiated the transaction, or alternatively, to whom the transaction was paid.
credit_or_debitEnumIf the transaction is of type debit or credit. Must pass in one of the following choices:
CREDIT, DEBIT.source_transaction_idStringThe customer’s identifier for the transaction.
integration_paramsObjectlinked_account_paramsObjectField support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
amountNumberOptional
bank_feed_accountUUIDRequired
credit_or_debitEnumOptional
descriptionStringOptional
payeeStringOptional
source_transaction_idStringRequired
transaction_dateDateTime (ISO 8601)Optional
transaction_typeStringOptional
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
amountNumberRequired
bank_feed_accountUUIDRequired
credit_or_debitEnumRequired
descriptionStringRequired
payeeStringOptional
posted_dateDateTime (ISO 8601)Required
remote_idStringOptional
source_transaction_idStringRequired
transaction_dateDateTime (ISO 8601)Optional
transaction_typeStringOptional
Additional POST Parameters
integration_paramsObjectRequired
end_balanceStringRequired
end_balance_amountStringRequired
end_balance_credit_or_debitStringRequired
end_balance_is_debitStringRequired
end_dateStringRequired
start_balanceStringRequired
start_balance_amountStringRequired
start_balance_credit_or_debitStringRequired
start_balance_is_debitStringRequired
start_dateStringRequired
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}
Betahttps://api.merge.dev/api/accounting/v1/bank-feed-transactions/{id}
US
EU
APAC
Returns a BankFeedTransaction object with the given id.
Query & path parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
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/meta/post
Betahttps://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
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
amountNumberOptional
bank_feed_accountUUIDRequired
credit_or_debitEnumOptional
descriptionStringOptional
payeeStringOptional
source_transaction_idStringRequired
transaction_dateDateTime (ISO 8601)Optional
transaction_typeStringOptional
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
amountNumberRequired
bank_feed_accountUUIDRequired
credit_or_debitEnumRequired
descriptionStringRequired
payeeStringOptional
posted_dateDateTime (ISO 8601)Required
remote_idStringOptional
source_transaction_idStringRequired
transaction_dateDateTime (ISO 8601)Optional
transaction_typeStringOptional
Additional POST Parameters
integration_paramsObjectRequired
end_balanceStringRequired
end_balance_amountStringRequired
end_balance_credit_or_debitStringRequired
end_balance_is_debitStringRequired
end_dateStringRequired
start_balanceStringRequired
start_balance_amountStringRequired
start_balance_credit_or_debitStringRequired
start_balance_is_debitStringRequired
start_dateStringRequired
Not seeing an integration that you're looking for?