Bank Feed Transactions

The BankFeedTransaction Object

A Rutter Bank Feed Transaction represents a bank transaction from a Financial Institution account that has been uploaded into an accounting platform for a specific Rutter Bank Feed Account. The bank transactions synced into an accounting platform enable reconciliation for an accountant.

Properties

idstring

The Rutter generated unique ID of the bank feed transaction.

bank_feed_account_idstringnullable

The Rutter generated unique ID of the linked bank feed.

transaction_idstringnullable

The Financial Institution's ID for the transaction.

posted_atstringnullable

When the transaction was posted by the Financial Institution.

transaction_datestringnullable

When the transaction took place.

amountnumbernullable

The amount of the transaction.

debit_credit_memoenumnullable

DEBIT or CREDIT.

One ofCREDIT, DEBIT, or null.
descriptionstringnullable

The description of the transaction.

interest_amountnumbernullable

The amount of payment applied to interest

memostringnullable

The memo of the transaction. Supported for Intuit only.

payeestringnullable

The payee of the transaction. Not yet supported for Intuit.

platform_ingestedbooleannullable

Indicates whether the transaction has been ingested by the platform.

principal_amountnumbernullable

The amount of payment applied to principal

transaction_typeenumnullable

The type of the transaction.

One ofcredit, debit, fee, deposit, transfer, payment, interest, unknown, or null.
last_synced_atstring

The ISO 8601 timestamp when the bank feed transaction was last synced by Rutter.

Endpoints
GET
/accounting/bank_feeds/transactions
GET
/accounting/bank_feeds/transactions/:id
POST
/accounting/bank_feeds/transactions

List Bank Feed Transactions

GEThttps://production.rutterapi.com/versioned/accounting/bank_feeds/transactions

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

    Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.

    Filterable fields: bank_feed_account_id, last_synced_at.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

    Sortable fields: bank_feed_account_id, last_synced_at.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "bank_feed_transactions": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "bank_feed_account_id": "00000000-0000-0000-0000-000000000000",


6
      "transaction_id": "ACRAF23DB3C4",


7
      "posted_at": "2023-02-02T02:34:56.000Z",


8
      "transaction_date": "2023-02-02T02:34:56.000Z",


9
      "amount": -300,


10
      "debit_credit_memo": "DEBIT",


11
      "description": "Office supplies",


12
      "interest_amount": -10,


13
      "memo": "Printer",


14
      "payee": "Office Depot",


15
      "platform_ingested": true,


16
      "principal_amount": 100,


17
      "transaction_type": "debit",


18
      "last_synced_at": "2023-01-02T02:34:56.000Z"


19
    }


20
  ],


21
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


22
  "connection": {


23
    "id": "00000000-0000-0000-0000-000000000000",


24
    "orgId": "00000000-0000-0000-0000-000000000000",


25
    "platform": "NETSUITE"


26
  }


27
}

Fetch a Bank Feed Transaction

GEThttps://production.rutterapi.com/versioned/accounting/bank_feeds/transactions/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "bank_feed_transaction": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "bank_feed_account_id": "00000000-0000-0000-0000-000000000000",


5
    "transaction_id": "ACRAF23DB3C4",


6
    "posted_at": "2023-02-02T02:34:56.000Z",


7
    "transaction_date": "2023-02-02T02:34:56.000Z",


8
    "amount": -300,


9
    "debit_credit_memo": "DEBIT",


10
    "description": "Office supplies",


11
    "interest_amount": -10,


12
    "memo": "Printer",


13
    "payee": "Office Depot",


14
    "platform_ingested": true,


15
    "principal_amount": 100,


16
    "transaction_type": "debit",


17
    "last_synced_at": "2023-01-02T02:34:56.000Z"


18
  },


19
  "connection": {


20
    "id": "00000000-0000-0000-0000-000000000000",


21
    "orgId": "00000000-0000-0000-0000-000000000000",


22
    "platform": "NETSUITE"


23
  }


24
}

Create Bank Feed Transactions

POSThttps://production.rutterapi.com/versioned/accounting/bank_feeds/transactions

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    bank_feed_transactionsobject
    Show bank_feed_transactions attributes

Response Body

Example Request Body
JSON
1
{


2
  "bank_feed_transactions": {


3
    "bank_feed_account_id": "00000000-0000-0000-0000-000000000000",


4
    "current_balance": 1234.56,


5
    "transactions": [


6
      {


7
        "transaction_id": "ACRAF23DB3C4",


8
        "posted_at": "2023-02-02T02:34:56.000Z",


9
        "transaction_date": "2023-02-02T02:34:56.000Z",


10
        "amount": -300,


11
        "description": "Office supplies",


12
        "transaction_type": "debit",


13
        "debit_credit_memo": "DEBIT",


14
        "memo": "Printer",


15
        "payee": "Office Depot"


16
      }


17
    ]


18
  }


19
}
200
Example Response Body
JSON
1
{


2
  "bank_feed_transactions": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "bank_feed_account_id": "00000000-0000-0000-0000-000000000000",


6
      "transaction_id": "ACRAF23DB3C4",


7
      "posted_at": "2023-02-02T02:34:56.000Z",


8
      "transaction_date": "2023-02-02T02:34:56.000Z",


9
      "amount": -300,


10
      "debit_credit_memo": "DEBIT",


11
      "description": "Office supplies",


12
      "duplicate": false,


13
      "interest_amount": -10,


14
      "memo": "Printer",


15
      "payee": "Office Depot",


16
      "platform_ingested": true,


17
      "principal_amount": 100,


18
      "transaction_type": "debit",


19
      "last_synced_at": "2023-01-02T02:34:56.000Z"


20
    }


21
  ]


22
}

Have questions?

Contact support for personalized guidance.

Contact support