Bankaccount data model

Updated:

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

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
user_idstringNoemployee ID (required for list and create) (reference to HrisEmployee)
company_idstringNo(reference to HrisCompany)
account_typeenumNoValues: CHECKING, SAVINGS
bank_namestringNo
routing_numberstringNo9-digit US routing number
account_numberstringNo
account_number_last4stringNowhen full number not returned
namestringNoaccount nickname (e.g. "BoA Checking")
is_primarybooleanNoprimary for direct deposit
ibanstringNoInternational Bank Account Number (non-US accounts)
bicstringNoBIC / SWIFT code
country_codestringNoISO 2-digit country code of the bank account
currencystringNo
split_typeenumNohow net pay is split into this account when an employee has several accounts Values: PERCENTAGE, FIXED, REMAINDER
split_amountnumberNopercentage (when split_type is PERCENTAGE) or money (when FIXED)
prioritynumberNoorder in which split accounts are funded (1 = first)
metadataHrisMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
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
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.

TypeScript

TypeScript
export type HrisBankaccount = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	user_id?: string; // employee ID (required for list and create) (reference to HrisEmployee)
	company_id?: string; // (reference to HrisCompany)
	account_type?: 'CHECKING' | 'SAVINGS';
	bank_name?: string;
	routing_number?: string; // 9-digit US routing number
	account_number?: string;
	account_number_last4?: string; // when full number not returned
	name?: string; // account nickname (e.g. "BoA Checking")
	is_primary?: boolean; // primary for direct deposit
	iban?: string; // International Bank Account Number (non-US accounts)
	bic?: string; // BIC / SWIFT code
	country_code?: string; // ISO 2-digit country code of the bank account
	currency?: string;
	split_type?: 'PERCENTAGE' | 'FIXED' | 'REMAINDER'; // how net pay is split into this account when an employee has several accounts
	split_amount?: number; // percentage (when split_type is PERCENTAGE) or money (when FIXED)
	priority?: number; // order in which split accounts are funded (1 = first)
	metadata?: [];
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodHrisBankaccount = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	user_id: z.string().optional().describe("employee ID (required for list and create) (reference to HrisEmployee)"),
	company_id: z.string().optional().describe("(reference to HrisCompany)"),
	account_type: z.enum("CHECKING", "SAVINGS").optional(),
	bank_name: z.string().optional(),
	routing_number: z.string().optional().describe("9-digit US routing number"),
	account_number: z.string().optional(),
	account_number_last4: z.string().optional().describe("when full number not returned"),
	name: z.string().optional().describe("account nickname (e.g. "BoA Checking")"),
	is_primary: z.boolean().optional().describe("primary for direct deposit"),
	iban: z.string().optional().describe("International Bank Account Number (non-US accounts)"),
	bic: z.string().optional().describe("BIC / SWIFT code"),
	country_code: z.string().optional().describe("ISO 2-digit country code of the bank account"),
	currency: z.string().optional(),
	split_type: z.enum("PERCENTAGE", "FIXED", "REMAINDER").optional().describe("how net pay is split into this account when an employee has several accounts"),
	split_amount: z.number().optional().describe("percentage (when split_type is PERCENTAGE) or money (when FIXED)"),
	priority: z.number().optional().describe("order in which split accounts are funded (1 = first)"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HrisBankaccountAccount_type(str, Enum):
	CHECKING = 'CHECKING'
	SAVINGS = 'SAVINGS'

@dataclasses.dataclass
class HrisBankaccountSplit_type(str, Enum):
	PERCENTAGE = 'PERCENTAGE'
	FIXED = 'FIXED'
	REMAINDER = 'REMAINDER'

@dataclasses.dataclass
class HrisBankaccount:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""employee ID (required for list and create) (reference to HrisEmployee)"""
	user_id: Optional[str]
	"""(reference to HrisCompany)"""
	company_id: Optional[str]
	account_type: Optional[HrisBankaccountAccount_type]
	bank_name: Optional[str]
	"""9-digit US routing number"""
	routing_number: Optional[str]
	account_number: Optional[str]
	"""when full number not returned"""
	account_number_last4: Optional[str]
	"""account nickname (e.g. "BoA Checking")"""
	name: Optional[str]
	"""primary for direct deposit"""
	is_primary: Optional[bool]
	"""International Bank Account Number (non-US accounts)"""
	iban: Optional[str]
	"""BIC / SWIFT code"""
	bic: Optional[str]
	"""ISO 2-digit country code of the bank account"""
	country_code: Optional[str]
	currency: Optional[str]
	"""how net pay is split into this account when an employee has several accounts"""
	split_type: Optional[HrisBankaccountSplit_type]
	"""percentage (when split_type is PERCENTAGE) or money (when FIXED)"""
	split_amount: Optional[int]
	"""order in which split accounts are funded (1 = first)"""
	priority: Optional[int]
	metadata: Optional[PropertyHrisBankaccountMetadata]
Are we missing anything? Let us know
Was this page helpful?