parent_namestring required
elimination_entityinteger nullable
primary_entityinteger nullable
When set, this entity is an adjusting entity linked to the specified primary entity.
primary_entity_namestring required
is_adjustingboolean required
is_elimination_entityboolean
is_deletedboolean required
deleted_atstring date-time nullable required
last_modified_atstring date-time required
descriptionstring nullable
disable_service_dateboolean
When enabled, the Service Date field will be hidden on invoices for this entity
logo_urlstring uri nullable
created_atstring date-time nullable required
enable_mid_month_conventionboolean nullable
Override customer-level mid-month convention setting for this entity. Leave blank to inherit from customer.
mid_month_thresholdinteger nullable
Override customer-level threshold. Leave blank to inherit from customer.
use_whole_month_accounting_for_prepaidsboolean nullable
Override customer-level whole-month accounting setting for this entity. Leave blank to inherit from customer.
allow_payments_in_closed_periodsboolean
When enabled, allows applying existing transactions as payments to invoices/bills even when the transaction date falls in a closed subledger period.
auto_apply_catchup_for_closed_periodsboolean
When enabled, contracts signed after their revenue start month automatically catch up the elapsed revenue into the sign month, floored at the first open period under the close so it never posts to a closed period. Defaults off — flip in entity settings to opt in.
lineage_arraystring[] nullable
Pre-computed lineage array from root to this entity
tax_identification_numberstring nullable
Tax ID such as Korean BRN, GST number, or EU VAT number
representative_namestring nullable
Legal representative name
business_typestring nullable
Business type classification
business_categorystring nullable
Business category classification
invoice_namestring nullable required
invoice_emailstring nullable required
invoice_messagestring nullable required
invoice_email_subjectstring nullable required
invoice_email_bodystring nullable required
invoice_prefixstring nullable required
invoice_addressstring nullable required
invoice_cc_emailsstring nullable required
invoice_display_settingsobject nullable required
invoice_email_attachmentsobject nullable required
withholding_schemeinteger nullable
Withholding tax regime this entity operates under (e.g. Israel NB, India TDS). A bill resolves its scheme via bill.entity.withholding_scheme.
withholding_scheme_namestring required
withholding_certificateinteger nullable
This entity's own authority-issued certificate (AR side): determines the expected rate customers withhold when paying our invoices under a certificate-based scheme.
withholding_certificate_numberstring required
ita_deduction_file_numberstring nullable
Israel tax compliance: ITA withholding deduction file number for Form 856.