The BankFeedAccount object

A Rutter Bank Feed Account represents a Financial Institution account that can have a connection, or a "bank feed", set up with an account within an accounting platform. A feed connection allows Financial Institution bank data to be imported into an accounting system for the account that is connected. This bank data can be used to reconcile transactions in the platform.

Properties

idstring

The Rutter generated unique ID of the bank feed.

account_idstringnullable

The Rutter generated unique ID of the platform account.

internal_bank_account_idstringnullable

The Financial Institution's ID for the bank account.

transaction_start_datestringnullable

The start date of the bank feed connection's synced historical transactions.

bank_account_typeenum

The Financial Institution's bank account type.

One ofbankcredit_cardloansavingspersonalbusinesscorporate, or unknown.
feed_statusenum

The status of the bank feed connection.

One ofactive or in_active.
bank_account_numberstringnullable

The Financial Institution's account number or credit card number.

countrystringnullable

The country of the Financial Institution's bank account.

currency_codeenumnullable

The ISO 4217 currency code of the bank feed.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
namestringnullable

The name of the bank account.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example BankFeedAccount Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "internal_bank_account_id": "0674101002388",
  "transaction_start_date": "2023-02-02T00:00:00.000Z",
  "bank_account_type": "bank",
  "feed_status": "active",
  "bank_account_number": "182237382",
  "country": "USA",
  "currency_code": "USD",
  "name": "Regan's Bank Account",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Bank Feed Accounts

GET /accounting/bank_feeds/accounts
Supported for: Sage Business CloudSage IntacctXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    connectionobject
    Show connection attributes
    bank_feed_accountsarray
    Show bank_feed_accounts attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bank_feed_accounts": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "internal_bank_account_id": "0674101002388",
      "transaction_start_date": "2023-02-02T00:00:00.000Z",
      "bank_account_type": "bank",
      "feed_status": "active",
      "bank_account_number": "182237382",
      "country": "USA",
      "currency_code": "USD",
      "name": "Regan's Bank Account",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Bank Feed Account

GET /accounting/bank_feeds/accounts/:id
Supported for: Sage Business CloudSage IntacctXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    connectionobject
    Show connection attributes
    bank_feed_accountobject
    Show bank_feed_account attributes
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bank_feed_account": {
    "id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "internal_bank_account_id": "0674101002388",
    "transaction_start_date": "2023-02-02T00:00:00.000Z",
    "bank_account_type": "bank",
    "feed_status": "active",
    "bank_account_number": "182237382",
    "country": "USA",
    "currency_code": "USD",
    "name": "Regan's Bank Account",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Create a Bank Feed Account

POST /accounting/bank_feeds/accounts
Supported for: Sage Business CloudSage IntacctXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    bank_feed_accountobject
    Show bank_feed_account attributes

Response Body

    Any of:

    bank_feed_accountobject
    Show bank_feed_account attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "bank_feed_account": {
    "account_id": "00000000-0000-0000-0000-000000000000",
    "internal_bank_account_id": "0674101002388",
    "bank_account_type": "bank",
    "currency_code": "USD",
    "name": "Regan's Bank Account",
    "bank_account_number": "182237382",
    "country": "USA"
  }
}
Example Response Body
{
  "bank_feed_account": {
    "id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "internal_bank_account_id": "0674101002388",
    "transaction_start_date": "2023-02-02T00:00:00.000Z",
    "bank_account_type": "bank",
    "feed_status": "active",
    "bank_account_number": "182237382",
    "country": "USA",
    "currency_code": "USD",
    "name": "Regan's Bank Account",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}