Entity
Represents entities in a multi-entity organization, including fiscal settings, tax configuration, inter-entity GL accounts, legal contact details, and associated customer and vendor records.
Columns
| Name | Type | ReadOnly | Description |
| accountingType | String | False |
The accounting type of the entity, such as accrual or cash. |
| auditCreatedBy | String | True |
The user who created the entity. |
| auditCreatedDateTime | Datetime | True |
The date and time when the entity was created. |
| auditModifiedBy | String | True |
The user who last modified the entity. |
| auditModifiedDateTime | Datetime | True |
The date and time when the entity was last modified. |
| businessDays | String | False |
The business days configured for this entity. |
| businessId | String | False |
The business identifier assigned to this entity. |
| contactsLegalCategory | String | False |
The legal category of the entity's contacts. |
| contactsMainActivity | String | False |
The main business activity for the entity's contacts. |
| contactsRegisteredCapital | Int | False |
The registered capital amount for the entity's contacts. |
| contactsTypeOfCompany | String | False |
The type of company for the entity's contacts. |
| contactsValueAddedTaxRegime | String | False |
The value-added tax regime applicable to the entity's contacts. |
| customer_Href | String | True |
The URL of the customer associated with this entity. |
| customer_Id | String | False |
The Id of the customer associated with this entity. |
| customer_Key | String | False |
The system-assigned key of the customer associated with this entity. |
| customer_Name | String | True |
The name of the customer associated with this entity. |
| defaultCountryForAddresses | String | False |
The default country code used for addresses in this entity. |
| electronicAddress | String | True |
The electronic address identifier for this entity, used for e-invoicing. |
| enableEInvoicing | Bool | True |
Indicates whether e-invoicing is enabled for this entity. |
| enableInterEntityRelationships | Bool | False |
Indicates whether inter-entity relationships are enabled for this entity. |
| endDate | Date | False |
The date on which this entity becomes inactive. |
| federalId | String | False |
The federal tax identifier for this entity. |
| firstFiscalMonth | String | False |
The first month of the fiscal year for this entity. |
| firstTaxMonth | String | False |
The first month of the tax year for this entity. |
| href | String | True |
The URL of the entity resource. |
| id | String | False |
The unique identifier of the entity record. |
| interEntityPayableGLAccount_AccountNumber | String | True |
The account number of the GL account used for inter-entity payables for this entity. |
| interEntityPayableGLAccount_Href | String | True |
The URL of the GL account used for inter-entity payables for this entity. |
| interEntityPayableGLAccount_Id | String | False |
The Id of the GL account used for inter-entity payables for this entity. |
| interEntityPayableGLAccount_Key | String | False |
The system-assigned key of the GL account used for inter-entity payables for this entity. |
| interEntityReceivableGLAccount_AccountNumber | String | True |
The account number of the GL account used for inter-entity receivables for this entity. |
| interEntityReceivableGLAccount_Href | String | True |
The URL of the GL account used for inter-entity receivables for this entity. |
| interEntityReceivableGLAccount_Id | String | False |
The Id of the GL account used for inter-entity receivables for this entity. |
| interEntityReceivableGLAccount_Key | String | False |
The system-assigned key of the GL account used for inter-entity receivables for this entity. |
| isDefaultPartialExempt | Bool | False |
Indicates whether this entity is set as partially exempt from tax by default. |
| isLimitedEntity | Bool | False |
Indicates whether this entity is a limited entity with restricted access. |
| isPartialExempt | Bool | False |
Indicates whether this entity is partially exempt from tax. |
| isRoot | Bool | True |
Indicates whether this entity is the root entity in the organization hierarchy. |
| key [KEY] | String | True |
The system-assigned key that uniquely identifies the entity record. |
| legalContactEnableOnTPAR | Bool | False |
Indicates whether the legal contact is enabled on Taxable Payments Annual Reports for this entity. |
| legalContactEnableOnTaxForms | Bool | False |
Indicates whether the legal contact is enabled on tax forms for this entity. |
| legalContactName | String | False |
The name of the legal contact for this entity. |
| manager_Email1 | String | True |
The primary email address of the manager associated with this entity. |
| manager_Email2 | String | True |
The secondary email address of the manager associated with this entity. |
| manager_Href | String | True |
The URL of the manager associated with this entity. |
| manager_Id | String | False |
The Id of the manager associated with this entity. |
| manager_Key | String | False |
The system-assigned key of the manager associated with this entity. |
| manager_Name | String | True |
The name of the manager associated with this entity. |
| name | String | False |
The name of the entity. |
| openBooksStartDate | Date | False |
The date from which open books are maintained for this entity. |
| operatingCountry | String | False |
The country in which this entity operates. |
| startDate | Date | False |
The date on which this entity becomes active. |
| status | String | False |
The current status of the entity, such as active or inactive. |
| statutoryReportingPeriodDate | Date | False |
The statutory reporting period date for this entity. |
| taxId | String | False |
The tax identifier for this entity. |
| taxSolution_Href | String | True |
The URL of the tax solution associated with this entity. |
| taxSolution_Id | String | False |
The Id of the tax solution associated with this entity. |
| taxSolution_Key | String | False |
The system-assigned key of the tax solution associated with this entity. |
| taxSolution_TaxMethod | String | True |
The tax method used by the tax solution associated with this entity. |
| textsCustomTitle | String | False |
The custom title text displayed on documents for this entity. |
| textsFootnote | String | False |
The footnote text displayed on documents for this entity. |
| textsMarketing | String | False |
The marketing text displayed on documents for this entity. |
| textsMessage | String | False |
The message text displayed on documents for this entity. |
| textsReportPrintAs | String | False |
The name to print on reports for this entity. |
| unrecoverableTaxAccount_Href | String | True |
The URL of the unrecoverable tax GL account associated with this entity. |
| unrecoverableTaxAccount_Id | String | False |
The Id of the unrecoverable tax GL account associated with this entity. |
| unrecoverableTaxAccount_Key | String | False |
The system-assigned key of the unrecoverable tax GL account associated with this entity. |
| vendor_Href | String | True |
The URL of the vendor associated with this entity. |
| vendor_Id | String | False |
The Id of the vendor associated with this entity. |
| vendor_Key | String | False |
The system-assigned key of the vendor associated with this entity. |
| vendor_Name | String | True |
The name of the vendor associated with this entity. |
| weekStart | String | False |
The day on which the work week starts for this entity. |
| weekends | String | False |
The days designated as weekends for this entity. |