Agedreceivable data model

Updated:

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

Data Model
FieldTypeRequiredDescription
idstringNosynthetic, one row per currency / date window
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)
currencystringNoISO 4217
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)
total_current_amountnumberNoopen balances not yet past due; distinct from the first past-due period
total_overdue_amountnumberNosum of open balances across all past-due periods
total_amountnumberNo
periodsAccountingAgedPeriod[]No
periods[].namestringNo
periods[].start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
periods[].end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
periods[].total_amountnumberNo
periods[].sub_itemsAccountingAgedRow[]No
periods[].sub_items[].contactAccountingAgedRow_contactNo
periods[].sub_items[].contact.idstringNo
periods[].sub_items[].contact.namestringNo
periods[].sub_items[].transactionAccountingAgedRow_transactionNo
periods[].sub_items[].transaction.idstringNo
periods[].sub_items[].transaction.namestringNo
periods[].sub_items[].posted_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
periods[].sub_items[].due_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
periods[].sub_items[].total_amountnumberNo
periods[].sub_items[].balance_amountnumberNo
organization_idstringNo
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 AccountingAgedreceivable = {
	id?: string; // synthetic, one row per currency / date window
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	currency?: string; // ISO 4217
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	total_current_amount?: number; // open balances not yet past due; distinct from the first past-due period
	total_overdue_amount?: number; // sum of open balances across all past-due periods
	total_amount?: number;
	periods?: [];
	organization_id?: string;
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodAccountingAgedreceivable = z.object({
	id: z.string().optional().describe("synthetic, one row per currency / date window"),
	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)"),
	currency: z.string().optional().describe("ISO 4217"),
	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)"),
	total_current_amount: z.number().optional().describe("open balances not yet past due; distinct from the first past-due period"),
	total_overdue_amount: z.number().optional().describe("sum of open balances across all past-due periods"),
	total_amount: z.number().optional(),
	periods: z.array().optional(),
	organization_id: z.string().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AccountingAgedreceivable:
	"""synthetic, one row per currency / date window"""
	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 4217"""
	currency: 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]
	"""open balances not yet past due; distinct from the first past-due period"""
	total_current_amount: Optional[int]
	"""sum of open balances across all past-due periods"""
	total_overdue_amount: Optional[int]
	total_amount: Optional[int]
	periods: Optional[PropertyAccountingAgedreceivablePeriods]
	organization_id: Optional[str]
	metadata: Optional[PropertyAccountingAgedreceivableMetadata]
Are we missing anything? Let us know
Was this page helpful?