Bankfeedaccount data model

Updated:

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
namestringNoaccount nickname / source name
bank_namestringNobank / institution name
account_numberstringNofull account number where available
account_number_last4stringNolast-4 when the full number isn't returned
routing_numberstringNobank routing number
account_typeenumNoCHECKING, SAVINGS, CREDIT_CARD, LOAN, OTHER Values: CHECKING, SAVINGS, CREDIT_CARD, LOAN, OTHER
account_idstringNoref -> AccountingAccount: the target GL account the feed posts into (reference to AccountingAccount)
currencystringNoISO 4217 currency of the account
balancenumberNocurrent balance of the source account
feed_start_atstring (date-time)Nodate the feed begins delivering transactions (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
statusenumNofeed state: ACTIVE, INACTIVE Values: ACTIVE, INACTIVE
metadataAccountingMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe 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[].valueobjectNoThe 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[].namespacestringNo
metadata[].formatenumNoThe 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_dataobjectNo

TypeScript

TypeScript
export type AccountingBankfeedaccount = {
	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
	name?: string; // account nickname / source name
	bank_name?: string; // bank / institution name
	account_number?: string; // full account number where available
	account_number_last4?: string; // last-4 when the full number isn't returned
	routing_number?: string; // bank routing number
	account_type?: 'CHECKING' | 'SAVINGS' | 'CREDIT_CARD' | 'LOAN' | 'OTHER'; // CHECKING, SAVINGS, CREDIT_CARD, LOAN, OTHER
	account_id?: string; // ref -> AccountingAccount: the target GL account the feed posts into (reference to AccountingAccount)
	currency?: string; // ISO 4217 currency of the account
	balance?: number; // current balance of the source account
	feed_start_at?: string-time; // date the feed begins delivering transactions (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	status?: 'ACTIVE' | 'INACTIVE'; // feed state: ACTIVE, INACTIVE
	metadata?: [];
	raw?: any; // The original data from the integration's API
} 

Zod

Zod
import { z } from 'zod';

export const ZodAccountingBankfeedaccount = 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"),
	name: z.string().optional().describe("account nickname / source name"),
	bank_name: z.string().optional().describe("bank / institution name"),
	account_number: z.string().optional().describe("full account number where available"),
	account_number_last4: z.string().optional().describe("last-4 when the full number isn't returned"),
	routing_number: z.string().optional().describe("bank routing number"),
	account_type: z.enum("CHECKING", "SAVINGS", "CREDIT_CARD", "LOAN", "OTHER").optional().describe("CHECKING, SAVINGS, CREDIT_CARD, LOAN, OTHER"),
	account_id: z.string().optional().describe("ref -> AccountingAccount: the target GL account the feed posts into (reference to AccountingAccount)"),
	currency: z.string().optional().describe("ISO 4217 currency of the account"),
	balance: z.number().optional().describe("current balance of the source account"),
	feed_start_at: z.string-time().optional().describe("date the feed begins delivering transactions (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	status: z.enum("ACTIVE", "INACTIVE").optional().describe("feed state: ACTIVE, INACTIVE"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AccountingBankfeedaccountAccount_type(str, Enum):
	CHECKING = 'CHECKING'
	SAVINGS = 'SAVINGS'
	CREDIT_CARD = 'CREDIT_CARD'
	LOAN = 'LOAN'
	OTHER = 'OTHER'

@dataclasses.dataclass
class AccountingBankfeedaccountStatus(str, Enum):
	ACTIVE = 'ACTIVE'
	INACTIVE = 'INACTIVE'

@dataclasses.dataclass
class AccountingBankfeedaccount:
	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]
	"""account nickname / source name"""
	name: Optional[str]
	"""bank / institution name"""
	bank_name: Optional[str]
	"""full account number where available"""
	account_number: Optional[str]
	"""last-4 when the full number isn't returned"""
	account_number_last4: Optional[str]
	"""bank routing number"""
	routing_number: Optional[str]
	"""CHECKING, SAVINGS, CREDIT_CARD, LOAN, OTHER"""
	account_type: Optional[AccountingBankfeedaccountAccount_type]
	"""ref -> AccountingAccount: the target GL account the feed posts into (reference to AccountingAccount)"""
	account_id: Optional[str]
	"""ISO 4217 currency of the account"""
	currency: Optional[str]
	"""current balance of the source account"""
	balance: Optional[int]
	"""date the feed begins delivering transactions (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	feed_start_at: Optional[str]
	"""feed state: ACTIVE, INACTIVE"""
	status: Optional[AccountingBankfeedaccountStatus]
	metadata: Optional[PropertyAccountingBankfeedaccountMetadata]
Are we missing anything? Let us know
Was this page helpful?