The BankTransfer object

Currently, there's only support between accounts of the same currency.

Properties

idstring

The Rutter generated unique ID of the bank transfer.

platform_idstring

The platform specific ID of the bank transfer.

class_idstringnullable

The Rutter ID of the Class linked to the bank transfer line item.

credit_account_idstringnullable

The Rutter ID of the Account linked to the bank transfer. Represents the asset account being credited.

debit_account_idstringnullable

The Rutter ID of the Account linked to the bank transfer. Represents the asset account being debit.

department_idstringnullable

The Rutter ID of the Department linked to the bank transfer line item.

location_idstringnullable

The Rutter ID of the Location linked to the bank transfer line item.

subsidiary_idstringnullable

The Rutter ID of the Subsidiary linked to the bank transfer. This feature is currently only supported on NetSuite.

transaction_datestring

The ISO 8601 timestamp for the transaction date of the bank transfer.

currency_codeenum

The ISO 4217 currency code of the bank transfer.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
total_amountnumber

The total amount on the bank transfer.

memostringnullable

Memo or description of the bank transfer

created_atstringnullable

The ISO 8601 timestamp that the bank transfer was created.

updated_atstringnullable

The ISO 8601 timestamp that the bank transfer was last updated.

last_synced_atstring

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

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example BankTransfer Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "class_id": "00000000-0000-0000-0000-000000000000",
  "credit_account_id": "00000000-0000-0000-0000-000000000000",
  "debit_account_id": "00000000-0000-0000-0000-000000000000",
  "department_id": "00000000-0000-0000-0000-000000000000",
  "location_id": "00000000-0000-0000-0000-000000000000",
  "subsidiary_id": "00000000-0000-0000-0000-000000000000",
  "transaction_date": "2023-01-02T02:34:56.000Z",
  "currency_code": "USD",
  "total_amount": 123.45,
  "memo": "This is a memo.",
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "last_synced_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Bank Transfers

GET /versioned/accounting/bank_transfers
Supported for: NetSuiteQuickBooksXero

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.
    last_synced_at_minintegeroptionalquery

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

    limitintegeroptionalquery

    The limit on the number of entities returned.

    sortstringoptionalquery

    The field and direction to sort by (ASC or DESC), e.g. last_synced_at ASC. Currently supports the fields: updated_at, last_synced_at. If a field is provided but ASC or DESC is not, defaults to ASC. If this field is omitted, defaults, to updated_at DESC.

    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_transfersarray
    Show bank_transfers attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bank_transfers": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "class_id": "00000000-0000-0000-0000-000000000000",
      "credit_account_id": "00000000-0000-0000-0000-000000000000",
      "debit_account_id": "00000000-0000-0000-0000-000000000000",
      "department_id": "00000000-0000-0000-0000-000000000000",
      "location_id": "00000000-0000-0000-0000-000000000000",
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",
      "transaction_date": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "total_amount": 123.45,
      "memo": "This is a memo.",
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "last_synced_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Bank Transfer

GET /versioned/accounting/bank_transfers/:id
Supported for: NetSuiteQuickBooksXero

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.
    id_typeenumoptionalquery

    Optionally, search for a connection by Rutter ID or platform ID. Defaults to rutter. Not supported on Quickbooks Desktop or Dynamics 365.

    One ofrutter or platform.

Response Body

    connectionobject
    Show connection attributes
    bank_transferobject
    Show bank_transfer attributes
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bank_transfer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "class_id": "00000000-0000-0000-0000-000000000000",
    "credit_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "department_id": "00000000-0000-0000-0000-000000000000",
    "location_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "total_amount": 123.45,
    "memo": "This is a memo.",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "last_synced_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Create a Bank Transfer

POST /versioned/accounting/bank_transfers
Supported for: QuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    bank_transferobject
    Show bank_transfer attributes

Response Body

    Any of:

    bank_transferobject
    Show bank_transfer attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "bank_transfer": {
    "class_id": "00000000-0000-0000-0000-000000000000",
    "credit_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "department_id": "00000000-0000-0000-0000-000000000000",
    "location_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "total_amount": 123.45,
    "memo": "This is a memo."
  }
}
Example Response Body
{
  "bank_transfer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "class_id": "00000000-0000-0000-0000-000000000000",
    "credit_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "department_id": "00000000-0000-0000-0000-000000000000",
    "location_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "total_amount": 123.45,
    "memo": "This is a memo.",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "last_synced_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Update a Bank Transfer

PATCH /versioned/accounting/bank_transfers/:id
Supported for: QuickBooks

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    bank_transferobject
    Show bank_transfer attributes

Response Body

    Any of:

    bank_transferobject
    Show bank_transfer attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "bank_transfer": {
    "credit_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "total_amount": 123.45,
    "memo": "This is a memo."
  }
}
Example Response Body
{
  "bank_transfer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "class_id": "00000000-0000-0000-0000-000000000000",
    "credit_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "department_id": "00000000-0000-0000-0000-000000000000",
    "location_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "total_amount": 123.45,
    "memo": "This is a memo.",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "last_synced_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}