{
  "platform_id": "3770712000000811013",
  "account_id": "3770712000000493001",
  "contact_id": "3770712000000080069",
  "currency_id": "3770712000000000099",
  "to_account_id": "3770712000000080063",
  "transaction_date": "2022-02-17T00:00:00.000Z",
  "amount": 1234.0,
  "type": "Sales Return",
  "status": "Manually Added",
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 1.0,
      "updated_at": "2022-02-17T00:00:00.000Z"
    }
  },
  "currency_rate": 80.0,
  "line_items": null,
  "account": {
    "data": {
      "platform_id": "3770712000000493001",
      "institution_name": "Test RootFi Account",
      "account_name": "DDDSF Bank Account",
      "account_number": "XXXX4397",
      "category": "Bank",
      "balance": 7360.0,
      "currency_id": "3770712000000000099",
      "currency": {
        "data": {
          "platform_id": "3770712000000000099",
          "name": "Indian Rupee",
          "code": "INR",
          "symbol": "₹",
          "is_base_currency": true,
          "exchange_rate": 1.0,
          "updated_at": "2022-02-17T00:00:00.000Z"
        }
      },
      "updated_at": "2022-02-17T00:00:00.000Z"
    }
  },
  "contact": {
    "data": {
      "platform_id": "3770712000000080069",
      "name": "Mr. John Doe",
      "contact_name": "John Doe",
      "contact_type": "Customer",
      "currency_id": "3770712000000000099",
      "currency": {
        "data": {
          "platform_id": "3770712000000000099",
          "name": "Indian Rupee",
          "code": "INR",
          "symbol": "₹",
          "is_base_currency": true,
          "exchange_rate": 1.0,
          "updated_at": "2022-02-17T00:00:00.000Z"
        }
      },
      "tax_number": null,
      "registration_number": null,
      "status": "Archived",
      "updated_at": "2023-10-12T00:00:00.000Z"
    }
  },
  "updated_at": "2022-02-17T00:00:00.000Z"
}

The Bank Transactions Data Model simplifies the management and retrieval of transaction information across different accounting platforms.

  • Unified transaction properties: The model consolidates essential transaction details such as transaction date, amount, type, and status, making it easier to work with transaction data from various platforms.
  • Linked account and customer data: Transactions are associated with specific accounts and customers through the account_id and customer_id properties, facilitating easier tracking and reporting.
  • Currency support and exchange rates: The data model includes the transaction currency and exchange rate, enabling accurate representation of multi-currency transactions and conversions.

​
Attributes

​
platform_id
string
required

The Platform’s ID for the transaction

​
account_id
string

Platform ID for the account to which this transaction belongs

​
contact_id
string

The platform’s ID for the contact to that made the transaction

​
currency_id
string

The ISO-4217 currency code of the transaction

​
to_account_id
string

The platform’s ID for the account to which the transaction was made

​
transaction_date
date

Date of the transaction

​
amount
float

The total transaction amount

​
type
string

The type of the transaction

​
status
string

The status of the transaction

​
currency
Object

The currency data associated with the bank transaction.

​
currency_rate
float

Rate between the currency of the payment and the base currency

​
line_items
Line Item

Array of Transaction Line items associated with this transaction

​
account
Account

The account to which this transaction belongs

​
contact
Contact

The contact to that made the transaction

​
updated_at
date
required

The date at which the transaction was updated on the accounting platform

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the transaction
account_idstringPlatform ID for the account to which this transaction belongs
contact_idstringThe platform’s ID for the contact to that made the transaction
transaction_datedateDate of the transaction
amountfloatThe total transaction amount
typestringThe type of the transaction
statusstringThe status of the transaction
currencystringThe ISO-4217 currency code of the transaction
currency_ratefloatRate between the currency of the payment and the base currency
line_itemsLine ItemArray of Transaction Line items associated with this transaction
accountAccountThe account to which this transaction belongs
contactContactThe contact to that made the transaction
updated_atdateThe date at which the transaction was updated on the accounting platform
{
  "platform_id": "3770712000000811013",
  "account_id": "3770712000000493001",
  "contact_id": "3770712000000080069",
  "currency_id": "3770712000000000099",
  "to_account_id": "3770712000000080063",
  "transaction_date": "2022-02-17T00:00:00.000Z",
  "amount": 1234.0,
  "type": "Sales Return",
  "status": "Manually Added",
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 1.0,
      "updated_at": "2022-02-17T00:00:00.000Z"
    }
  },
  "currency_rate": 80.0,
  "line_items": null,
  "account": {
    "data": {
      "platform_id": "3770712000000493001",
      "institution_name": "Test RootFi Account",
      "account_name": "DDDSF Bank Account",
      "account_number": "XXXX4397",
      "category": "Bank",
      "balance": 7360.0,
      "currency_id": "3770712000000000099",
      "currency": {
        "data": {
          "platform_id": "3770712000000000099",
          "name": "Indian Rupee",
          "code": "INR",
          "symbol": "₹",
          "is_base_currency": true,
          "exchange_rate": 1.0,
          "updated_at": "2022-02-17T00:00:00.000Z"
        }
      },
      "updated_at": "2022-02-17T00:00:00.000Z"
    }
  },
  "contact": {
    "data": {
      "platform_id": "3770712000000080069",
      "name": "Mr. John Doe",
      "contact_name": "John Doe",
      "contact_type": "Customer",
      "currency_id": "3770712000000000099",
      "currency": {
        "data": {
          "platform_id": "3770712000000000099",
          "name": "Indian Rupee",
          "code": "INR",
          "symbol": "₹",
          "is_base_currency": true,
          "exchange_rate": 1.0,
          "updated_at": "2022-02-17T00:00:00.000Z"
        }
      },
      "tax_number": null,
      "registration_number": null,
      "status": "Archived",
      "updated_at": "2023-10-12T00:00:00.000Z"
    }
  },
  "updated_at": "2022-02-17T00:00:00.000Z"
}