Bankfeedtransaction data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | creation timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | last-update timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
organization_id | string | No | ref -> accounting Organization this record belongs to |
bankfeedaccount_id | string | No | ref -> BankfeedAccount this transaction belongs to |
transaction_at | string (date-time) | No | when the transaction occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
posted_at | string (date-time) | No | when it posted / cleared (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
amount | number | No | transaction amount (positive; direction from type) |
type | enum | No | direction: DEBIT, CREDIT Values: DEBIT, CREDIT |
bank_category | string | No | the bank's own category label |
description | string | No | bank memo / statement text |
merchant_name | string | No | counterparty as reported by the bank |
is_pending | boolean | No | true if not yet cleared |
reference | string | No | bank reference or check number |
currency | string | No | ISO 4217 |
contact_id | string | No | matched vendor/customer once reconciled (reference to AccountingContact) |
account_id | string | No | GL account once categorized (reference to AccountingAccount) |
category_ids | string[] | No | dimension refs -> AccountingCategory (class/department/location) |
metadata | AccountingMetadata[] | No | |
metadata[].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). |
metadata[].slug | string | No | The integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration. |
metadata[].value | object | No | The field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string. |
metadata[].namespace | string | No | |
metadata[].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No |
Are we missing anything? Let us know
Was this page helpful?