Variables available for Entity Document Templates

List of Fields that can be used in document templates for Entities

November 2024

Copy of Entities Endpoint

Field Name	Description	Field Name	Description
id	string example: 263 The unique identifier of the Legal Entity.
name	string example: My master top co A Legal Entity Name is the name as set out in the latest articles of association or equivalent constitutional document and is used for the identification of an entity.
companyName	string example: My master top co SARL The name of the entity including its legalform name.
active	boolean example: true Active is when a Legal Entity has been either fully incorporated or acquired and can perform its intended activities.
legalForm	LegalForm{...}
suppressLegalForm	boolean example: true A Legal Form is a Legal Entity type recognised by law and as set out in the latest articles of association or equivalent constitutional document.
projects	[...]
status	EntityStatus{...}
type	Option{...}
registrationNumber	string example: ABC123 A Legal Entity Registration Number is a unique identifier designated by the competent Registration Authority in each Jurisdiction and is used to identify a Legal Entity.
registrationAuthority	RegistrationAuthority{...}
incorporation	string($date) An Incorporation Date is the date when a Legal Entity has been legally and validly incorporated or set up.
vatCorpDomestic	string A VAT Domestic Number (Corporate) is a VAT Domestic Number in the Legal Entity's head office country (non COMI shifted).
vatCorpInternational	string
vatCorpObligatory	boolean
vatFiscalUnity	string
vatRegime	Option{...}
vatAssetInternational	string
vatAssetDomestic	string
vatAssetRegime	Option{...}
fiscalNoCorp	string nullable: true
fiscalNoAsset	string nullable: true
acquisition	string($date) A Legal Entity Acquisition Date is the date on which the Legal title to the target Legal Entity is obtained.
endOfFiscalYearDay	string
endOfFiscalYearMonth	string
endOfFinancialYearDay	string
endOfFinancialYearMonth	string
leiNumber	string A Legal Entity Identifier is a 20-character reference code to uniquely identify Legal Entities that engage in financial transactions.
registeredAddress	Address{...}
postalAddress	Address{...}
registeredSeatAddress	Address{...}
governingBody	[...]
formerGoverningBody	[...]
supervisoryBoard	[...]
formerSupervisoryBoard	[...]
advisoryCommittee	[...]
formerAdvisoryCommittee	[...]
resolvedGoverningBody	[...]
shareholders	[...]
signatoryPowerRules	SignatoryPowerRules{...}
inactiveSince	string($date)
funds	[...]
shareCapitals	[...]
authorizedShareCapitals	[...]
dissolutionTargetDate	string($date)
inDissolutionDate	string($date)
dissolutionDate	string($date)
disposalTargetClosingDate	string($date)
disposalSigningDate	string($date)
formerEntityNames	[...]
formerRegistrationNumber	string example: XY12 A Legal Entity Former Registration Number is a unique identifier designated by the competent Registration Authority in each Jurisdiction and is used to identify a Legal Entity.
formerRegistrationAuthority	RegistrationAuthority{...}
mergerEntity	EntityOverview{...}
demergedFromEntities	[...]
usTaxStatus	Option{...}
bankingGroup	boolean
baseCurrency	Currency{...}
buyerName	string nullable: true
consolidatedAnnualAccounts	boolean
debtTranches	[...]
customFields	[...]
created	string($date-time) example: 2013-12-01 T00:00:00+02:00 The created timestamp the entity.
modified	string($date-time) example: 2023-12-01 00:00:00 The modified timestamp the entity.