Skip to main content
POST
Create Chart Entity

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

parent
integer | null
elimination_entity
integer | null
primary_entity
integer | null

When set, this entity is an adjusting entity linked to the specified primary entity.

is_elimination_entity
boolean
default:false
name
string | null
Maximum string length: 250
description
string | null
currency
string
Maximum string length: 3
address_1
string | null
Maximum string length: 120
address_2
string | null
Maximum string length: 120
city
string | null
Maximum string length: 120
state
string | null
Maximum string length: 120
zip_code
string | null
Maximum string length: 120
country
string | null
Maximum string length: 120
disable_service_date
boolean

When enabled, the Service Date field will be hidden on invoices for this entity

logo_url
string<uri> | null
Maximum string length: 500
active
boolean
fiscal_year_month
integer
Required range: -2147483648 <= x <= 2147483647
fiscal_year_day
integer
Required range: -2147483648 <= x <= 2147483647
enable_mid_month_convention
boolean | null

Override customer-level mid-month convention setting for this entity. Leave blank to inherit from customer.

mid_month_threshold
integer | null

Override customer-level threshold. Leave blank to inherit from customer.

Required range: 0 <= x <= 31
use_whole_month_accounting_for_prepaids
boolean | null

Override customer-level whole-month accounting setting for this entity. Leave blank to inherit from customer.

allow_payments_in_closed_periods
boolean

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_periods
boolean

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_array
string[] | null

Pre-computed lineage array from root to this entity

Maximum string length: 50
tax_identification_number
string | null

Tax ID such as Korean BRN, GST number, or EU VAT number

Maximum string length: 250
representative_name
string | null

Legal representative name

Maximum string length: 250
business_type
string | null

Business type classification

Maximum string length: 250
business_category
string | null

Business category classification

Maximum string length: 250
withholding_scheme
integer | null

Withholding tax regime this entity operates under (e.g. Israel NB, India TDS). A bill resolves its scheme via bill.entity.withholding_scheme.

withholding_certificate
integer | null

This entity's own authority-issued certificate (AR side): determines the expected rate customers withhold when paying our invoices under a certificate-based scheme.

ita_deduction_file_number
string | null

Israel tax compliance: ITA withholding deduction file number for Form 856.

Maximum string length: 9
Pattern: ^9\d{8}$
ita_payer_status

Israel tax compliance: payer status classification for Form 856.

  • 1 - Company
  • 2 - Individual
  • 3 - Partner
  • 4 - Non-profit
  • 5 - Agency
Available options:
1,
2,
3,
4,
5

Response

201 - application/json
id
integer
required
read-only
customer
integer
required
read-only
parent_name
string
required
read-only
primary_entity_name
string
required
read-only
is_adjusting
boolean
required
read-only
is_deleted
boolean
default:false
required
read-only
deleted_at
string<date-time> | null
required
read-only
last_modified_at
string<date-time>
required
read-only
created_at
string<date-time> | null
required
read-only
invoice_name
string | null
required
read-only
invoice_email
string | null
required
read-only
invoice_message
string | null
required
read-only
invoice_email_subject
string | null
required
read-only
invoice_email_body
string | null
required
read-only
invoice_prefix
string | null
required
read-only
invoice_address
string | null
required
read-only
invoice_cc_emails
string | null
required
read-only
invoice_display_settings
object | null
required
read-only
invoice_email_attachments
object | null
required
read-only
withholding_scheme_name
string
required
read-only
withholding_certificate_number
string
required
read-only
parent
integer | null
elimination_entity
integer | null
primary_entity
integer | null

When set, this entity is an adjusting entity linked to the specified primary entity.

is_elimination_entity
boolean
default:false
name
string | null
Maximum string length: 250
description
string | null
currency
string
Maximum string length: 3
address_1
string | null
Maximum string length: 120
address_2
string | null
Maximum string length: 120
city
string | null
Maximum string length: 120
state
string | null
Maximum string length: 120
zip_code
string | null
Maximum string length: 120
country
string | null
Maximum string length: 120
disable_service_date
boolean

When enabled, the Service Date field will be hidden on invoices for this entity

logo_url
string<uri> | null
Maximum string length: 500
active
boolean
fiscal_year_month
integer
Required range: -2147483648 <= x <= 2147483647
fiscal_year_day
integer
Required range: -2147483648 <= x <= 2147483647
enable_mid_month_convention
boolean | null

Override customer-level mid-month convention setting for this entity. Leave blank to inherit from customer.

mid_month_threshold
integer | null

Override customer-level threshold. Leave blank to inherit from customer.

Required range: 0 <= x <= 31
use_whole_month_accounting_for_prepaids
boolean | null

Override customer-level whole-month accounting setting for this entity. Leave blank to inherit from customer.

allow_payments_in_closed_periods
boolean

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_periods
boolean

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_array
string[] | null

Pre-computed lineage array from root to this entity

Maximum string length: 50
tax_identification_number
string | null

Tax ID such as Korean BRN, GST number, or EU VAT number

Maximum string length: 250
representative_name
string | null

Legal representative name

Maximum string length: 250
business_type
string | null

Business type classification

Maximum string length: 250
business_category
string | null

Business category classification

Maximum string length: 250
withholding_scheme
integer | null

Withholding tax regime this entity operates under (e.g. Israel NB, India TDS). A bill resolves its scheme via bill.entity.withholding_scheme.

withholding_certificate
integer | null

This entity's own authority-issued certificate (AR side): determines the expected rate customers withhold when paying our invoices under a certificate-based scheme.

ita_deduction_file_number
string | null

Israel tax compliance: ITA withholding deduction file number for Form 856.

Maximum string length: 9
Pattern: ^9\d{8}$
ita_payer_status

Israel tax compliance: payer status classification for Form 856.

  • 1 - Company
  • 2 - Individual
  • 3 - Partner
  • 4 - Non-profit
  • 5 - Agency
Available options:
1,
2,
3,
4,
5