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
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
bank_feed_account
UUIDOptional
The bank feed account associated with the transaction.
transaction_date
DateTime (ISO 8601)Optional
The date that the transaction occurred.
posted_date
DateTime (ISO 8601)Optional
The date the transaction was posted to the bank account.
amount
NumberOptional
The amount of the transaction.
description
StringOptional
The description of the transaction.
transaction_type
StringOptional
The underlying type of the transaction.
payee
StringOptional
The person or merchant who initiated the transaction, or alternatively, to whom the transaction was paid.
credit_or_debit
EnumOptional
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_id
StringOptional
The customer’s identifier for the transaction.
remote_was_deleted
BooleanRequired
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_processed
BooleanRequired
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
Betahttps://api.merge.dev/api/accounting/v1/bank-feed-transactions
US
EU
APAC
Returns a list of BankFeedTransaction
objects.
Query & Path Parameters
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
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_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_data
BooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_processed
BooleanOptional
If provided, will only return bank feed transactions with this is_processed value
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
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.
Query & Path Parameters
is_debug_mode
BooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_async
BooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
model
ObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.bank_feed_account
UUIDThe 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_date
DateTime (ISO 8601)The date that the transaction occurred.
posted_date
DateTime (ISO 8601)The date the transaction was posted to the bank account.
amount
NumberThe amount of the transaction.
description
StringThe description of the transaction.
transaction_type
StringThe underlying type of the transaction.
payee
StringThe person or merchant who initiated the transaction, or alternatively, to whom the transaction was paid.
credit_or_debit
EnumIf the transaction is of type debit or credit. Must pass in one of the following choices:
CREDIT
, DEBIT
.source_transaction_id
StringThe customer’s identifier for the transaction.
integration_params
Objectlinked_account_params
ObjectField support by integration
See all supported fieldsUse 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
amount
NumberOptional
bank_feed_account
UUIDRequired
credit_or_debit
EnumOptional
description
StringOptional
payee
StringOptional
source_transaction_id
StringRequired
transaction_date
DateTime (ISO 8601)Optional
transaction_type
StringOptional
Not seeing an integration that you're looking for? Submit a request for it.
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
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
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
See all supported fieldsUse 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
amount
NumberOptional
bank_feed_account
UUIDRequired
credit_or_debit
EnumOptional
description
StringOptional
payee
StringOptional
source_transaction_id
StringRequired
transaction_date
DateTime (ISO 8601)Optional
transaction_type
StringOptional
Not seeing an integration that you're looking for? Submit a request for it.