Balancesheet data model

Updated:

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

Data Model
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)
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNo
currencystringNo
net_assets_amountnumberNo
assetsAccountingBalancesheetItem[]No
assets[].account_idstringNo(reference to AccountingAccount)
assets[].namestringNo
assets[].amountnumberNo
assets[].sub_itemsobjectNo
liabilitiesAccountingBalancesheetItem[]No
liabilities[].account_idstringNo(reference to AccountingAccount)
liabilities[].namestringNo
liabilities[].amountnumberNo
liabilities[].sub_itemsobjectNo
equityAccountingBalancesheetItem[]No
equity[].account_idstringNo(reference to AccountingAccount)
equity[].namestringNo
equity[].amountnumberNo
equity[].sub_itemsobjectNo
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 AccountingBalancesheet = {
	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)
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string;
	currency?: string;
	net_assets_amount?: number;
	assets?: [];
	liabilities?: [];
	equity?: [];
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodAccountingBalancesheet = 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)"),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional(),
	currency: z.string().optional(),
	net_assets_amount: z.number().optional(),
	assets: z.array().optional(),
	liabilities: z.array().optional(),
	equity: z.array().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AccountingBalancesheet:
	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]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	name: Optional[str]
	currency: Optional[str]
	net_assets_amount: Optional[int]
	assets: Optional[PropertyAccountingBalancesheetAssets]
	liabilities: Optional[PropertyAccountingBalancesheetLiabilities]
	equity: Optional[PropertyAccountingBalancesheetEquity]
	metadata: Optional[PropertyAccountingBalancesheetMetadata]
Are we missing anything? Let us know
Was this page helpful?