Bankfeedtransaction data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)Nocreation timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)Nolast-update timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
organization_idstringNoref -> accounting Organization this record belongs to
bankfeedaccount_idstringNoref -> BankfeedAccount this transaction belongs to
transaction_atstring (date-time)Nowhen the transaction occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
posted_atstring (date-time)Nowhen it posted / cleared (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
amountnumberNotransaction amount (positive; direction from type)
typeenumNodirection: DEBIT, CREDIT Values: DEBIT, CREDIT
bank_categorystringNothe bank's own category label
descriptionstringNobank memo / statement text
merchant_namestringNocounterparty as reported by the bank
is_pendingbooleanNotrue if not yet cleared
referencestringNobank reference or check number
currencystringNoISO 4217
contact_idstringNomatched vendor/customer once reconciled (reference to AccountingContact)
account_idstringNoGL account once categorized (reference to AccountingAccount)
category_idsstring[]Nodimension refs -> AccountingCategory (class/department/location)

TypeScript

TypeScript
export type AccountingBankfeedtransaction = {
	id?: string;
	created_at?: string-time; // creation timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // last-update timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	organization_id?: string; // ref -> accounting Organization this record belongs to
	bankfeedaccount_id?: string; // ref -> BankfeedAccount this transaction belongs to
	transaction_at?: string-time; // when the transaction occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	posted_at?: string-time; // when it posted / cleared (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	amount?: number; // transaction amount (positive; direction from type)
	type?: 'DEBIT' | 'CREDIT'; // direction: DEBIT, CREDIT
	bank_category?: string; // the bank's own category label
	description?: string; // bank memo / statement text
	merchant_name?: string; // counterparty as reported by the bank
	is_pending?: boolean; // true if not yet cleared
	reference?: string; // bank reference or check number
	currency?: string; // ISO 4217
	contact_id?: string; // matched vendor/customer once reconciled (reference to AccountingContact)
	account_id?: string; // GL account once categorized (reference to AccountingAccount)
	category_ids?: string[]; // dimension refs -> AccountingCategory (class/department/location)
	raw?: any; // The original data from the integration's API
} 

Zod

Zod
import { z } from 'zod';

export const ZodAccountingBankfeedtransaction = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("creation timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("last-update timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	organization_id: z.string().optional().describe("ref -> accounting Organization this record belongs to"),
	bankfeedaccount_id: z.string().optional().describe("ref -> BankfeedAccount this transaction belongs to"),
	transaction_at: z.string-time().optional().describe("when the transaction occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	posted_at: z.string-time().optional().describe("when it posted / cleared (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	amount: z.number().optional().describe("transaction amount (positive; direction from type)"),
	type: z.enum("DEBIT", "CREDIT").optional().describe("direction: DEBIT, CREDIT"),
	bank_category: z.string().optional().describe("the bank's own category label"),
	description: z.string().optional().describe("bank memo / statement text"),
	merchant_name: z.string().optional().describe("counterparty as reported by the bank"),
	is_pending: z.boolean().optional().describe("true if not yet cleared"),
	reference: z.string().optional().describe("bank reference or check number"),
	currency: z.string().optional().describe("ISO 4217"),
	contact_id: z.string().optional().describe("matched vendor/customer once reconciled (reference to AccountingContact)"),
	account_id: z.string().optional().describe("GL account once categorized (reference to AccountingAccount)"),
	category_ids: z.array().optional().describe("dimension refs -> AccountingCategory (class/department/location)"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AccountingBankfeedtransactionType(str, Enum):
	DEBIT = 'DEBIT'
	CREDIT = 'CREDIT'

@dataclasses.dataclass
class AccountingBankfeedtransaction:
	id: Optional[str]
	"""creation timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""last-update timestamp, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""ref -> accounting Organization this record belongs to"""
	organization_id: Optional[str]
	"""ref -> BankfeedAccount this transaction belongs to"""
	bankfeedaccount_id: Optional[str]
	"""when the transaction occurred (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	transaction_at: Optional[str]
	"""when it posted / cleared (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	posted_at: Optional[str]
	"""transaction amount (positive; direction from type)"""
	amount: Optional[int]
	"""direction: DEBIT, CREDIT"""
	type: Optional[AccountingBankfeedtransactionType]
	"""the bank's own category label"""
	bank_category: Optional[str]
	"""bank memo / statement text"""
	description: Optional[str]
	"""counterparty as reported by the bank"""
	merchant_name: Optional[str]
	"""true if not yet cleared"""
	is_pending: Optional[bool]
	"""bank reference or check number"""
	reference: Optional[str]
	"""ISO 4217"""
	currency: Optional[str]
	"""matched vendor/customer once reconciled (reference to AccountingContact)"""
	contact_id: Optional[str]
	"""GL account once categorized (reference to AccountingAccount)"""
	account_id: Optional[str]
	"""dimension refs -> AccountingCategory (class/department/location)"""
	category_ids: Optional[List[List[str]]]
Are we missing anything? Let us know
Was this page helpful?