Schema Types

Table of Contents

Query
Mutation
Objects
Inputs
Enums
Scalars
Interfaces
Unions

Query

Represents the root-level queries available in the GraphQL schema, used to retrieve data.

Field	Type	Description
node	Node	Retrieves a single node by its ID from the system.
id	ID!	ID of the object.
nodes	[Node]!	Retrieves multiple nodes based on specific filters or criteria.
ids	[ID!]!	The list of node IDs.
address	Address	Fetches a specific address by query.
id	ID!
addresses	AddressesCollectionSegment	Fetches a collection of addresses by query.
skip	Int
take	Int
where	AddressFilterPayloadFilterInput
order	[AddressPayloadSortInput!]
addressType	AddressType	Fetches a specific address type by query.
id	ID!
addressTypes	AddressTypesCollectionSegment	Fetches a collection of address type by query.
skip	Int
take	Int
where	AddressTypeFilterPayloadFilterInput
order	[AddressTypePayloadSortInput!]
pastAddress	PastAddressEntry	Retrieves a specific past address by identifier.
id	ID!
pastAddresses	PastAddressesCollectionSegment	Retrieves a list of past addresses.
skip	Int
take	Int
where	PastAddressPayloadFilterInput
order	[PastAddressPayloadSortInput!]
appointmentCategories	AppointmentCategoriesCollectionSegment	Retrieves the list of appointment categories available in the system.
skip	Int
take	Int
where	AppointmentCategoryFilterPayloadFilterInput
order	[AppointmentCategoryPayloadSortInput!]
appointmentCategory	AppointmentCategory	Fetches a specific appointment category by query.
id	ID!
appointmentGroup	AppointmentGroup	Fetches a specific appointment group by query.
id	ID!
appointmentGroups	AppointmentGroupsCollectionSegment	Fetches a collection of appointment groups by query.
skip	Int
take	Int
where	AppointmentGroupFilterPayloadFilterInput
order	[AppointmentGroupPayloadSortInput!]
appointment	Appointment	Fetches a specific appointment by query.
id	ID!
appointments	AppointmentsCollectionSegment	Fetches a collection of appointments by query.
skip	Int
take	Int
where	AppointmentPayloadFilterInput
order	[AppointmentPayloadSortInput!]
appointmentStatus	AppointmentStatus	Fetches a specific appointment status by query.
id	ID!
appointmentStatuses	AppointmentStatusesCollectionSegment	Fetches a collection of appointment statuses by query.
skip	Int
take	Int
where	AppointmentStatusFilterPayloadFilterInput
order	[AppointmentStatusPayloadSortInput!]
appointmentType	AppointmentType	Fetches a specific appointment type by query.
id	ID!
appointmentTypes	AppointmentTypesCollectionSegment	Fetches a collection of appointment types by query.
skip	Int
take	Int
where	AppointmentTypeFilterPayloadFilterInput
order	[AppointmentTypePayloadSortInput!]
pendingAppointment	PendingAppointment	Retrieves a specific pending appointment record by its unique identifier.
id	ID!
pendingAppointments	PendingAppointmentsCollectionSegment	Retrieves a paginated list of pending appointments with optional filtering and sorting capabilities.
skip	Int
take	Int
where	PendingAppointmentPayloadFilterInput
order	[PendingAppointmentPayloadSortInput!]
auditTrail	AuditTrail	Retrieves a specific audit trail record detailing system activity.
id	ID!
auditTrails	AuditTrailsCollectionSegment	Retrieves a list of audit trail records for tracking changes and actions.
skip	Int
take	Int
where	AuditTrailPayloadFilterInput
order	[AuditTrailPayloadSortInput!]
companies	CompaniesCollectionSegment	Retrieves a list of companies based on the specified query filters.
skip	Int
take	Int
where	CompanyFilterPayloadFilterInput
order	[CompanyPayloadSortInput!]
company	Company	Retrieves a specific company by its ID.
id	ID!
companyStatus	CompanyStatus	Retrieves the status of a specific company.
id	ID!
companyStatuses	CompanyStatusesCollectionSegment	Retrieves a list of possible company statuses (e.g., active, dissolved).
skip	Int
take	Int
where	CompanyStatusFilterPayloadFilterInput
order	[CompanyStatusPayloadSortInput!]
companyType	CompanyType	Retrieves a single company type based on its ID.
id	ID!
companyTypes	CompanyTypesCollectionSegment	Retrieves a list of available company types.
skip	Int
take	Int
where	CompanyTypeFilterPayloadFilterInput
corporateRelationship	CorporateRelationship	Retrieves a specific corporate relationship by its ID.
id	ID!
corporateRelationships	CorporateRelationshipsCollectionSegment	Retrieves a list of corporate relationships.
skip	Int
take	Int
where	CorporateRelationshipFilterPayloadFilterInput
order	[CorporateRelationshipPayloadSortInput!]
corporateStructure	CorporateStructure	Retrieves a specific corporate structure and its attributes.
id	ID!
corporateStructures	CorporateStructuresCollectionSegment	Retrieves a list of corporate structures.
skip	Int
take	Int
where	CorporateStructureFilterPayloadFilterInput
order	[CorporateStructurePayloadSortInput!]
countries	CountriesCollectionSegment	Retrieves a list of countries.
skip	Int
take	Int
where	CountryFilterPayloadFilterInput
order	[CountryPayloadSortInput!]
country	Country	Retrieves a specific country by its ID.
id	ID!
currencies	CurrenciesCollectionSegment	Retrieves a list of currencies.
skip	Int
take	Int
where	CurrencyFilterPayloadFilterInput
order	[CurrencyPayloadSortInput!]
currency	Currency	Retrieves a specific currency by its ID.
id	ID!
dataLibraries	DataLibrariesCollectionSegment	Retrieves a list of Data Library records.
skip	Int
take	Int
where	DataLibraryPayloadFilterInput
order	[DataLibraryPayloadSortInput!]
dataLibrary	DataLibrary	Retrieves a specific Data Library record.
id	ID!
dataLibraryCategories	DataLibraryCategoriesCollectionSegment	Retrieves a list of Data Library categories.
skip	Int
take	Int
where	DataLibraryCategoryPayloadFilterInput
order	[DataLibraryCategoryPayloadSortInput!]
dataLibraryCategory	DataLibraryCategory	Retrieves a specific Data Library category.
id	ID!
dataLibraryStatus	DataLibraryStatus	Retrieves a specific Data Library status.
id	ID!
dataLibraryStatuses	DataLibraryStatusesCollectionSegment	Retrieves a list of Data Library statuses.
skip	Int
take	Int
where	DataLibraryStatusPayloadFilterInput
order	[DataLibraryStatusPayloadSortInput!]
dataLibraryType	DataLibraryType	Retrieves a specific Data Library type.
id	ID!
dataLibraryTypes	DataLibraryTypesCollectionSegment	Retrieves a list of Data Library types.
skip	Int
take	Int
where	DataLibraryTypePayloadFilterInput
order	[DataLibraryTypePayloadSortInput!]
dataLibraryUdf	DataLibraryUdf	Retrieves a specific user-defined field (UDF) from the Data Library.
id	ID!
dataLibraryUdfs	DataLibraryUdfsCollectionSegment	Retrieves a list of user-defined fields (UDFs) from the Data Library.
skip	Int
take	Int
where	DataLibraryUdfPayloadFilterInput
order	[DataLibraryUdfPayloadSortInput!]
document	Document	Retrieves a specific document and its details.
id	ID!
documents	DocumentsCollectionSegment	Retrieves a list of documents.
skip	Int
take	Int
where	DocumentPayloadFilterInput
order	[DocumentPayloadSortInput!]
entities	EntitiesCollectionSegment	Fetches a collection of entities by query.
skip	Int
take	Int
where	EntityBaseFilterPayloadFilterInput
order	[EntityPayloadSortInput!]
entityBatch	EntityBatch	Retrieves a specific entity batch by its ID.
id	ID!
entityBatches	EntityBatchesCollectionSegment	Retrieves a list of entity batches.
skip	Int
take	Int
where	EntityBatchFilterPayloadFilterInput
order	[EntityBatchPayloadSortInput!]
entityIdentification	EntityIdentification	Retrieves a specific entity identification by ID.
id	ID!
entitySecurityGroup	EntitySecurityGroup	Retrieves a specific entity security group by its ID.
id	ID!
entitySecurityGroups	EntitySecurityGroupsCollectionSegment	Retrieves a list of entity security groups.
skip	Int
take	Int
where	EntitySecurityGroupFilterPayloadFilterInput
order	[EntitySecurityGroupPayloadSortInput!]
entitySet	EntitySet	Retrieves a specific entity set by its ID.
id	ID!
entitySets	EntitySetsCollectionSegment	Retrieves a list of entity sets.
skip	Int
take	Int
where	EntitySetFilterPayloadFilterInput
order	[EntitySetPayloadSortInput!]
entityType	EntityType	Retrieves a single entity type based on its ID.
id	ID!
entityTypes	EntityTypesCollectionSegment	Retrieves a list of entity types.
skip	Int
take	Int
where	EntityTypeFilterPayloadFilterInput
order	[EntityTypePayloadSortInput!]
eventGroup	EventGroup	Retrieves a single event group by its identifier.
id	ID!
eventGroups	EventGroupsCollectionSegment	Retrieves a list of all event groups.
skip	Int
take	Int
where	EventGroupPayloadFilterInput
order	[EventGroupPayloadSortInput!]
eventType	EventType	Retrieves a single event type by its identifier.
id	ID!
eventTypes	EventTypesCollectionSegment	Retrieves a list of all event types.
skip	Int
take	Int
where	EventTypePayloadFilterInput
order	[EventTypePayloadSortInput!]
globalOption	GlobalOption	Retrieves a global application option value by name.
groupStructure	GroupStructurePayload	Represents group structure for query.
id	ID!
individual	Individual	Retrieves a specific individual entity by its ID.
id	ID!
individuals	IndividualsCollectionSegment	Retrieves a list of individual entities.
skip	Int
take	Int
where	IndividualFilterPayloadFilterInput
order	[IndividualPayloadSortInput!]
industrialClassification	IndustrialClassification	Retrieves a specific industrial classification by its ID.
id	ID!
industrialClassifications	IndustrialClassificationsCollectionSegment	Retrieves a list of industrial classifications.
skip	Int
take	Int
where	IndustrialClassificationFilterPayloadFilterInput
order	[IndustrialClassificationPayloadSortInput!]
job	Job	Represents job for query.
id	ID!
jobs	JobsCollectionSegment	Represents jobs for query.
skip	Int
take	Int
where	JobPayloadFilterInput
order	[JobPayloadSortInput!]
nationalities	NationalitiesCollectionSegment	Retrieves a list of nationalities.
skip	Int
take	Int
where	NationalityFilterPayloadFilterInput
order	[NationalityPayloadSortInput!]
nationality	Nationality	Retrieves a specific nationality by its ID.
id	ID!
occupation	Occupation	Fetches a specific occupation by query.
id	ID!
occupations	OccupationsCollectionSegment	Fetches a collection of occupations by query.
skip	Int
take	Int
where	OccupationPayloadFilterInput
order	[OccupationPayloadSortInput!]
otherEntities	OtherEntitiesCollectionSegment	Retrieves a list of other types of entities (e.g., individuals or organizations) based on query filters.
skip	Int
take	Int
where	OtherEntityFilterPayloadFilterInput
order	[OtherEntityPayloadSortInput!]
otherEntity	OtherEntity	Retrieves a specific other entity by its ID.
id	ID!
partner	Partner	Retrieves a specific partner entity by its ID.
id	ID!
partners	PartnersCollectionSegment	Retrieves a list of partner entities.
skip	Int
take	Int
where	PartnerFilterPayloadFilterInput
order	[PartnerPayloadSortInput!]
pendingEvent	PendingEvent	Retrieves a specific pending event by its ID.
id	ID!
pendingEvents	PendingEventsCollectionSegment	Retrieves a list of pending events.
skip	Int
take	Int
where	PendingEventPayloadFilterInput
order	[PendingEventPayloadSortInput!]
pendingEventStatus	PendingEventStatus	Retrieves the status of a specific pending event.
id	ID!
savedFilter	SavedFilter	Represents saved filter for query.
id	ID!
savedFilters	SavedFiltersCollectionSegment	Represents saved filters for query.
skip	Int
take	Int
where	SavedFilterPayloadFilterInput
order	[SavedFilterPayloadSortInput!]
shareCategories	ShareCategoriesCollectionSegment	Retrieves a list of share categories.
skip	Int
take	Int
where	ShareCategoryFilterPayloadFilterInput
shareCategory	ShareCategory	Retrieves a specific share category.
id	ID!
shareClass	ShareClass	Retrieves a specific share class and its attributes.
id	ID!
shareClasses	ShareClassesCollectionSegment	Retrieves a list of share classes.
skip	Int
take	Int
where	ShareClassFilterPayloadFilterInput
share	Share	Retrieves a specific share record.
id	ID!
shares	SharesCollectionSegment	Retrieves a list of share records.
skip	Int
take	Int
where	ShareFilterPayloadFilterInput
order	[SharePayloadSortInput!]
subCountries	SubCountriesCollectionSegment	Retrieves a list of sub-countries (e.g., states or provinces).
skip	Int
take	Int
where	SubCountryFilterPayloadFilterInput
order	[SubCountryPayloadSortInput!]
subCountry	SubCountry	Retrieves a specific sub-country by its ID.
id	ID!
trust	Trust	Represents trust for query.
id	ID!
trusts	TrustsCollectionSegment	Represents trusts for query.
skip	Int
take	Int
where	TrustFilterPayloadFilterInput
order	[TrustPayloadSortInput!]
udf	Udf	Retrieves a specific User-Defined Field (UDF) by its ID.
id	ID!
udfs	UdfsCollectionSegment	Retrieves a list of User-Defined Fields (UDFs).
skip	Int
take	Int
where	UdfFilterPayloadFilterInput
order	[UdfPayloadSortInput!]
userGrouping	UserGrouping	Retrieves a specific user grouping by its ID.
id	ID!
userGroupings	UserGroupingsCollectionSegment	Retrieves a list of user groupings.
skip	Int
take	Int
where	UserGroupingFilterPayloadFilterInput
order	[UserGroupingPayloadSortInput!]
userRole	UserRole	Retrieves a specific user role based on provided parameters.
id	ID!
userRoles	UserRolesCollectionSegment	Retrieves a collection of user roles available in the system.
skip	Int
take	Int
where	UserRoleFilterPayloadFilterInput
order	[UserRolePayloadSortInput!]
currentUser	CurrentUser	Retrieves information about the currently authenticated user.
user	User	Retrieves a specific user by their ID.
id	ID!
users	UsersCollectionSegment	Retrieves a list of users.
skip	Int
take	Int
where	UserPayloadFilterInput
order	[UserPayloadSortInput!]

Mutation

Represents the root-level mutations available in the GraphQL schema, used to perform data-altering operations such as creating, updating, or deleting entities.

Field	Type	Description
createAddress	CreateAddressPayload!	Creates a new address record in the system.
input	CreateAddressInput!
deleteAddress	DeleteAddressPayload!	Deletes an existing address record from the system.
input	DeleteAddressInput!
updateAddress	UpdateAddressPayload!	Updates the details of an existing address record.
id	ID!
input	UpdateAddressInput!
connectAddressToEntity	ConnectAddressToEntityPayload!	Mutation to connect address to entity.
input	ConnectAddressToEntityInput!
disconnectAddressFromEntity	DisconnectAddressFromEntityPayload!	Mutation to disconnect address from entity.
input	DisconnectAddressFromEntityInput!
connectEntityTypeToAddressType	ConnectEntityTypeToAddressTypePayload!	Links an entity type to an address type for configuration.
addressTypeId	ID!
input	ConnectEntityTypeToAddressTypeInput!
createAddressType	CreateAddressTypePayload!	Creates a new address type (e.g., registered, residential).
input	CreateAddressTypeInput!
deleteAddressType	DeleteAddressTypePayload!	Deletes an existing address type from the system.
input	DeleteAddressTypeInput!
disconnectEntityTypeFromAddressType	DisconnectEntityTypeFromAddressTypePayload!	Removes the link between an entity type and an address type.
addressTypeId	ID!
input	DisconnectEntityTypeFromAddressTypeInput!
updateAddressType	UpdateAddressTypePayload!	Updates the details of an existing address type.
id	ID!
input	UpdateAddressTypeInput!
createPendingAppointment	CreatePendingAppointmentPayload!	Creates a new pending appointment record for an entity.
input	CreatePendingAppointmentInput!
createPendingChangeJobTitle	CreatePendingChangeJobTitlePayload!	Mutation to create pending change job title.
input	CreatePendingChangeJobTitleInput!
createPendingDeath	CreatePendingDeathPayload!	Mutation to create pending death.
input	CreatePendingDeathInput!
createPendingRemoval	CreatePendingRemovalPayload!	Mutation to create pending removal.
input	CreatePendingRemovalInput!
createPendingReplacement	CreatePendingReplacementPayload!	Creates a new pending replacement record for an entity.
input	CreatePendingReplacementInput!
createPendingResignation	CreatePendingResignationPayload!	Creates a new pending resignation record for an entity.
input	CreatePendingResignationInput!
updatePendingAppointment	UpdatePendingAppointmentPayload!	Mutation to update pending appointment.
id	ID!
input	UpdatePendingAppointmentInput!
updatePendingChangeJobTitle	UpdatePendingChangeJobTitlePayload!	Mutation to update pending change job title.
id	ID!
input	UpdatePendingChangeJobTitleInput!
updatePendingDeath	UpdatePendingDeathPayload!	Mutation to update pending death.
id	ID!
input	UpdatePendingDeathInput!
updatePendingRemoval	UpdatePendingRemovalPayload!	Mutation to update pending removal.
id	ID!
input	UpdatePendingRemovalInput!
updatePendingReplacement	UpdatePendingReplacementPayload!	Mutation to update pending replacement.
id	ID!
input	UpdatePendingReplacementInput!
updatePendingResignation	UpdatePendingResignationPayload!	Mutation to update pending resignation.
id	ID!
input	UpdatePendingResignationInput!
createCompany	CreateCompanyPayload!	Mutation to create a new company in the system.
input	CreateCompanyInput!
deleteCompany	DeleteCompanyPayload!	Mutation to delete an existing company from the system.
input	DeleteCompanyInput!
updateCompany	UpdateCompanyPayload!	Mutation to update the details of an existing company.
id	ID!
input	UpdateCompanyInput!
updateCompanyOptions	UpdateCompanyOptionsPayload!	Mutation to update company-related options.
id	ID!
input	UpdateCompanyOptionsInput!
createCompanyStatus	CreateCompanyStatusPayload!	Mutation to create a new company status (e.g., Active, Inactive).
input	CreateCompanyStatusInput!
deleteCompanyStatus	DeleteCompanyStatusPayload!	Mutation to delete an existing company status.
input	DeleteCompanyStatusInput!
updateCompanyStatus	UpdateCompanyStatusPayload!	Mutation to update an existing company status.
id	ID!
input	UpdateCompanyStatusInput!
createCompanyType	CreateCompanyTypePayload!	Mutation to create a new company type in the system.
input	CreateCompanyTypeInput!
deleteCompanyType	DeleteCompanyTypePayload!	Mutation to delete an existing company type from the system.
input	DeleteCompanyTypeInput!
updateCompanyType	UpdateCompanyTypePayload!	Mutation to update an existing company type.
id	ID!
input	UpdateCompanyTypeInput!
createDataLibrary	CreateDataLibraryPayload!	Creates a new Data Library record.
input	CreateDataLibraryInput!
deleteDataLibrary	DeleteDataLibraryPayload!	Deletes an existing Data Library record.
input	DeleteDataLibraryInput!
updateDataLibrary	UpdateDataLibraryPayload!	Updates the details of an existing Data Library record.
id	ID!
input	UpdateDataLibraryInput!
connectEntitiesToEntityBatch	ConnectEntitiesToEntityBatchPayload!	Mutation to connect multiple entities to an entity batch.
id	ID!
input	ConnectEntitiesToEntityBatchInput!
connectEntityBatchesToEntity	ConnectEntityBatchesToEntityPayload!	Mutation to connect multiple entity batches to an entity.
id	ID!
input	ConnectEntityBatchesToEntityInput!
createEntityBatch	CreateEntityBatchPayload!	Mutation to create a new entity batch in the system.
input	CreateEntityBatchInput!
deleteEntityBatch	DeleteEntityBatchPayload!	Mutation to delete an existing entity batch.
input	DeleteEntityBatchInput!
disconnectEntitiesFromEntityBatch	DisconnectEntitiesFromEntityBatchPayload!	Mutation to disconnect multiple entities from an entity batch.
id	ID!
input	DisconnectEntitiesFromEntityBatchInput!
disconnectEntityBatchesFromEntity	DisconnectEntityBatchesFromEntityPayload!	Mutation to disconnect multiple entity batches from an entity.
id	ID!
input	DisconnectEntityBatchesFromEntityInput!
updateEntityBatch	UpdateEntityBatchPayload!	Mutation to update an existing entity batch.
id	ID!
input	UpdateEntityBatchInput!
createEntityIdentification	CreateEntityIdentificationPayload!	Mutation used to create a new entity identification record.
input	CreateEntityIdentificationInput!
deleteEntityIdentification	DeleteEntityIdentificationPayload!	Mutation used to delete an existing entity identification record.
input	DeleteEntityIdentificationInput!
updateEntityIdentification	UpdateEntityIdentificationPayload!	Mutation used to update the value of an existing entity identification record.
id	ID!
input	UpdateEntityIdentificationInput!
connectEntitiesToEntitySecurityGroup	ConnectEntitiesToEntitySecurityGroupPayload!	Mutation to connect multiple entities to an entity security group.
id	ID!
input	ConnectEntitiesToEntitySecurityGroupInput!
connectEntitySecurityGroupsToEntity	ConnectEntitySecurityGroupsToEntityPayload!	Mutation to connect multiple entity security groups to an entity.
id	ID!
input	ConnectEntitySecurityGroupsToEntityInput!
createEntitySecurityGroup	CreateEntitySecurityGroupPayload!	Mutation to create a new entity security group.
input	CreateEntitySecurityGroupInput!
deleteEntitySecurityGroup	DeleteEntitySecurityGroupPayload!	Mutation to delete an existing entity security group.
input	DeleteEntitySecurityGroupInput!
disconnectEntitiesFromEntitySecurityGroup	DisconnectEntitiesFromEntitySecurityGroupPayload!	Mutation to disconnect multiple entities from an entity security group.
id	ID!
input	DisconnectEntitiesFromEntitySecurityGroupInput!
disconnectEntitySecurityGroupsFromEntity	DisconnectEntitySecurityGroupsFromEntityPayload!	Mutation to disconnect multiple entity security groups from an entity.
id	ID!
input	DisconnectEntitySecurityGroupsFromEntityInput!
updateEntitySecurityGroup	UpdateEntitySecurityGroupPayload!	Mutation to update an existing entity security group.
id	ID!
input	UpdateEntitySecurityGroupInput!
connectEntitiesToEntitySet	ConnectEntitiesToEntitySetPayload!	Mutation to connect multiple entities to an entity set.
id	ID!
input	ConnectEntitiesToEntitySetInput!
connectEntitySetsToEntity	ConnectEntitySetsToEntityPayload!	Mutation to connect multiple entity sets to an entity.
id	ID!
input	ConnectEntitySetsToEntityInput!
createEntitySet	CreateEntitySetPayload!	Mutation to create a new entity set in the system.
input	CreateEntitySetInput!
deleteEntitySet	DeleteEntitySetPayload!	Mutation to delete an existing entity set.
input	DeleteEntitySetInput!
disconnectEntitiesFromEntitySet	DisconnectEntitiesFromEntitySetPayload!	Mutation to disconnect multiple entities from an entity set.
id	ID!
input	DisconnectEntitiesFromEntitySetInput!
disconnectEntitySetsFromEntity	DisconnectEntitySetsFromEntityPayload!	Mutation to disconnect multiple entity sets from an entity.
id	ID!
input	DisconnectEntitySetsFromEntityInput!
updateEntitySet	UpdateEntitySetPayload!	Mutation to update an existing entity set.
id	ID!
input	UpdateEntitySetInput!
createEntityType	CreateEntityTypePayload!	Mutation to create a new entity type in the system.
input	CreateEntityTypeInput!
deleteEntityType	DeleteEntityTypePayload!	Mutation to delete an existing entity type.
input	DeleteEntityTypeInput!
updateEntityType	UpdateEntityTypePayload!	Mutation to update an existing entity type.
id	ID!
input	UpdateEntityTypeInput!
createGroupStructure	CreateGroupStructurePayload!	Mutation to create group structure.
input	CreateGroupStructureInput!
createIndividual	CreateIndividualPayload!	Mutation to create a new individual entity in the system.
input	CreateIndividualInput!
deleteIndividual	DeleteIndividualPayload!	Mutation to delete an existing individual.
input	DeleteIndividualInput!
updateIndividual	UpdateIndividualPayload!	Mutation to update an existing individual.
id	ID!
input	UpdateIndividualInput!
createNationality	CreateNationalityPayload!	Mutation to create a new nationality in the system.
input	CreateNationalityInput!
deleteNationality	DeleteNationalityPayload!	Mutation to delete an existing nationality.
input	DeleteNationalityInput!
updateNationality	UpdateNationalityPayload!	Mutation to update an existing nationality.
id	ID!
input	UpdateNationalityInput!
createOtherEntity	CreateOtherEntityPayload!	Mutation to create a new entity other than a company (e.g., an individual).
input	CreateOtherEntityInput!
deleteOtherEntity	DeleteOtherEntityPayload!	Mutation to delete an existing entity other than a company.
input	DeleteOtherEntityInput!
updateOtherEntity	UpdateOtherEntityPayload!	Mutation to update the details of an existing entity other than a company.
input	UpdateOtherEntityInput!
id	ID!
createPartner	CreatePartnerPayload!	Mutation to create a new partner entity in the system.
input	CreatePartnerInput!
deletePartner	DeletePartnerPayload!	Mutation to delete an existing partner.
input	DeletePartnerInput!
updatePartner	UpdatePartnerPayload!	Mutation to update an existing partner.
id	ID!
input	UpdatePartnerInput!
actionPendingEvent	ActionPendingEventPayload!	Performs an action on a pending event (e.g., schedule, cancel).
input	ActionPendingEventInput!
deletePendingEvent	DeletePendingEventPayload!	Mutation to delete an existing pending event.
input	DeletePendingEventInput!
deletePendingEventBatchItem	DeletePendingEventBatchItemPayload!
input	DeletePendingEventBatchItemInput!
updatePersonOptions	UpdatePersonOptionsPayload!	Mutation to update person-related options.
id	ID!
input	UpdatePersonOptionsInput!
createPendingShareClass	CreatePendingShareClassPayload!	Creates a new pending share class record for a company.
input	CreatePendingShareClassInput!
createSubCountry	CreateSubCountryPayload!	Mutation to create a new sub-country (e.g., state or province) in the system.
input	CreateSubCountryInput!
deleteSubCountry	DeleteSubCountryPayload!	Mutation to delete an existing sub-country.
input	DeleteSubCountryInput!
updateSubCountry	UpdateSubCountryPayload!	Mutation to update an existing sub-country.
id	ID!
input	UpdateSubCountryInput!
createUserGrouping	CreateUserGroupingPayload!	Mutation to create a new user grouping.
input	CreateUserGroupingInput!
deleteUserGrouping	DeleteUserGroupingPayload!	Mutation to delete an existing user grouping.
input	DeleteUserGroupingInput!
updateUserGrouping	UpdateUserGroupingPayload!	Mutation to update an existing user grouping.
id	ID!
input	UpdateUserGroupingInput!
createUser	CreateUserPayload!	Mutation to create user.
input	CreateUserInput!
deleteUser	DeleteUserPayload!	Mutation to delete user.
input	DeleteUserInput!
updateUser	UpdateUserPayload!	Mutation to update user.
id	ID!
input	UpdateUserInput!

Objects

ActionPendingEventPayload

The payload returned after actioning a pending event, containing result data and any errors.

Field	Argument	Type	Description
pendingEventStatus		PendingEventStatus	The status of the pending event after the action.
errors		[ActionPendingEventError!]	Any errors encountered while actioning the pending event.

Address

Represents a specific address.

Field	Type	Description
country	Country	Country associated with the address.
subCountry	SubCountry	Sub-country associated with the address.
id	ID!	The unique identifier for the address.
createdAt	DateTime	Represents the timestamp indicating when the address record was created.
reference	String	Reference identifier for the address.
street1	String	First line of the address.
street2	String	Second line of the address.
street3	String	Third line of the address.
postTown	String	Post town of the address.
area	String	Represents the geographic area associated with the address.
postalCode	String	Postal code of the address.
composite	String	Composite key or identifier for the address.
formatted	String	Formatted version of the address.
latitude	String	Latitude coordinate of the address.
longitude	String	Longitude coordinate of the address.
isShared	Boolean!	Indicates if the address is shared among multiple entities.

AddressEntry

Represents list of addresses.

Field	Type	Description
address	Address	Represents the actual address.
addressType	AddressType	Represents the type of an address.
isDefault	Boolean!	Indicates whether this address mapping is the default address for the entity and address type.

AddressType

Represents a type of address.

Field	Type	Description
id	ID!	Represents the unique identifier for the address type.
reference	String!	Represents the reference code for the address type.
name	String!	Represents the name of the address type.
systemPredefined	Boolean	Boolean flag indicating if the address type is predefined in the system.
isHeading	Boolean	Boolean flag indicating if the address type is a heading.
noRecordHeld	String	The following text is inserted into the past address details if there is a gap between the cessation of one address, and the start of another address.

AddressTypesCollectionSegment

Represents a collection segment for address types.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the address types collection.
items	[AddressType!]	Contains the list of address types within the segment.
totalCount	Int!	Represents the total count of address types in the segment.

AddressesCollectionSegment

Represents a collection segment of addresses.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for addresses.
items	[Address!]	Contains the items of the addresses collection segment.
totalCount	Int!	Indicates the total count of addresses in the segment.

Appointment

Represents a specific appointment.

Field	Type	Description
appointmentGroup	AppointmentGroup	The group associated with the appointment.
appointmentStatus	AppointmentStatus	The status of the appointment.
appointmentType	AppointmentType	The quick reference for the appointment type.
occupation	Occupation	Specifies the occupation associated with the appointment.
auditUser	User	The audit user for the appointment.
eventType	EventType	The event type associated with the appointment.
otherEvent	Appointment	Represents a related or follow-up event linked to the current appointment.
appointedTo	Entity	The quick reference for the entity appointed to.
appointee	Entity	The quick reference for the appointee.
alternateAppointee	Entity	The quick reference for the alternate appointee.
id	ID!	The unique identifier for the appointment.
auditDate	DateTime	The audit date for the appointment.
eventId	Int!	The event identifier associated with the appointment.
eventDate	DateTime	The event date associated with the appointment.
otherEventDate	DateTime	The date for another event related to the appointment.
level	Int	The level of the appointment.
isNotAttendee	Boolean!	Boolean flag indicating whether the individual is not an attendee of the appointment.
reminder	DateTime	The reminder settings for the appointment.
isActive	Boolean!	Represents if an appointment is active or not.
isOnStatutoryRegisters	Boolean	Boolean indicating whether the appointment appears on statutory registers.
notes	String	Any additional notes or annotations related to the appointment.

AppointmentCategoriesCollectionSegment

Represents a collection segment for appointment categories.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the appointment categories collection.
items	[AppointmentCategory!]	Contains the list of appointment categories within the segment.
totalCount	Int!	Represents the total count of appointment categories in the segment.

AppointmentCategory

Represents a category associated with an appointment.

Field	Type	Description
entityType	EntityType	Defines the entity type associated with the appointment category.
id	ID!	The unique identifier for the appointment category.
reference	String!	The reference identifier for the appointment category.
priority	Int	The priority level of the appointment category.
name	String	The name of the appointment category.

AppointmentGroup

Represents a group of appointments with common attributes.

Field	Type	Description
id	ID!	Filters appointment groups by their unique identifier.
priority	Int	Filters appointment groups by their assigned priority.
reference	String!	Filters appointment groups by their reference identifier.
name	String	Filters appointment groups by their name.

AppointmentGroupsCollectionSegment

Represents a collection segment of appointment groups.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for appointment groups.
items	[AppointmentGroup!]	Contains the items of the appointment groups collection segment.
totalCount	Int!	Indicates the total count of appointment groups in the segment.

AppointmentStatus

Represents the status of an appointment within the system.

Field	Type	Description
entityType	EntityType	Indicates the type of entity associated with the appointment status.
id	ID!	The unique identifier for an appointment status.
priority	Int	Defines the priority of the appointment status.
reference	String!	The reference identifier for the appointment status.
name	String	The name associated with the appointment status.

AppointmentStatusesCollectionSegment

Represents a collection segment of appointment statuses.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for appointment statuses.
items	[AppointmentStatus!]	Contains the items of the appointment statuses collection segment.
totalCount	Int!	Indicates the total count of appointment statuses in the segment.

AppointmentType

Represents the type of an appointment within the system.

Field	Type	Description
appointmentCategory	AppointmentCategory	Represents the appointment category associated with an appointment type.
entityType	EntityType	Defines the entity type associated with the appointment type.
id	ID!	The unique identifier for an appointment type.
priority	Int	Defines the priority of the appointment type.
reference	String!	The reference identifier for the appointment type.
name	String	The name associated with the appointment type.
isChairman	Boolean	Indicates if the appointment type is for a chairman role.
isDirector	Boolean	Indicates if the appointment type is for a director role.
isSecretary	Boolean	Indicates if the appointment type is for a secretary role.
isManager	Boolean	Indicates if the appointment type is for a manager role.
isNonStatutory	Boolean	Indicates if the appointment type is non-statutory.
isAlternate	Boolean	Indicates if the appointment type is an alternate role.
isSignatoryOnly	Boolean	Indicates if the appointment type is signatory-only.
updateExternalAppointments	Boolean	Determines if external appointments are updated for this type.
updateInterestsInShares	Boolean	Determines if share interests are updated for this type.
isOccupationTitleEnabled	Boolean	Indicates if occupation titles are enabled for this type.
isNotInCountryCodes	Boolean	Excludes appointment types for specific country codes.
countryCodes	[String!]!	Specifies the country codes associated with the appointment type.
isNotInCompanyTypes	Boolean	Excludes appointment types for specific company types.
companyTypes	[String!]!	Specifies the company types associated with the appointment type.
electronicFilingUKDesignation	Int	Designation used for UK electronic filing.
isHidden	Boolean	Indicates if the appointment type is hidden.

AppointmentTypesCollectionSegment

Represents a collection segment of appointment types.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for appointment types.
items	[AppointmentType!]	Contains the items of the appointment types collection segment.
totalCount	Int!	Indicates the total count of appointment types in the segment.

AppointmentsCollectionSegment

Represents a collection segment of appointments.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for appointments.
items	[Appointment!]	Contains the items of the appointments collection segment.
totalCount	Int!	Indicates the total count of appointments in the segment.

AuditTrail

Represents a record of system activity for auditing purposes.

Field	Type	Description
user	User	The user who performed the action recorded in the audit trail.
entity	Entity	The entity associated with the audit trail entry.
otherEntity	Entity	An additional entity linked to the audit trail entry, if applicable.
eventType	EventType	The type of event recorded in the audit trail.
id	ID!	The unique identifier for the audit trail record.
auditDate	DateTime	The date the audit trail entry was created.
eventDate	DateTime	The date of the event recorded in the audit trail.
notes	String	Additional notes or comments related to the audit trail entry.

AuditTrailsCollectionSegment

Represents a paginated collection of audit trails.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the audit trails collection.
items	[AuditTrail]	The list of audit trails in the current page of the collection.
totalCount	Int!	The total number of audit trails in the collection.

CollectionSegmentInfo

Represents segment information for collections.

Field	Argument	Type	Description
hasNextPage		Boolean!	Indicates if the collection segment has a next page.
hasPreviousPage		Boolean!	Indicates if the collection segment has a previous page.

CompaniesCollectionSegment

Represents a collection segment of companies.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for companies.
items	[Company]	Contains the items of the companies collection segment.
totalCount	Int!	Indicates the total count of companies in the segment.

Company

Represents a company entity in the system.

Field	Type	Description
companyOptions	CompanyOptions	Configuration and operational options for the company.
companyStatus	CompanyStatus	The current status of the company (e.g., Active, Dissolved).
companyType	CompanyType	The type or classification of the company.
currency	Currency	The currency associated with the company.
pendingEvent	PendingEvent
industrialClassification1	IndustrialClassification	The first industrial classification code for the company.
industrialClassification2	IndustrialClassification	The second industrial classification code for the company.
industrialClassification3	IndustrialClassification	The third industrial classification code for the company.
industrialClassification4	IndustrialClassification	The fourth industrial classification code for the company.
addresses	[AddressEntry!]	The list of address containing address type and actual address.
pastAddresses	[PastAddressEntry!]	The collection of past addresses associated with the company.
country	Country	The country in which the company is registered.
entityBatches	[EntityBatch!]!	The entity batches that include this company.
entitySecurityGroups	[EntitySecurityGroup!]!	The security groups that control access to the company.
entitySets	[EntitySet!]	The entity sets that include this company.
entityType	EntityType	The type or classification of the company as an entity.
partner	Partner	The partner associated with the company.
personOptions	PersonOptions	Person-related options for the company.
subCountry	SubCountry	The sub-country (e.g., state or province) where the company is located.
managedBy	User	The user or entity that manages the company.
userGrouping	UserGrouping	Represents the user grouping associated with a company entity.
isHistoricalRecord	Boolean	Indicates if the company record is historical.
updatedAt	DateTime	Indicates the last update timestamp for a company.
companyNumber	String	The official registration number of the company.
incorporationDate	LocalDate	The date when the company was incorporated.
dissolvedDate	LocalDate	The date when the company was dissolved.
lastAccountingPeriodEndDate	LocalDate	The end date of the company's last accounting period.
currentAccountingPeriodEndDate	LocalDate	The end date of the company's current accounting period.
lastAccountingPeriodExtendedDate	LocalDate	The extended end date of the last accounting period, if applicable.
industrialClassificationOther	String	Any additional industrial classifications applicable to the company.
lastAccountsDate	LocalDate	The date of the last filed accounts.
accountsSignedDate	LocalDate	The date when the accounts were signed.
accountsFiledDate	LocalDate	The date when the accounts were filed.
isAccountsFiledOverridden	Boolean	Indicates if the accounts filing status was overridden.
accountsInReviewDate	LocalDate	The date when the accounts were under review.
nextAccountsDate	LocalDate	The date of the next scheduled accounts filing.
accountsOverdueDate	LocalDate	The date when the accounts became overdue.
isAccountsOverdueOverridden	Boolean	Indicates if the accounts overdue status was overridden.
hasAccountsOverseasExtension	Boolean	Indicates if the company has an overseas extension for filing accounts.
lastMembersScheduleDate	LocalDate	The date when the last members' schedule was filed.
lastAnnualReturnDate	LocalDate	The date when the last annual return was filed.
annualReturnSignedDate	LocalDate	The date when the annual return was signed.
annualReturnFiledDate	LocalDate	The date when the annual return was filed.
nextAnnualReturnDate	LocalDate	The date of the next scheduled annual return.
isNextAnnualReturnDateAutomatic	Boolean	Indicates if the next annual return date is set automatically.
annualReturnOverdueDate	LocalDate	The date when the annual return became overdue.
isMembersScheduleAsRequired	Boolean	Indicates if the members' schedule is filed as required by law.
isMembersScheduleNotOnPaper	Boolean	Indicates if the members' schedule is filed electronically and not on paper.
lastAnnualMeetingDate	LocalDate	The date when the last annual general meeting was held.
annualMeetingMinutesSignedDate	LocalDate	The date when the minutes of the annual meeting were signed.
nextAnnualMeetingDate	LocalDate	The date of the next scheduled annual general meeting.
isNextAnnualMeetingDateAutomatic	Boolean	Indicates if the next annual meeting date is set automatically.
annualMeetingOverdueDate	LocalDate	The date when the annual meeting became overdue.
lastMeetingApproveAccountsDate	LocalDate	The date of the last meeting to approve the accounts.
meetingApproveAccountsMinutesSignedDate	LocalDate	The date when the minutes of the meeting to approve accounts were signed.
financialPeriodFromDate	LocalDate	The start date of the company's financial period.
financialPeriodToDate	LocalDate	The end date of the company's financial period.
isFinancialPeriodAutomatic	Boolean	Indicates if the financial period is set automatically.
becameSingleMemberCompanyOnDate	LocalDate	The date when the company became a single-member company.
registeredEmailAddress	String	The registered email address of the company.
documentReference	String	A reference to documents associated with the company.
isLive	Boolean	Indicates if the company is currently active or live.
hasDormantCompanyResolution	Boolean	Indicates whether the company has passed a dormant company resolution.
dormantCompanyResolutionPassedOn	LocalDate	The date the dormant company resolution was passed.
hasStandardDormantAccounts	Boolean	Indicates whether the company uses standard dormant accounts.
fileReference	String	The file reference associated with the company record.
id	ID!	The unique identifier for the company.
referenceType	EntityTypeCategory!	A quick reference type associated with the company.
entityReference	String	A reference code or identifier for the company entity.
entityName	String	The name of the company entity.
udfs	[UdfValue]	User-defined fields associated with the company record.
names	[String!]!

CompanyOptions

Configuration options for a company in the system.

Field	Type	Description
systemDefaultRegisterSettings	Boolean!	Default register settings applied by the system.
separateRegistersForDirectorsSecretaries	Boolean!	Indicates if there are separate registers for directors and secretaries.
registersListByName	Boolean!	Lists registers by name.
provideSpaceOnRegisterForManualEntries	Boolean!	Provides space for manual entries on registers.
lastUpdateAuditId	Int	ID of the last update audit.
lastUpdatedDate	LocalDate	The date when the company options were last updated.
globalDocumentReferenceFormat	Boolean!	Represents the global format used to construct document references across the company.
defaultDocumentReferenceFormat	Boolean!	Represents the default document reference format used if no global format is defined.
documentFormatSeparator	DocumentReferenceSeparator	Defines the character or symbol used to separate document reference segments.
documentFormatSegment1	DocumentReferenceSegment	Represents the first configurable segment of the document reference format.
documentFormatSegment2	DocumentReferenceSegment	Represents the second configurable segment of the document reference format.
documentFormatSegment3	DocumentReferenceSegment	Represents the third configurable segment of the document reference format.

CompanyStatus

Represents the current status of a company (e.g., active, inactive).

Field	Type	Description
entityType	EntityType	The entity type associated with the company status.
id	ID!	The unique identifier of the company status.
priority	Int!	The priority assigned to the company status.
reference	String!	A reference field for categorizing or linking the company status.
name	String	The name of the company status.

CompanyStatusesCollectionSegment

Represents a collection segment of company statuses.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for company statuses.
items	[CompanyStatus!]	Contains the items of the company statuses collection segment.
totalCount	Int!	Indicates the total count of company statuses in the segment.

CompanyType

Represents the type of a company, including its structure, obligations, and legal characteristics.

Field	Type	Description
entityType	EntityType	The type of entity associated with the company type.
id	ID!	The unique identifier of the company type.
priority	Int!	The priority level assigned to the company type.
reference	String!	A reference field used for internal linking or categorization.
name	String!	The name of the company type.
isNotInCountries	Boolean	Indicates whether this company type is excluded from certain country codes.
countryIds	[ID!]	The list of country codes where this company type is applicable.
isHidden	Boolean	A flag indicating whether this company type is hidden from users.

CompanyTypesCollectionSegment

Represents a collection segment of company types.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for company types.
items	[CompanyType!]	Contains the items of the company types collection segment.
totalCount	Int!	Indicates the total count of company types in the segment.

ConnectAddressToEntityPayload

Payload returned for connect address to entity operations.

Field	Argument	Type	Description
addressEntry		AddressEntry	The address entry included in the response payload.
errors		[ConnectAddressToEntityError!]	The errors included in the response payload.

ConnectEntitiesToEntityBatchPayload

The payload returned after connecting entities to an entity batch, containing details of the entity batch and any errors.

Field	Argument	Type	Description
entityBatch		EntityBatch	The entity batch object to which entities were connected.
errors		[ConnectEntitiesToEntityBatchError!]	Any errors encountered during the connection of entities to the entity batch.

ConnectEntitiesToEntitySecurityGroupPayload

The payload returned after updating an entity set, containing details of the updated entity set and any errors.

Field	Argument	Type	Description
entitySecurityGroup		EntitySecurityGroup	The entity set that was updated.
errors		[ConnectEntitiesToEntitySecurityGroupError!]	Any errors encountered during the update of the entity set.

ConnectEntitiesToEntitySetPayload

The payload returned after connecting entities to an entity set, containing details of the entity set and any errors.

Field	Argument	Type	Description
entitySet		EntitySet	The entity set to which the entities were connected.
errors		[ConnectEntitiesToEntitySetError!]	Any errors encountered during the connection of entities to the entity set.

ConnectEntityBatchesToEntityPayload

The payload returned after connecting entity batches to an entity, containing details of the entity and any errors.

Field	Argument	Type	Description
entity		Entity	The entity to which batches were connected.
errors		[ConnectEntityBatchesToEntityError!]	Any errors encountered during the connection of entity batches to the entity.

ConnectEntitySecurityGroupsToEntityPayload

The payload returned after connecting entities to a security group, containing details of the security group and any errors.

Field	Argument	Type	Description
entity		Entity	The security group to which entities were connected.
errors		[ConnectEntitySecurityGroupsToEntityError!]	Any errors encountered during the connection of entities to the security group.

ConnectEntitySetsToEntityPayload

The payload returned after connecting entities to an entity set, containing details of the entity set and any errors.

Field	Argument	Type	Description
entity		Entity	The entity set to which the entities were connected.
errors		[ConnectEntitySetsToEntityError!]	Any errors encountered during the connection of entities to the entity set.

ConnectEntityTypeToAddressTypePayload

The payload returned after connecting an entity type to an address type, containing result data and any errors.

Field	Argument	Type	Description
addressType		AddressType	The address type connected to the entity type.
errors		[ConnectEntityTypeToAddressTypeError!]	Any errors encountered during the connection of an entity type to an address type.

CorporateRelationship

Represents a relationship between two corporate entities.

Field	Type	Description
corporateStructure	CorporateStructure	Corporate structure to which the corporate relationship applies (for example, legal structure, voting structure etc.).
childEntity	Entity	The destination entity of the corporate relationship.
fromEntity	Entity	The origin entity of the corporate relationship.
id	ID!	Unique identified of the corporate relationship.
description	String!	Description of the corporate relationship.
fromRelationship	String!	The name/type of the relationship from the origin entity's perspective.
toRelationship	String!	The name/type of the relationship from the destination entity's perspective.
control	Decimal!	Percentage of control the origin entity has over the destination entity in a corporate relationship.
controlBy	CorporateRelationshipControlBy!	Type of control in a corporate relationship (ownership, voting or other).
fromDate	DateTime	Start date of the corporate relationship's validity.
toDate	DateTime	End date of the corporate relationship's validity.
priority	CorporateRelationshipPriority!	Priority of the corporate relationship.

CorporateRelationshipsCollectionSegment

Represents a paginated collection of corporate relationships.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the corporate relationships collection.
items	[CorporateRelationship!]	The list of corporate relationships in the current page of the collection.
totalCount	Int!	The total number of corporate relationships in the collection.

CorporateStructure

Represents the structure of a corporation.

Field	Type	Description
id	ID!	Unique identifyer of the corporate structure.
priority	Int!	Defines the priority level assigned to the corporate structure.
reference	String!	A reference code used to identify the corporate structure.
name	String	The name or label of the corporate structure.

CorporateStructuresCollectionSegment

Represents a paginated collection of corporate structures.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the corporate structures collection.
items	[CorporateStructure!]	The list of corporate structures in the current page of the collection.
totalCount	Int!	The total number of corporate structures in the collection.

CountriesCollectionSegment

Represents a collection segment of countries.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for countries.
items	[Country!]	Contains the items of the countries collection segment.
totalCount	Int!	Indicates the total count of countries in the segment.

Country

Represents a country, including its associated metadata like codes and currency.

Field	Type	Description
currency	Currency	Specifies the currency associated with a country.
id	ID!	The unique identifier of the country.
countryCode	String	The two-letter ISO code for the country.
name	String	The full name of the country.
countryCode3	String	The three-letter ISO code for the country.
documentCountry	String	Indicates whether this country is considered a document country.
iso3166Description	String	A description of the country's ISO 3166 status.
isEEA	Boolean!	Indicates whether the country is part of the European Economic Area.
isUSA	Boolean!	Indicates whether the country is the United States of America.

CreateAddressPayload

The payload returned after creating an address, containing the created address and any errors.

Field	Argument	Type	Description
address		Address	The address returned by the create address operation.
errors		[CreateAddressError!]	Any errors encountered during the address creation.

CreateAddressTypePayload

The payload returned after creating an address type, containing the address type and any errors.

Field	Argument	Type	Description
addressType		AddressType	The address type created by the operation.
errors		[CreateAddressTypeError!]	Any errors encountered during the address type creation.

CreateCompanyPayload

The payload returned after a company creation operation, containing details of the company and any errors.

Field	Argument	Type	Description
company		Company	The company object created.
errors		[CreateCompanyError!]	Any errors encountered during the company creation.

CreateCompanyStatusPayload

The payload returned after creating a company status, containing details of the company status and any errors.

Field	Argument	Type	Description
companyStatus		CompanyStatus	The company status object that was created.
errors		[CreateCompanyStatusError!]	Any errors encountered during the company status creation.

CreateCompanyTypePayload

The payload returned after creating a company type, containing details of the company type and any errors.

Field	Argument	Type	Description
companyType		CompanyType	The company type object that was created.
errors		[CreateCompanyTypeError!]	Any errors encountered during the company type creation.

CreateDataLibraryPayload

The payload returned after creating a data library record, containing the record and any errors.

Field	Argument	Type	Description
dataLibrary		DataLibrary	The data library record that was created.
errors		[CreateDataLibraryError!]	Any errors encountered during the data library creation.

CreateEntityBatchPayload

The payload returned after creating an entity batch, containing details of the entity batch and any errors.

Field	Argument	Type	Description
entityBatch		EntityBatch	The entity batch object that was created.
errors		[CreateEntityBatchError!]	Any errors encountered during the creation of the entity batch.

CreateEntityIdentificationPayload

The response payload returned after creating a new entity identification record.

Field	Argument	Type	Description
entityIdentification		EntityIdentification	Contains the newly created entity identification details.
errors		[CreateEntityIdentificationError!]	Any errors returned while creating the entity identification.

CreateEntitySecurityGroupPayload

The payload returned after connecting security groups to an entity, containing details of the entity and any errors.

Field	Argument	Type	Description
entitySecurityGroup		EntitySecurityGroup	The entity to which the security groups were connected.
errors		[CreateEntitySecurityGroupError!]	Any errors encountered during the connection of security groups to the entity.

CreateEntitySetPayload

The payload returned after connecting entity sets to an entity, containing details of the entity and any errors.

Field	Argument	Type	Description
entitySet		EntitySet	The entity to which the sets were connected.
errors		[CreateEntitySetError!]	Any errors encountered during the connection of entity sets to the entity.

CreateEntityTypePayload

The payload returned after creating an entity type, containing details of the entity type and any errors.

Field	Argument	Type	Description
entityType		EntityType	The entity type object that
errors		[CreateEntityTypeError!]	Any errors encountered during the creation of an entity type.

CreateGroupStructurePayload

Payload returned for create group structure operations.

Field	Argument	Type	Description
job		Job	The job included in the response payload.
errors		[CreateGroupStructureError!]	The errors included in the response payload.

CreateIndividualPayload

The payload returned after creating an individual, containing details of the individual and any errors.

Field	Argument	Type	Description
individual		Individual	The individual object that was created.
errors		[CreateIndividualError!]	Any errors encountered during the creation of the individual.

CreateNationalityPayload

The payload returned after creating a nationality, containing details of the nationality and any errors.

Field	Argument	Type	Description
nationality		Nationality	The nationality object that was created.
errors		[CreateNationalityError!]	Any errors encountered during the nationality creation.

CreateOtherEntityPayload

The payload returned after creating another type of entity, containing details of the entity and any errors.

Field	Argument	Type	Description
otherEntity		OtherEntity	The other entity object that was created.
errors		[CreateOtherEntityError!]	Any errors encountered during the creation of the other entity.

CreatePartnerPayload

The payload returned after creating a partner, containing details of the partner and any errors.

Field	Argument	Type	Description
partner		Partner	The partner object that was created.
errors		[CreatePartnerError!]	Any errors encountered during the creation of the partner.

CreatePendingAppointmentPayload

The payload returned after creating a pending appointment, containing the resulting records and any errors.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event returned by the create pending appointment operation.
errors		[CreatePendingAppointmentError!]	Any errors encountered during the pending appointment creation.

CreatePendingChangeJobTitlePayload

Payload returned for create pending change job title operations.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[CreatePendingChangeJobTitleError!]	The errors included in the response payload.

CreatePendingDeathPayload

Payload returned for create pending death operations.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[CreatePendingDeathError!]	The errors included in the response payload.

CreatePendingRemovalPayload

Payload returned for create pending removal operations.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[CreatePendingRemovalError!]	The errors included in the response payload.

CreatePendingReplacementPayload

The payload returned after creating a pending replacement, containing the resulting records and any errors.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event returned by the create pending replacement operation.
errors		[CreatePendingReplacementError!]	Any errors encountered during the pending replacement creation.

CreatePendingResignationPayload

The payload returned after creating a pending resignation, containing the resulting records and any errors.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event returned by the create pending resignation operation.
errors		[CreatePendingResignationError!]	Any errors encountered during the pending resignation creation.

CreatePendingShareClassPayload

The payload returned after creating a pending share class, containing the resulting records and any errors.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event returned by the create pending share class operation.
errors		[CreatePendingShareClassError!]	Any errors encountered during the pending share class creation.

CreateSubCountryPayload

The payload returned after creating a sub-country, containing details of the sub-country and any errors.

Field	Argument	Type	Description
subCountry		SubCountry	The sub-country object that was created.
errors		[CreateSubCountryError!]	Any errors encountered during the creation of the sub-country.

CreateUserGroupingPayload

The payload returned after creating a user grouping, containing details of the user grouping and any errors.

Field	Argument	Type	Description
userGrouping		UserGrouping	The user grouping object that was created.
errors		[CreateUserGroupingError!]	Any errors encountered during the creation of the user grouping.

CreateUserPayload

Payload returned for create user operations.

Field	Argument	Type	Description
user		User	The user included in the response payload.
errors		[CreateUserError!]	The errors included in the response payload.

CurrenciesCollectionSegment

Represents a collection segment of currencies.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for currencies.
items	[Currency!]	Contains the items of the currencies collection segment.
totalCount	Int!	Indicates the total count of currencies in the segment.

Currency

Represents a currency used by a country or entity.

Field	Type	Description
country	Country	Defines the country associated with a currency.
id	ID!	The unique identifier for the currency.
reference	String!	A reference code or value for the currency.
currencyCode	String	The official three-letter currency code (e.g., USD, EUR).
name	String	The full name of the currency (e.g., US Dollar).
prefix	String	The symbol or prefix used for the currency (e.g., $).
suffix	String	A suffix used for the currency, if applicable.
thousandSeparator	String	The symbol used to separate thousands in currency formatting.
decimalSeparator	String	The symbol used to separate decimals in currency formatting.
numberOfDecimalPoints	Int!	The number of decimal points used in currency formatting.

CurrentUser

Represents the currently authenticated user.

Field	Type	Description
country	Country	Represents country for current user.
subCountry	SubCountry	Represents sub country for current user.
entityRights	[String!]!	Access rights for the current user scoped to the specified entity, resolved from the user role and entity security groups.
entityId	ID!
id	ID!	The unique identifier of the current user.
reference	String	The reference code of the current user.
name	String	The display name of the current user.
loginEmail	String	Represents login email for current user.
rights	[String!]!	The set of rights or permissions assigned to the current user.
lastSuccessfulLoginAt	DateTime	The timestamp of the current user's most recent successful login.
networkId	String	Represents network id for current user.
dateFormat	UserDateFormat	Represents date format for current user.
numberFormat	UserNumberFormat	Represents number format for current user.
isDisabled	Boolean	Indicates whether the user account is disabled.
isHidden	Boolean	Indicates whether the user account is hidden.
showHistoricalRecordsByDefault	Boolean	Represents show historical records by default for current user.

DataLibrariesCollectionSegment

Represents a paginated collection of data libraries.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the data libraries collection.
items	[DataLibrary!]	The list of data libraries in the current page of the collection.
totalCount	Int!	The total number of data libraries in the collection.

DataLibrary

Represents a Data Library record containing structured or unstructured data.

Field	Type	Description
type	DataLibraryType	The type of Data Library record (e.g., structured, unstructured).
entity	Entity	The entity associated with the Data Library record.
status	DataLibraryStatus	The current status of the Data Library record.
country	Country	The country associated with the Data Library record.
subCountry	SubCountry	The sub-country (e.g., state or province) associated with the Data Library record.
auditUser	User	The user who last audited or modified the Data Library record.
assignedTo	User	The user or team assigned to manage the Data Library record.
signedBy	User	The user or entity who signed the Data Library record.
parent	DataLibrary	Represents parent for data library.
udfs	[UdfValue!]!	The user-defined fields (UDFs) associated with the Data Library record.
id	ID!	The unique identifier for the Data Library record.
priority	Int!	The priority level assigned to the Data Library record.
reference	Int!	The reference code associated with the Data Library record.
changedAt	DateTime	The date and time when the Data Library record was last modified.
auditDate	DateTime	The date when the Data Library record was last audited.
dateFrom	DateTime	Represents date from for data library.
dateTo	DateTime	The end date or validity expiration of the Data Library record.
reminderDate	DateTime	The date on which a reminder is scheduled for the Data Library record.
expiryDate	DateTime	The expiration date of the Data Library record.
description	String!	A description of the Data Library record and its contents.
notes	String!	Additional notes or comments related to the Data Library record.
physicalLocation	String!	The physical location where the Data Library record is stored.
electronicLocation	String!	The electronic location or URL of the Data Library record.
signedOn	DateTime	The date the Data Library record was signed.
isPending	Boolean	Indicates whether the Data Library record is pending approval or action.
isHistorical	Boolean	Indicates whether the Data Library record is historical.
isLocked	Boolean	Indicates whether the Data Library record is locked from editing.
versionNumber	String!	The version number of the Data Library record.
recordAccessGroup	Int	The access group that governs visibility and permissions for the record.
isRolledOver	Boolean	Indicates whether the Data Library record has been rolled over to a new period.
rolledOverDate	DateTime	The date on which the Data Library record was rolled over.

DataLibraryCategoriesCollectionSegment

Represents a paginated collection of data library categories.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the data library categories collection.
items	[DataLibraryCategory!]	The list of data library categories in the current page of the collection.
totalCount	Int!	The total number of data library categories in the collection.

DataLibraryCategory

Display order of Data Library categories

Field	Type	Description
id	ID!	Data Library Category id
name	String	Data Library Category name
reference	String	Data Library Category quick reference code
priority	Int!	Priority of the data library category.
isHidden	Boolean	Boolean property indicating whether the data library category is hidden.

DataLibraryStatus

Represents the status of a data library.

Field	Type	Description
id	ID!	Data Library Status id
name	String	Data Library status (description) e.g. Completed, Pending
reference	String	Data Library Status quick reference code
priority	Int	Display order of Data Library status

DataLibraryStatusesCollectionSegment

Represents a paginated collection of data library statuses.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the data library statuses collection.
items	[DataLibraryStatus!]	The list of data library statuses in the current page of the collection.
totalCount	Int!	The total number of data library statuses in the collection.

DataLibraryType

Represents a type of data library.

Field	Type	Description
dataLibraryCategory	DataLibraryCategory	Category this Data Library type belongs to
id	ID!	Data Library type quick reference code
name	String	Data Library name/description (e.g. Bank Details, Contract)
reference	String	Data Library type quick reference code
priority	Int!	Display order of Data Library types
usageType	DataLibraryUsageType!	Specifies how the Data Library type is used (e.g., structured, unstructured).
systemPredefined	Boolean	System predefined Data Library type? (Y/N)
showStatus	Boolean	Enable Data Library type status? (Y/N)
allowedStatusIds	[ID!]	Represents allowed status ids for data library type.
rolloverStatus	String	Rollover status of the data library type.
allowPending	Boolean	Allow record to be saved as Pending? (Y/N)
isEntityRequired	Boolean	Must the Data Library record of this type be for an entity? (Y/N). If the entity's quickref is left blank, an error will be displayed when trying to save the record
entityTypeIds	[ID!]	The types of entity Data Library records of this type can be created for
allowConnected	Boolean	Allow records to be connected to this one? (Y/N)
allowOtherConnectedEntities	Boolean	Enable other connected entities? (Y/N)
allowAssignedTo	Boolean	Enable assigned to? (Y/N)
isNotInCountryCodes	Boolean	Exclude this Data Library type from the selected countries? (Y/N)
countryIds	[ID!]	Country this Data Library type applies to

DataLibraryTypesCollectionSegment

Represents a paginated collection of data library types.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the data library types collection.
items	[DataLibraryType!]	The list of data library types in the current page of the collection.
totalCount	Int!	The total number of data library types in the collection.

DataLibraryUdf

User-defined field of the data library type.

Field	Type	Description
dataLibraryType	DataLibraryType	The Data Library type this user-defined field relates to e.g. BANK
id	ID!	Unique record identifier (database generated)
priority	Int!	Order of fields within the Data Library type
reference	String!	Unique record identifier (database generated)
name	String!	user-defined field description
shortName	String!	user-defined field short description
storageLocation	StorageLocation!	Specifies where the UDF data is stored (e.g., database table or system-defined location).
dataType	DataType	Data type for the user-defined field where 0 = Text, 1= Number (Integer Whole number), 2= Number (with Decimal places), 3= Boolean (Y/N), 4= Date, 5= Memo, 6= Heading only (displayed on screen)
textLength	Int	Length of user-defined field (eg if text, number of characters user can input e.g. up to '50' characters etc.)
textFlags	[UdfTextFlag!]	Text flags of the data library user-defined field.
displayWidth	Int	Display width of the data library user-defined field.
helpText	String	Help text associated with the user-defined field
isNotInCountries	Boolean	Indicates whether the UDF is excluded from specific countries.
countryIds	[ID!]	Country this user-defined field applies to
isReadOnly	Boolean	Is user-defined field read-only? (Y/N)
entityTypeIds	[ID!]	The types of entity that the user-defined field is applicable to. This only applies to fields that belong to Data Library types and user-defined fields for all people
isSystemPredefined	Boolean	Indicates whether the UDF is predefined by the system and not user-editable.
isRequired	Boolean	Boolean field indicating whether the data library user-defined field is mandatory.

DataLibraryUdfsCollectionSegment

Represents a paginated collection of data library UDFs.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the data library UDFs collection.
items	[DataLibraryUdf!]	The list of data library UDFs in the current page of the collection.
totalCount	Int!	The total number of data library UDFs in the collection.

DefaultAddressPriority

Represents a priority setting for a given address type.

Field	Argument	Type	Description
id		ID!	The id of the address type.
priority		Int!	The priority of the address type.

DeleteAddressPayload

The payload returned after deleting an address, containing the deleted address and any errors.

Field	Argument	Type	Description
address		Address	The address object that was deleted.
errors		[DeleteAddressError!]	Any errors encountered during the address deletion.

DeleteAddressTypePayload

The payload returned after deleting an address type, containing the deleted address type and any errors.

Field	Argument	Type	Description
addressType		AddressType	The address type that was deleted.
errors		[DeleteAddressTypeError!]	Any errors encountered during the address type deletion.

DeleteCompanyPayload

The payload returned after a company deletion operation, containing details of the deleted company and any errors.

Field	Argument	Type	Description
company		Company	The company object that was deleted.
errors		[DeleteCompanyError!]	Any errors encountered during the company deletion.

DeleteCompanyStatusPayload

The payload returned after deleting a company status, containing details of the deleted status and any errors.

Field	Argument	Type	Description
companyStatus		CompanyStatus	The company status object that was deleted.
errors		[DeleteCompanyStatusError!]	Any errors encountered during the deletion of the company status.

DeleteCompanyTypePayload

The payload returned after deleting a company type, containing details of the deleted company type and any errors.

Field	Argument	Type	Description
companyType		CompanyType	The company type object that was deleted.
errors		[DeleteCompanyTypeError!]	Any errors encountered during the company type deletion.

DeleteDataLibraryPayload

The payload returned after deleting a data library record, containing the deleted record and any errors.

Field	Argument	Type	Description
dataLibrary		DataLibrary	The data library record that was deleted.
errors		[DeleteDataLibraryError!]	Any errors encountered during the data library deletion.

DeleteEntityBatchPayload

The payload returned after deleting an entity batch, containing details of the deleted entity batch and any errors.

Field	Argument	Type	Description
entityBatch		EntityBatch	The entity batch object that was deleted.
errors		[DeleteEntityBatchError!]	Any errors encountered during the deletion of the entity batch.

DeleteEntityIdentificationPayload

The response payload returned after an attempt to delete an entity identification record.

Field	Argument	Type	Description
entityIdentification		EntityIdentification	Contains the deleted identification data, if successful.
errors		[DeleteEntityIdentificationError!]	Any errors encountered during the delete operation.

DeleteEntitySecurityGroupPayload

The type name of the security group creation payload.

Field	Argument	Type	Description
entitySecurityGroup		EntitySecurityGroup	Any errors encountered during the creation of the entity security group.
errors		[DeleteEntitySecurityGroupError!]	Input type used for specifying the details required to delete a security group.

DeleteEntitySetPayload

The type name of the entity set creation payload.

Field	Argument	Type	Description
entitySet		EntitySet	Any errors encountered during the creation of the entity set.
errors		[DeleteEntitySetError!]	Input type used for specifying the details required to delete an entity set.

DeleteEntityTypePayload

The payload returned after deleting an entity type, containing details of the deleted entity type and any errors.

Field	Argument	Type	Description
entityType		EntityType	The entity type object that was deleted.
errors		[DeleteEntityTypeError!]	Any errors encountered during the deletion of the entity type.

DeleteIndividualPayload

The payload returned after deleting an individual, containing details of the deleted individual and any errors.

Field	Argument	Type	Description
individual		Individual	The individual object that was deleted.
errors		[DeleteIndividualError!]	Any errors encountered during the deletion of the individual.

DeleteNationalityPayload

The payload returned after deleting a nationality, containing details of the deleted nationality and any errors.

Field	Argument	Type	Description
nationality		Nationality	The nationality object that was deleted.
errors		[DeleteNationalityError!]	Any errors encountered during the deletion of the nationality.

DeleteOtherEntityPayload

The payload returned after deleting another type of entity, containing details of the deleted entity and any errors.

Field	Argument	Type	Description
otherEntity		OtherEntity	The other entity object that was deleted.
errors		[DeleteOtherEntityError!]	Any errors encountered during the deletion of the other entity.

DeletePartnerPayload

The payload returned after deleting a partner, containing details of the deleted partner and any errors.

Field	Argument	Type	Description
partner		Partner	The partner object that was deleted.
errors		[DeletePartnerError!]	Any errors encountered during the deletion of the partner.

DeletePendingEventBatchItemPayload

Field	Argument	Type	Description
pendingEvent		PendingEvent
errors		[DeletePendingEventBatchItemError!]

DeletePendingEventPayload

The payload returned after deleting a pending event, containing details of the deleted pending event and any errors.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[DeletePendingEventError!]	The errors included in the response payload.

DeleteSubCountryPayload

The payload returned after deleting a sub-country, containing details of the deleted sub-country and any errors.

Field	Argument	Type	Description
subCountry		SubCountry	The sub-country object that was deleted.
errors		[DeleteSubCountryError!]	Any errors encountered during the deletion of the sub-country.

DeleteUserGroupingPayload

The payload returned after deleting a user grouping, containing details of the deleted user grouping and any errors.

Field	Argument	Type	Description
userGrouping		UserGrouping	The user grouping object that was deleted.
errors		[DeleteUserGroupingError!]	Any errors encountered during the deletion of the user grouping.

DeleteUserPayload

Payload returned for delete user operations.

Field	Argument	Type	Description
user		User	The user included in the response payload.
errors		[DeleteUserError!]	The errors included in the response payload.

DisconnectAddressFromEntityPayload

Payload returned for disconnect address from entity operations.

Field	Argument	Type	Description
addressEntry		AddressEntry	The address entry included in the response payload.
errors		[DisconnectAddressFromEntityError!]	The errors included in the response payload.

DisconnectEntitiesFromEntityBatchPayload

The payload returned after disconnecting entities from an entity batch, containing details of the entity batch and any errors.

Field	Argument	Type	Description
entityBatch		EntityBatch	The entity batch from which entities were disconnected.
errors		[DisconnectEntitiesFromEntityBatchError!]	Any errors encountered during the disconnection of entities from the entity batch.

DisconnectEntitiesFromEntitySecurityGroupPayload

The payload returned after deleting an entity security group, containing details of the deleted group and any errors.

Field	Argument	Type	Description
entitySecurityGroup		EntitySecurityGroup	The entity security group that was deleted.
errors		[DisconnectEntitiesFromEntitySecurityGroupError!]	Any errors encountered during the deletion of the security group.

DisconnectEntitiesFromEntitySetPayload

The payload returned after deleting an entity set, containing details of the deleted entity set and any errors.

Field	Argument	Type	Description
entitySet		EntitySet	The entity set that was deleted.
errors		[DisconnectEntitiesFromEntitySetError!]	Any errors encountered during the deletion of the entity set.

DisconnectEntityBatchesFromEntityPayload

The payload returned after disconnecting entity batches from an entity, containing details of the entity and any errors.

Field	Argument	Type	Description
entity		Entity	The entity from which the batches were disconnected.
errors		[DisconnectEntityBatchesFromEntityError!]	Any errors encountered during the disconnection of entity batches from the entity.

DisconnectEntitySecurityGroupsFromEntityPayload

The payload returned after disconnecting entities from a security group, containing details of the security group and any errors.

Field	Argument	Type	Description
entity		Entity	The security group from which entities were disconnected.
errors		[DisconnectEntitySecurityGroupsFromEntityError!]	Any errors encountered during the disconnection of entities from the security group.

DisconnectEntitySetsFromEntityPayload

The payload returned after disconnecting entities from an entity set, containing details of the entity set and any errors.

Field	Argument	Type	Description
entity		Entity	The entity set from which the entities were disconnected.
errors		[DisconnectEntitySetsFromEntityError!]	Any errors encountered during the disconnection of entities from the entity set.

DisconnectEntityTypeFromAddressTypePayload

The payload returned after disconnecting an entity type from an address type, containing result data and any errors.

Field	Argument	Type	Description
addressType		AddressType	The address type affected by the disconnection.
errors		[DisconnectEntityTypeFromAddressTypeError!]	Any errors encountered during the disconnection of an entity type from an address type.

Document

Represents a document stored or managed within the system.

Field	Type	Description
documentLog	DocumentLog	Represents document log for document.
entity	Entity	The entity associated with the document.
modifiedBy	User	The user who last modified the document.
signedBy	Entity	Represents signed by for document.
signedAs	AppointmentType	Represents signed as for document.
id	ID!	The unique identifier for the document.
fileName	String!	The name of the file associated with the document.
reference	Int!	The reference code for the document.
documentType	String!	The type of document (e.g., form, report, certificate).
status	DocumentStatus!	The current status of the document (e.g., Draft, Final, Archived).
createdAt	DateTime	The date and time when the document was created.
documentDate	DateTime	The date associated with the document content.
signedAt	DateTime	Represents signed at for document.

DocumentLog

Represents document log.

Field	Type	Description
user	User	Represents user for document log.
viewedAt	DateTime	Represents viewed at for document log.
createdAt	DateTime	Represents created at for document log.
completedAt	DateTime	Represents completed at for document log.
status	DocumentLogStatus!	Represents status for document log.

DocumentsCollectionSegment

Represents a paginated collection of documents.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the documents collection.
items	[Document!]	The list of documents in the current page of the collection.
totalCount	Int!	The total number of documents in the collection.

EntitiesCollectionSegment

Represents a collection segment of entities.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for entities.
items	[Entity]	Contains the items of the entities collection segment.
totalCount	Int!	Indicates the total count of entities in the segment.

EntityBatch

Represents a batch of entities grouped together for a specific purpose.

Field	Type	Description
entities	EntitiesCollectionSegment	The entities included in this batch.
skip	Int
take	Int
batchUser	User	The user associated with the batch.
id	ID!	The unique identifier for the entity batch.
priority	Int!	The priority level assigned to the entity batch.
reference	String!	A reference code or value for the entity batch.
name	String!	The name of the entity batch.

EntityBatchesCollectionSegment

Represents a collection segment of entity batches.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for entity batches.
items	[EntityBatch!]	Contains the items of the entity batches collection segment.
totalCount	Int!	Indicates the total count of entity batches in the segment.

EntityIdentification

Represents an identification assigned to an entity (e.g., registration number, VAT number).

Field	Type	Description
id	ID!	Unique identifier of the entity identification record.
entityIdentificationType	EntityIdentificationType!	The type/category of identification assigned to the entity.
identification	String!	The actual identification value assigned (e.g., the registration number).

EntitySecurityGroup

Represents a security group that controls access to entities.

Field	Type	Description
entities	EntitiesCollectionSegment	The entities governed by this security group.
skip	Int
take	Int
userRole	UserRole	The role of the user within the security group.
id	ID!	The unique identifier for the security group.
priority	Int!	The priority level assigned to the security group.
reference	String!	A reference code or value for the security group.
name	String	The name of the security group.
liveReference	String	A live reference for tracking the security group.
systemPredefined	Boolean	Indicates whether the security group is predefined by the system.
entitySecurityGroupAuto	String	Automatic settings for the security group.
entitySecurityGroupRollUp	EntitySecurityGroupRollUp	Specifies the roll-up configuration for an entity security group.
entitySecurityGroupApplies	String	Applies specific rules to the security group.

EntitySecurityGroupsCollectionSegment

Represents a collection segment of entity security groups.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for entity security groups.
items	[EntitySecurityGroup!]	Contains the items of the entity security groups collection segment.
totalCount	Int!	Indicates the total count of entity security groups in the segment.

EntitySet

Represents a set of entities grouped together for organizational purposes.

Field	Type	Description
entities	EntitiesCollectionSegment	The entities included in the set.
skip	Int
take	Int
id	ID!	The unique identifier for the entity set.
priority	Int!	The priority level assigned to the entity set.
reference	String!	A reference code or value for the entity set.
name	String	The name of the entity set.
appliesTo	[EntityTypeCategory!]!	The types of entities included in the set.

EntitySetsCollectionSegment

Represents a collection segment of entity sets.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for entity sets.
items	[EntitySet!]	Contains the items of the entity sets collection segment.
totalCount	Int!	Indicates the total count of entity sets in the segment.

EntityType

Represents the type or classification of an entity within the system.

Field	Type	Description
id	ID!	The unique identifier for the entity type.
priority	Int!	The priority level assigned to the entity type.
reference	String!	A reference code or identifier for the entity type.
name	String	The name of the entity type.
systemDefined	Boolean!	Indicates whether the entity type is system-defined (as opposed to user-defined).

EntityTypesCollectionSegment

Represents a collection segment of entity types.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for entity types.
items	[EntityType!]	Contains the items of the entity types collection segment.
totalCount	Int!	Indicates the total count of entity types in the segment.

ErrorOfAddressMappingPayload

Payload returned for error of address mapping operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	The extensions included in the response payload.
type	String	The type included in the response payload.
title	String	The title included in the response payload.
status	Int	The status included in the response payload.
detail	String	The detail included in the response payload.
instance	String	The instance included in the response payload.

ErrorOfAddressPayload

Represents an error response related to an address payload.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional metadata or context for the address error.
type	String	The type or category of the address error.
title	String	A short, human-readable summary of the address error.
status	Int	The HTTP status code associated with the address error.
detail	String	A detailed explanation of the address error.
instance	String	A URI reference identifying the specific occurrence of the address error.

ErrorOfAddressTypePayload

Represents an error response related to an address type payload.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional metadata or context for the address type error.
type	String	The type or category of the address type error.
title	String	A short, human-readable summary of the address type error.
status	Int	The HTTP status code associated with the address type error.
detail	String	A detailed explanation of the address type error.
instance	String	A URI reference identifying the specific occurrence of the address type error.

ErrorOfCompanyOptionsPayload

Represents an error payload specific to company options-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the company options error payload.
type	String	The type of error encountered in the company options payload.
title	String	The title or brief summary of the error encountered in the company options payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the company options payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfCompanyPayload

Represents an error payload specific to company-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the company error payload.
type	String	The type of error encountered in the company payload.
title	String	The title or brief summary of the error encountered in the company payload.
status	Int	The status code or state associated with the error (e.g., 404, 500).
detail	String	A detailed description of the error encountered in the company payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfCompanyStatusPayload

Represents an error payload specific to company status-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the company status error payload.
type	String	The type of error encountered in the company status payload.
title	String	The title or brief summary of the error encountered in the company status payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the company status payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfCompanyTypePayload

Represents an error payload specific to company type-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the company type error payload.
type	String	The type of error encountered in the company type payload.
title	String	The title or brief summary of the error encountered in the company type payload.
status	Int	The status code or state associated with the company type error.
detail	String	A detailed description of the error encountered in the company type payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfDataLibraryPayload

Represents an error response related to a Data Library payload.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional metadata or context for the Data Library error.
type	String	The type or category of the Data Library error.
title	String	A short, human-readable summary of the Data Library error.
status	Int	The HTTP status code associated with the Data Library error.
detail	String	A detailed explanation of the Data Library error.
instance	String	A URI reference identifying the specific occurrence of the Data Library error.

ErrorOfEntityBatchPayload

Represents an error payload specific to entity batch-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the entity batch error payload.
type	String	The type of error encountered in the entity batch payload.
title	String	The title or brief summary of the error encountered in the entity batch payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the entity batch payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfEntityIdentificationPayload

Represents an error returned in the context of entity identification operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional metadata or details related to the error.
type	String	A URI reference that identifies the type of error encountered.
title	String	short, human-readable summary of the error.
status	Int	The HTTP status code generated by the server for this error.
detail	String	A detailed, human-readable explanation specific to this occurrence of the error.
instance	String	A URI reference that identifies the specific occurrence of the error.

ErrorOfEntityPayload

Represents an error payload specific to entity-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the entity error payload.
type	String	The type of error encountered in the entity payload.
title	String	The title or brief summary of the error encountered in the entity payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the entity payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfEntitySecurityGroupPayload

Represents an error payload specific to entity security group-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the entity security group error payload.
type	String	The type of error encountered in the entity security group payload.
title	String	The title or brief summary of the error encountered in the entity security group payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the entity security group payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfEntitySetPayload

Represents an error payload specific to entity set-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the entity set error payload.
type	String	The type of error encountered in the entity set payload.
title	String	The title or brief summary of the error encountered in the entity set payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the entity set payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfEntityTypePayload

Represents an error payload specific to entity type-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the entity type error payload.
type	String	The type of error encountered in the entity type payload.
title	String	The title or brief summary of the error encountered in the entity type payload.
status	Int	The status code or state associated with the error (e.g., 404, 500).
detail	String	A detailed description of the error encountered in the entity type payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfIndividualPayload

Represents an error payload specific to individual-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the individual error payload.
type	String	The type of error encountered in the individual payload.
title	String	The title or brief summary of the error encountered in the individual payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the individual payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfJobPayload

Payload returned for error of job operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	The extensions included in the response payload.
type	String	The type included in the response payload.
title	String	The title included in the response payload.
status	Int	The status included in the response payload.
detail	String	The detail included in the response payload.
instance	String	The instance included in the response payload.

ErrorOfNationalityPayload

Represents an error payload specific to nationality-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the nationality error payload.
type	String	The type of error encountered in the nationality payload.
title	String	The title or brief summary of the error encountered in the nationality payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the nationality payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfOtherEntityPayload

Represents an error payload specific to other types of entities.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the other entity error payload.
type	String	The type of error encountered in the other entity payload.
title	String	The title or brief summary of the error encountered in the other entity payload.
status	Int	The status code or state associated with the error encountered.
detail	String	A detailed description of the error encountered in the other entity payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfPartnerPayload

Represents an error payload specific to partner-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the partner error payload.
type	String	The type of error encountered in the partner payload.
title	String	The title or brief summary of the error encountered in the partner payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the partner payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfPendingEventPayload

Represents an error response related to a pending event payload.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional metadata or context for the pending event error.
type	String	The type or category of the pending event error.
title	String	A short, human-readable summary of the pending event error.
status	Int	The HTTP status code associated with the pending event error.
detail	String	A detailed explanation of the pending event error.
instance	String	A URI reference identifying the specific occurrence of the pending event error.

ErrorOfPendingEventStatusPayload

Represents an error response related to a pending event status payload.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional metadata or context for the pending event status error.
type	String	The type or category of the pending event status error.
title	String	A short, human-readable summary of the pending event status error.
status	Int	The HTTP status code associated with the pending event status error.
detail	String	A detailed explanation of the pending event status error.
instance	String	A URI reference identifying the specific occurrence of the pending event status error.

ErrorOfPersonOptionsPayload

Represents an error payload specific to person options-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the person options error payload.
type	String	The type of error encountered in the person options payload.
title	String	The title or brief summary of the error encountered in the person options payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the person options payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfSubCountryPayload

Represents an error payload specific to sub-country-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the sub-country error payload.
type	String	The type of error encountered in the sub-country payload.
title	String	The title or brief summary of the error encountered in the sub-country payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the sub-country payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfUserGroupingPayload

Represents an error payload specific to user grouping-related operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the user grouping error payload.
type	String	The type of error encountered in the user grouping payload.
title	String	The title or brief summary of the error encountered in the user grouping payload.
status	Int	The status code or state associated with the error.
detail	String	A detailed description of the error encountered in the user grouping payload.
instance	String	A reference to the specific instance where the error occurred.

ErrorOfUserPayload

Payload returned for error of user operations.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	The extensions included in the response payload.
type	String	The type included in the response payload.
title	String	The title included in the response payload.
status	Int	The status included in the response payload.
detail	String	The detail included in the response payload.
instance	String	The instance included in the response payload.

EventGroup

Represents a group or category that classifies event types.

Field	Type	Description
id	ID!	The unique identifier of the event group.
reference	String!	A reference code for the event group.
name	String	The display name of the event group.

EventGroupsCollectionSegment

Represents a paginated collection of event groups.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination details for the event groups.
items	[EventGroup!]	List of event group entries on the current page.
totalCount	Int!	Total number of event groups available.

EventType

Represents a defined event type in the system.

Field	Type	Description
eventGroup	EventGroup	The event group that the event type belongs to.
id	ID!	The unique identifier of the event type.
reference	String!	A reference code assigned to the event type.
name	String	The display name of the event type.
description	String!	A textual description of the event type.

EventTypesCollectionSegment

Represents a paginated collection of event types.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information (e.g., cursor, hasNextPage).
items	[EventType!]	List of event type entries returned for the current page.
totalCount	Int!	Total number of event type entries available.

GlobalOption

Represents the global option settings.

Field	Type	Description
companyDefaultAddressPriorities	[DefaultAddressPriority!]!	The companies default address priority settings.
corporateDefaultAddressPriorities	[DefaultAddressPriority!]!	Other entities default address priority settings.
individualDefaultAddressPriorities	[DefaultAddressPriority!]!	The individuals default address priority settings.

GroupStructureCriteriaPayload

Payload returned for group structure criteria operations.

Field	Type	Description
corporateStructureId	ID	The corporate structure id included in the response payload.
structureType	GroupStructureType	The structure type included in the response payload.
asAtDate	DateTime	The as at date included in the response payload.
ownershipMinPercentage	Decimal	The ownership min percentage included in the response payload.
ownershipMaxPercentage	Decimal	The ownership max percentage included in the response payload.

GroupStructurePayload

Payload returned for group structure operations.

Field	Type	Description
documentId	ID!	The document id included in the response payload.
criteria	GroupStructureCriteriaPayload!	The criteria included in the response payload.
rawXml	String!	The raw xml included in the response payload.

Individual

Represents an individual person in the system.

Field	Type	Description
pendingEvent	PendingEvent
nationality	Nationality	The nationality of the individual.
addresses	[AddressEntry!]	The list of address containing address type and actual address.
pastAddresses	[PastAddressEntry!]	The collection of past addresses associated with the individual.
country	Country	The country of the individual.
entityBatches	[EntityBatch!]!	The entity batches that include this individual.
entitySecurityGroups	[EntitySecurityGroup!]!	The security groups that control access to the individual.
entitySets	[EntitySet!]	The entity sets that include this individual.
entityType	EntityType	The type or classification of the individual as an entity.
partner	Partner	The partner associated with the individual.
personOptions	PersonOptions	Configuration options related to the individual.
subCountry	SubCountry	The sub-country (e.g., state or province) of the individual.
managedBy	User	The user or entity that manages the individual.
userGrouping	UserGrouping	Represents the user grouping associated with an individual.
updatedAt	DateTime	Indicates the last update timestamp for an individual.
forenames	String	The forenames (first and middle names) of the individual.
surname	String	The surname (last name) of the individual.
displayAs	IndividualNameFormat!	How the individual is displayed in the system.
sortName	String	The name of the individual used for sorting purposes.
isHistoricalRecord	Boolean	Indicates if the individual record is historical.
title	String	The title of the individual (e.g., Mr., Mrs., Dr.).
honours	String	Any honors or distinctions the individual holds.
salutation	String	The formal greeting or salutation for the individual.
previousName	String	Any previous names the individual may have had.
occupation	String	The occupation or profession of the individual.
dateOfBirth	LocalDate	The date of birth of the individual.
dateOfDeath	LocalDate	The date of death of the individual, if applicable.
nationalIdentificationNumber	String	The national identification number for the individual.
firstForename	String	The first forename (given name) of the individual.
middleNames	String	The middle names of the individual.
initials	String	The initials of the individual.
previousForenames	String	Any previous forenames the individual may have had.
previousSurname	String	Any previous surnames the individual may have had.
previousFirstForename	String	Any previous first names the individual may have had.
passportNumber	String	The passport number of the individual.
id	ID!	The unique identifier for the individual.
referenceType	EntityTypeCategory!	A quick reference type associated with the individual.
entityReference	String	A reference code or identifier for the individual entity.
entityName	String	The name of the individual entity.
udfs	[UdfValue]	User-defined fields associated with the individual.
names	[String!]!

IndividualsCollectionSegment

Represents a collection segment of individuals.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for individuals.
items	[Individual]	Contains the items of the individuals collection segment.
totalCount	Int!	Indicates the total count of individuals in the segment.

IndustrialClassification

Represents a specific industrial classification for entities.

Field	Type	Description
country	Country	Defines the country associated with an industrial classification.
id	ID!	The unique identifier for the industrial classification.
reference	String!	A reference code or value for the classification.
name	String	The name of the industrial classification.
code	String	The specific code for the industrial classification.

IndustrialClassificationsCollectionSegment

Represents a collection segment of industrial classifications.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for industrial classifications.
items	[IndustrialClassification!]	Contains the items of the industrial classifications collection segment.
totalCount	Int!	Indicates the total count of industrial classifications in the segment.

Job

Represents job.

Field	Type	Description
document	Document	Represents document for job.
id	ID!	The unique identifier.
jobType	JobType!	Represents job type for job.
jobNotificationStatus	JobNotificationStatus!	Represents job notification status for job.
errorMessage	String	Represents error message for job.
description	String	Represents description for job.
createdAt	DateTime!	Represents created at for job.
startedAt	DateTime	Represents started at for job.
updatedAt	DateTime	Represents updated at for job.

JobsCollectionSegment

A segment of a collection.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Information to aid in pagination.
items	[Job!]	A flattened list of the items.
totalCount	Int!	The total number of items in the collection.

KeyValuePairOfStringAndJsonElement

Represents a key-value pair where the key is a string and the value is a JSON element.

Field	Argument	Type	Description
key		String!	The key part of the key-value pair, represented as a string.
value		Any!	The value part of the key-value pair, represented as a JSON element.

KeyValuePairOfStringAndString__

Represents a key-value pair where both the key and the value are strings.

Field	Argument	Type	Description
key		String!	The key in the string key-value pair.
value		[String!]!	The value in the string key-value pair.

MinimalEntityPayload

A lightweight representation of an entity with essential fields only.

Field	Type	Description
country	Country	The country associated with the entity.
entityBatches	[EntityBatch!]!	The batches this entity is grouped under.
entitySecurityGroups	[EntitySecurityGroup!]!	The security groups that govern access to the entity.
entitySets	[EntitySet!]	The sets the entity is a member of.
entityType	EntityType	The type/category of the entity (e.g., company, individual).
partner	Partner	The partner associated with the entity.
personOptions	PersonOptions	Configuration options specific to individual entities.
subCountry	SubCountry	Sub-national jurisdiction (e.g., state, province) associated with the entity.
managedBy	User	The user or group responsible for managing the entity.
userGrouping	UserGrouping	The user grouping associated with the minimal entity payload.
id	ID!	Unique identifier of the entity.
referenceType	EntityTypeCategory!	Defines the type of reference used for identifying the entity.
entityReference	String	External or internal reference string identifying the entity.
entityName	String	The official or display name of the entity.

NationalitiesCollectionSegment

Represents a collection segment of nationalities.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for nationalities.
items	[Nationality!]	Contains the items of the nationalities collection segment.
totalCount	Int!	Indicates the total count of nationalities in the segment.

Nationality

Represents a nationality, including its associated metadata like codes.

Field	Type	Description
country	Country	Defines the country associated with a nationality.
subCountry	SubCountry	Defines the sub-country associated with a nationality.
id	ID!	The unique identifier of the nationality.
priority	Int!	The priority assigned to the nationality.
name	String!	The name of the nationality.

NodePolicy

Field	Argument	Type	Description
hasAccess		Boolean!

Occupation

Represents a specific occupation.

Field	Type	Description
id	ID!	The unique identifier for the occupation.
priority	Int!	Defines the priority of the occupation.
reference	String!	The reference identifier for the occupation.

OccupationsCollectionSegment

Represents a collection segment of occupations.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for occupations.
items	[Occupation!]	Contains the items of the occupations collection segment.
totalCount	Int!	Indicates the total count of occupations in the segment.

OtherEntitiesCollectionSegment

Represents a collection segment of other entities.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for other entities.
items	[OtherEntity]	Contains the items of the other entities collection segment.
totalCount	Int!	Indicates the total count of other entities in the segment.

OtherEntity

Represents any other type of entity in the system besides companies (e.g., individuals).

Field	Type	Description
addresses	[AddressEntry!]	The list of address containing address type and actual address.
country	Country	The country associated with the entity.
entityBatches	[EntityBatch!]!	The batches that include the entity.
entitySecurityGroups	[EntitySecurityGroup!]!	The security groups that govern the entity.
entitySets	[EntitySet!]	The sets in which the entity is included.
entityType	EntityType	The type or classification of the entity.
partner	Partner	The partner associated with the entity.
personOptions	PersonOptions	Person-specific options for the entity.
subCountry	SubCountry	The sub-country (e.g., state or province) associated with the entity.
managedBy	User	The entity or person responsible for managing the entity.
userGrouping	UserGrouping	Represents the user grouping associated with another entity.
isHistoricalRecord	Boolean	Indicates whether the entity is part of historical records.
updatedAt	DateTime	Indicates the last update timestamp for another entity.
companyNumber	String	The registration number of the entity if applicable.
incorporationDate	LocalDate	The date the entity was incorporated or registered.
dissolvedDate	LocalDate	The date the entity was dissolved, if applicable.
occupation	String	The occupation of the entity if it represents an individual.
fileReference	String	The file reference associated with the other entity record.
id	ID!	The unique identifier of the entity.
referenceType	EntityTypeCategory!	A quick reference type for categorizing the entity.
entityReference	String	A reference field for linking the entity to related records.
entityName	String	The name of the entity.
udfs	[UdfValue]	User-defined fields associated with the other entity.
names	[String!]!

Partner

Represents a partner entity within the system.

Field	Type	Description
id	ID!	The unique identifier for the partner.
priority	Int!	The priority level assigned to the partner.
reference	String!	A reference code for the partner.
name	String	The name of the partner entity.
initials	String	The initials of the partner, if applicable.

PartnersCollectionSegment

Represents a collection segment of partners.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for partners.
items	[Partner!]	Contains the items of the partners collection segment.
totalCount	Int!	Indicates the total count of partners in the segment.

PastAddressEntry

A historical address previously associated with an entity.

Field	Type	Description
entity	Entity	The entity that owns this past address.
address	Address	The address previously associated with the entity.
addressType	AddressType	The address type of the past address.
id	ID!	The unique identifier for the past address.
validTo	DateTime	The date until which the past address was valid.

PastAddressesCollectionSegment

Represents a paginated collection of past addresses.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Pagination information for the past addresses collection.
items	[PastAddressEntry!]	The past address items in this page.
totalCount	Int!	The total number of past addresses matching the query.

PendingAppointment

Represents a pending appointment or officer record in the system, containing information about pending officer appointments and changes that require approval or processing.

Field	Type	Description
pendingEvent	PendingEvent	Represents pending event for pending appointment.
company	Entity	The company entity that this pending appointment relates to, providing company details and context.
person	Entity	The individual person being appointed, containing personal information and entity details.
replaceWith	Entity	The person entity being replaced by this pending appointment, if applicable.
alternateTo	Entity	The person entity that this appointment serves as an alternate to, if applicable.
event	Appointment	The related appointment event record providing additional event context.
officerGroup	AppointmentGroup	The appointment group classification that categorizes the type of officer position.
officerStatus	AppointmentStatus	The status of the officer in the pending appointment (e.g., active, resigned).
officerOccupation	Occupation	The occupation of the officer in the pending appointment.
officerReplacementOccupation	Occupation	The occupation of the replacement officer in the pending appointment.
id	ID!	The unique identifier of the pending appointment record.
nodePolicy	NodePolicy!
eventDate	DateTime	The date when the appointment event is scheduled to occur or become effective.
positionIds	[ID!]!	Represents position ids for pending appointment.
positionsDescription	String!	Extended or detailed description of the positions being assigned in the appointment.
eventMessage	String!	Descriptive message explaining the nature of the appointment change or event.
officerLevel	Int	Numerical level indicating the officer's position in the organizational hierarchy.
officerReminder	DateTime	Date when reminders should be sent regarding this pending officer appointment.

PendingAppointmentsCollectionSegment

Represents a paginated collection segment of pending appointments.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the pending appointments collection, including cursor data and page availability.
items	[PendingAppointment!]	The list of pending appointment records in the current page of results.
totalCount	Int!	The total number of pending appointment records available across all pages.

PendingEvent

Represents a pending event or task that requires action, such as filing requirements, compliance deadlines, or other scheduled activities related to an entity.

Field	Type	Description
entity	Entity	The entity associated with this pending event.
eventType	EventType	The type or category of the pending event.
assignedTo	User	The user assigned to handle this pending event.
createdBy	User	The user who created this pending event record. (AuditUser)
id	ID!	The unique identifier of the pending event.
reference	Int!	Represents reference for pending event.
eventDate	DateTime	The date when the event is scheduled to occur.
reminderDate	DateTime	The date when reminders should be sent for this event.
description	String	A detailed description of the pending event.
auditDate	DateTime	The date when this pending event record was last modified.
isHistorical	Boolean!	Indicates whether this pending event record is marked as inactive or historical.
isActioned	Boolean!	Indicates whether this pending event has been completed or actioned.
notes	String	Additional notes or comments about the pending event.
isHidden	Boolean!	Indicates whether this pending event is hidden from normal views.

PendingEventNotification

Represents a notification generated for a pending event.

Field	Type	Description
id	ID!	The unique identifier of the pending event notification.
jobNotificationStatus	JobNotificationStatus!	The job notification status associated with this notification.
description	String	A description of the pending event notification.
statusMessage	String	A status message describing the current state of the notification.
errorMessage	String	An error message if the notification processing encountered issues.

PendingEventStatus

Represents the status of a pending event in the system.

Field	Argument	Type	Description
id		ID!	The unique identifier for the pending event status.
validationMessages		[PendingEventNotification!]!	A list of validation messages associated with the pending event status.

PendingEventsCollectionSegment

Represents a paginated collection of pending events.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the pending events collection.
items	[PendingEvent!]	The list of pending events in the current page of the collection.
totalCount	Int!	The total number of pending events in the collection.

PersonOptions

Options specific to a person entity in the system.

Field	Type	Description
hasShareCertificates	Boolean!	Indicates if the person has share certificates.
hasStockTransferForms	Boolean!	Indicates if the person has stock transfer forms.
hasRegisterAddendums	Boolean!	Indicates if the person has register addendums.
hasOtherDirectorships	Boolean!	Indicates if the person has other directorships.

SavedFilter

Represents saved filter.

Field	Type	Description
ownedBy	User	Represents owned by for saved filter.
id	ID!	The unique identifier.
filterType	FilterType!	Represents filter type for saved filter.
name	String!	Represents name for saved filter.

SavedFiltersCollectionSegment

A segment of a collection.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Information to aid in pagination.
items	[SavedFilter!]	A flattened list of the items.
totalCount	Int!	The total number of items in the collection.

Represents a share record.

Field	Type	Description
shareClass	ShareClass	The share class associated with this share.
shareholder	Entity	The shareholder entity associated with this share.
beneficiary	Entity	The beneficiary entity associated with this share.
id	ID!	The unique identifier of the share.
allotmentDate	DateTime	The date on which the shares were allotted.
numberOfShares	Decimal	The number of shares allotted.
considerationPerShare	Decimal	The consideration amount per share.
applicationDate	DateTime	The date of the share application.
applicationAmount	Decimal	The application amount associated with the share.
notes	String	Notes related to the share.

ShareCategoriesCollectionSegment

Represents a paginated collection of share categories.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the share categories collection.
items	[ShareCategory!]	The list of share categories in the current page of the collection.
totalCount	Int!	The total number of share categories in the collection.

ShareCategory

Represents a category of shares with specific rights and attributes.

Field	Type	Description
id	ID!	The unique identifier for the share category.
priority	Int	The priority level assigned to the share category.
reference	String!	The reference code associated with the share category.
name	String	The name of the share category.
code	String	The code used to identify the share category.
isNotInCountries	Boolean	Indicates whether the share category is excluded from specific countries.
countryIds	[ID!]	The list of country identifiers where the share category is applicable.

ShareClass

Represents a class of shares issued by a company.

Field	Type	Description
issuer	Company	The entity that issued the share class.
currency	Currency	The currency in which the share class is denominated.
shareCategory	ShareCategory	The share category associated with the share class.
id	ID!	The unique identifier for the share class.
nodePolicy	NodePolicy!
reference	String!	The reference code for the share class.
name	String	The name of the share class.
code	String	The code used to identify the share class.
notes	String	Additional notes or comments about the share class.
authorisedShares	Float	The number of authorised shares in the share class.
issuedShares	Float	The number of shares issued in the share class.
nominalValue	Float	The nominal value assigned to each share in the share class.
isNonCapitalShares	Boolean	Indicates whether the share class represents non-capital shares.
isNonVotingShares	Boolean	Indicates whether the share class has no voting rights.
votesPerShare	Float	Specifies the number of votes allocated per share in the class.
isPartlyPaid	Boolean	Indicates whether the shares in the class are partly paid.
shareClassRights	String	The rights associated with the share class (e.g., voting, dividend).
shareType	ShareType	The type of share (e.g., ordinary, preference) represented by the class.
showShareholdersOnRegister	Boolean	Indicates whether shareholders of this class are shown on the register.
createdAt	DateTime	The date and time when the share class was created.
canceledAt	DateTime	The date and time when the share class was canceled, if applicable.
capitalWeighting	Float	The capital weighting assigned to the share class for calculations.
votingWeighting	Float	The voting weighting assigned to the share class for calculations.
premiumAccountAmount	Float	The amount allocated to the premium account for this share class.
certificateNumberPrefix	String	The prefix used for certificate numbers in this share class.
certificateNumberSuffix	String	The suffix used for certificate numbers in this share class.
longName	String	The full descriptive name of the share class.

ShareClassesCollectionSegment

Represents a collection segment of share classes, typically used for paginated queries.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for the share classes collection segment.
items	[ShareClass!]	Contains the items of the share classes collection segment.
totalCount	Int!	Indicates the total count of share classes in the segment.

SharesCollectionSegment

Represents a paginated collection of shares.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination information for the shares collection.
items	[Share!]	The list of shares in the current page of the collection.
totalCount	Int!	The total number of shares in the collection.

SubCountriesCollectionSegment

Represents a collection segment of sub-countries.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for sub-countries.
items	[SubCountry!]	Contains the items of the sub-countries collection segment.
totalCount	Int!	Indicates the total count of sub-countries in the segment.

SubCountry

Represents a sub-country division, such as a state or province.

Field	Type	Description
country	Country	Defines the country associated with a sub-country.
id	ID!	The unique identifier of the sub-country.
subCountryCode	String	The code for the sub-country (e.g., state code).
name	String	The name of the sub-country.

Trust

Represents trust.

Field	Type	Description
trustStatus	CompanyStatus	Represents trust status for trust.
companyOptions	CompanyOptions	Represents company options for trust.
addresses	[AddressEntry!]	List of addresses associated with the trust.
country	Country	The country of trust residency (the jurisdiction that governs the operation of the trust).
entityBatches	[EntityBatch!]!	Represents entity batches for trust.
entitySecurityGroups	[EntitySecurityGroup!]!	Represents entity security groups for trust.
entitySets	[EntitySet!]	Represents entity sets for trust.
entityType	EntityType	Represents entity type for trust.
partner	Partner	Represents partner for trust.
personOptions	PersonOptions	Represents person options for trust.
subCountry	SubCountry	The region or state of the trust residency.
managedBy	User	Represents managed by for trust.
userGrouping	UserGrouping	Represents user grouping for trust.
isHistoricalRecord	Boolean	Represents is historical record for trust.
updatedAt	DateTime	Represents updated at for trust.
incorporationDate	LocalDate	Represents incorporation date for trust.
domicile	String	Represents domicile for trust.
isOverseas	Boolean	Represents is overseas for trust.
trustType	String	Represents trust type for trust.
vestedDate	LocalDate	The trust's legal end point date (specific to Australia).
tfnNumber	String	The trust’s Tax File Number (specific to Australia).
irdNumber	String	Unique tax identification number (specific to New Zealand).
gstNumber	String	GST (goods an services tax) number. Relevant in Australia, Canada, India and New Zealand.
gstGroup	String	Text field containing the GST (goods and services tax) group of the trust. Specific to Australia.
arsnNumber	String	The ARSN (Australian Registered scheme Number) of the trust.
trustDeedIssuedAt	LocalDate	The date when the trust deed was issued.
description	String	Field containing a text description of the trust.
placeOfEstablishment	String	Place where the trust deed is executed.
legalOwnership	String	Information on the legal ownership of the trust.
controlledEntity	String	Yes/No field indicating whether the trust is a controlled entity under tax legislation.
taxEntityType	String	Represents tax entity type for trust.
taxConsolidationGroup	String	Yes/No field indicating whether the trust belongs to an income tax consolidation group (specific to Australia).
taxOther	String	Text field containing other tax related information.
id	ID!	The unique identifier.
referenceType	EntityTypeCategory!	Represents reference type for trust.
entityReference	String	Text field containing the quick reference for the trust.
entityName	String	Text field containing the name of the trust.
udfs	[UdfValue]	Represents udfs for trust.
names	[String!]!

TrustsCollectionSegment

A segment of a collection.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Information to aid in pagination.
items	[Trust]	A flattened list of the items.
totalCount	Int!	The total number of items in the collection.

Udf

Represents a user-defined field, allowing customization of additional attributes.

Field	Type	Description
id	ID!	The unique identifier of the user-defined field.
reference	String!	A reference code associated with the UDF.
priority	Int	Represents priority for udf.
name	String	The name of the UDF.
shortName	String	A shortened or alias version of the UDF's name.
storageTable	StorageTable!	Represents the storage table associated with a user-defined field (UDF).
storageLocation	StorageLocation!	Represents the storage location where the user-defined field (UDF) data is stored.
dataType	DataType	The type of data that the UDF holds, such as string, integer, or date.
textLength	Int	Specifies the maximum length of text that the UDF can hold.
textFlags	[UdfTextFlag!]	Flags indicating specific formatting or restrictions on the UDF's text.
displayWidth	Int	The display width of the UDF in the user interface.
helpText	String	Represents help text for udf.
isNotInCountries	Boolean	Filters UDFs that do not apply to certain country codes.
countryIds	[ID!]	The country codes to which the UDF applies.
isReadOnly	Boolean	Indicates whether the UDF is read-only or editable.
entityTypeIds	[ID!]	The entity type IDs to which the user-defined field (UDF) applies.
isSystemPredefined	Boolean	Represents is system predefined for udf.
isRequired	Boolean	Specifies if the UDF is mandatory and must be filled out before saving.

UdfValue

Represents the value of a user-defined field (UDF), including its name, type, and actual value.

Field	Type	Description
name	String!	The name of the user-defined field (UDF) whose value is being represented.
type	DataType	The data type of the user-defined field (UDF), such as string, integer, or date.
value	String	The actual value assigned to the user-defined field (UDF).

UdfsCollectionSegment

Represents a collection segment of UDFs (User-Defined Fields).

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for UDFs.
items	[Udf!]	Contains the items of the UDFs collection segment.
totalCount	Int!	Indicates the total count of UDFs in the segment.

UpdateAddressPayload

The payload returned after updating an address, containing the updated address and any errors.

Field	Argument	Type	Description
address		Address	The address returned by the update operation.
errors		[UpdateAddressError!]	Any errors encountered during the address update.

UpdateAddressTypePayload

The payload returned after updating an address type, containing the updated address type and any errors.

Field	Argument	Type	Description
addressType		AddressType	The address type returned by the update operation.
errors		[UpdateAddressTypeError!]	Any errors encountered during the address type update.

UpdateCompanyOptionsPayload

The payload returned after updating company options, containing details of the updated options and any errors.

Field	Argument	Type	Description
companyOptions		CompanyOptions	The updated company options.
errors		[UpdateCompanyOptionsError!]	Any errors encountered during the update of company options.

UpdateCompanyPayload

The payload returned after a company update operation, containing details of the updated company and any errors.

Field	Argument	Type	Description
company		Company	The company object that was updated.
errors		[UpdateCompanyError!]	Any errors encountered during the company update.

UpdateCompanyStatusPayload

The payload returned after updating a company status, containing details of the updated status and any errors.

Field	Argument	Type	Description
companyStatus		CompanyStatus	The company status object that was updated.
errors		[UpdateCompanyStatusError!]	Any errors encountered during the update of the company status.

UpdateCompanyTypePayload

The payload returned after updating a company type, containing details of the updated company type and any errors.

Field	Argument	Type	Description
companyType		CompanyType	The company type object that was updated.
errors		[UpdateCompanyTypeError!]	Any errors encountered during the company type update

UpdateDataLibraryPayload

The payload returned after updating a data library record, containing the updated record and any errors.

Field	Argument	Type	Description
dataLibrary		DataLibrary	The data library record that was updated.
errors		[UpdateDataLibraryError!]	Any errors encountered during the data library update.

UpdateEntityBatchPayload

The payload returned after updating an entity batch, containing details of the updated entity batch and any errors.

Field	Argument	Type	Description
entityBatch		EntityBatch	The entity batch that was updated.
errors		[UpdateEntityBatchError!]	Any errors encountered during the update of the entity batch.

UpdateEntityIdentificationPayload

Payload returned after updating an entity identification.

Field	Argument	Type	Description
entityIdentification		EntityIdentification	The updated identification information.
errors		[UpdateEntityIdentificationError!]	Errors returned if the update fails.

UpdateEntitySecurityGroupPayload

The payload returned after updating an entity security group, containing details of the updated group and any errors.

Field	Argument	Type	Description
entitySecurityGroup		EntitySecurityGroup	The updated entity security group object.
errors		[UpdateEntitySecurityGroupError!]	Any errors encountered during the update of the entity security group.

UpdateEntitySetPayload

The payload returned after disconnecting entity sets from an entity, containing details of the entity and any errors.

Field	Argument	Type	Description
entitySet		EntitySet	The entity from which the entity sets were disconnected.
errors		[UpdateEntitySetError!]	Any errors encountered during the disconnection of entity sets from the entity.

UpdateEntityTypePayload

The payload returned after updating an entity type, containing details of the updated entity type and any errors.

Field	Argument	Type	Description
entityType		EntityType	The entity type object that was updated.
errors		[UpdateEntityTypeError!]	Any errors encountered during the update of the entity type.

UpdateIndividualPayload

The payload returned after updating an individual, containing details of the updated individual and any errors.

Field	Argument	Type	Description
individual		Individual	The updated individual object.
errors		[UpdateIndividualError!]	Any errors encountered during the update of the individual.

UpdateNationalityPayload

The payload returned after updating a nationality, containing details of the updated nationality and any errors.

Field	Argument	Type	Description
nationality		Nationality	The nationality object that was updated.
errors		[UpdateNationalityError!]	Any errors encountered during the update of the nationality.

UpdateOtherEntityPayload

The payload returned after updating another type of entity, containing details of the updated entity and any errors.

Field	Argument	Type	Description
otherEntity		OtherEntity	The other entity object that was updated.
errors		[UpdateOtherEntityError!]	Any errors encountered during the update of the other entity.

UpdatePartnerPayload

The payload returned after updating a partner, containing details of the updated partner and any errors.

Field	Argument	Type	Description
partner		Partner	The partner object that was updated.
errors		[UpdatePartnerError!]	Any errors encountered during the update of the partner.

UpdatePendingAppointmentPayload

Payload returned for update pending appointment operations.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[UpdatePendingAppointmentError!]	The errors included in the response payload.

UpdatePendingChangeJobTitlePayload

Payload returned for update pending change job title operations.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[UpdatePendingChangeJobTitleError!]	The errors included in the response payload.

UpdatePendingDeathPayload

Payload returned for update pending death operations.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[UpdatePendingDeathError!]	The errors included in the response payload.

UpdatePendingRemovalPayload

Payload returned for update pending removal operations.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[UpdatePendingRemovalError!]	The errors included in the response payload.

UpdatePendingReplacementPayload

Payload returned for update pending replacement operations.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[UpdatePendingReplacementError!]	The errors included in the response payload.

UpdatePendingResignationPayload

Payload returned for update pending resignation operations.

Field	Argument	Type	Description
pendingEvent		PendingEvent	The pending event included in the response payload.
errors		[UpdatePendingResignationError!]	The errors included in the response payload.

UpdatePersonOptionsPayload

The payload returned after updating person options, containing details of the updated options and any errors.

Field	Argument	Type	Description
personOptions		PersonOptions	The updated person options.
errors		[UpdatePersonOptionsError!]	Any errors encountered during the update of person options.

UpdateSubCountryPayload

The payload returned after updating a sub-country, containing details of the updated sub-country and any errors.

Field	Argument	Type	Description
subCountry		SubCountry	The sub-country object that was updated.
errors		[UpdateSubCountryError!]	Any errors encountered during the update of the sub-country.

UpdateUserGroupingPayload

The payload returned after updating a user grouping, containing details of the updated user grouping and any errors.

Field	Argument	Type	Description
userGrouping		UserGrouping	The updated user grouping object.
errors		[UpdateUserGroupingError!]	Any errors encountered during the update of the user grouping.

UpdateUserPayload

Payload returned for update user operations.

Field	Argument	Type	Description
user		User	The user included in the response payload.
errors		[UpdateUserError!]	The errors included in the response payload.

User

Represents a user in the system.

Field	Type	Description
userRole	UserRole	Represents user role for user.
securityGroups	[EntitySecurityGroup!]!
id	ID!	The unique identifier for the user.
reference	String	A reference code or value for the user.
name	String	The full name of the user in the system.
initials	String	The initials of the user.
networkId	String	Represents network id for user.
platformId	String	Represents platform id for user.
loginEmail	String	Represents login email for user.
role ⚠️	String	The role assigned to the user within the system. ⚠️ DEPRECATED Share Class connected property is now exposed.
lastSuccessfulLoginAt	DateTime	Represents the timestamp of the user's most recent successful login.
isDisabled	Boolean	Indicates whether the user account is disabled.
isHidden	Boolean	Indicates whether the user account is hidden.
isAuditDisabled	Boolean	Indicates whether auditing is disabled for the user account.
securityGroupIds	[ID!]

UserGrouping

Represents a grouping of users for access control or other organizational purposes.

Field	Type	Description
id	ID!	The unique identifier for the user grouping.
priority	Int!	Represents the priority level assigned to a user grouping.
reference	String!	A reference code or value for the user grouping.
description	String	A description of the user grouping.

UserGroupingsCollectionSegment

Represents a collection segment of user groupings.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for user groupings.
items	[UserGrouping!]	Contains the items of the user groupings collection segment.
totalCount	Int!	Indicates the total count of user groupings in the segment.

UserRole

Represents a role assigned to a user, defining their permissions and access level within the system.

Field	Type	Description
id	ID!	Represents the unique identifier of the user role.
reference	String	Represents the reference string for the user role.
name	String	Represents the display name of the user role.

UserRolesCollectionSegment

Represents a paginated collection of user roles.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Contains pagination details such as page size and cursor information for the user roles collection.
items	[UserRole!]	The list of user role items in the current page of the collection.
totalCount	Int!	The total number of user roles in the entire collection.

UsersCollectionSegment

Represents a collection segment of users.

Field	Type	Description
pageInfo	CollectionSegmentInfo!	Provides pagination information for users.
items	[User!]	Contains the items of the users collection segment.
totalCount	Int!	Indicates the total count of users in the segment.

ValidationError

Represents a validation error encountered during input or processing.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Additional context or metadata related to the validation error.
validationErrors	[KeyValuePairOfStringAndString__!]!	A list or collection of validation errors encountered.
validationResults	[ValidationPathResult!]!	Structured validation issues grouped by property path, including message, code, and severity.
type	String	The type of validation error encountered.
title	String	The title or brief summary of the validation error.
status	Int	The status code or state associated with the validation error.
detail	String	A detailed description of the validation error encountered.
instance	String	A reference to the specific instance where the validation error occurred.

ValidationIssue

A single validation issue with a message, error code, and severity.

Field	Type	Description
message	String!	The human-readable validation message.
code	String!	The PascalCase error code for this validation issue.
severity	ValidationSeverity!	The severity of this validation issue.

ValidationPathResult

Validation issues for a single property path.

Field	Argument	Type	Description
path		String!	The property path where the validation issues occurred.
issues		[ValidationIssue!]!	The validation issues for this property path.

Inputs

ActionPendingEventInput

Input type for actioning a pending event.

Field		Type	Description
pendingEventId		ID!	The pending event ID to act on.

AddressFilterPayloadFilterInput

Filters address-related data based on multiple criteria.

Field	Type	Description
and	[AddressFilterPayloadFilterInput!]
or	[AddressFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering address data.
reference	QueryCommonStringOperationFilterInput	Filters addresses by their reference identifier.
postalCode	QueryCommonStringOperationFilterInput	Filters addresses by postal code.
composite	QueryCommonStringOperationFilterInput	Filters addresses using composite keys or identifiers.
isShared	QueryCommonBooleanOperationFilterInput	Filters addresses based on whether they are shared.
area	QueryCommonStringOperationFilterInput	Represents the area or region associated with a filtered address.
country	CountryFilterPayloadFilterInput	Filters addresses based on the associated country.
subCountry	SubCountryFilterPayloadFilterInput	Filters addresses based on sub-country.

AddressPayloadSortInput

Represents sorting options for address payloads.

Field	Type	Description
reference	SortEnumType	Specifies sorting by reference.
postalCode	SortEnumType	Specifies sorting by postal code.
area	SortEnumType	Specifies sorting by area or region.
country	CountryPayloadSortInput	Specifies sorting by country.
subCountry	SubCountryPayloadSortInput	Specifies sorting by sub-country (state/province).
composite	SortEnumType	Specifies sorting by the composite address value.

AddressTypeFilterPayloadFilterInput

A filter used to narrow down address types based on specific criteria such as reference or name.

Field	Type	Description
and	[AddressTypeFilterPayloadFilterInput!]
or	[AddressTypeFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering address type data.
reference	QueryCommonStringOperationFilterInput	Filters address types by a unique reference identifier.
name	QueryCommonStringOperationFilterInput	Filters address types by their name.

AddressTypePayloadSortInput

Sort options for address type payloads.

Field	Type	Description
reference	SortEnumType	Specifies sorting by the address type reference.
name	SortEnumType	Specifies sorting by the address type name.
systemPredefined	SortEnumType	Specifies sorting by whether the address type is system‑predefined.
isHeading	SortEnumType	Specifies sorting by whether the address type is a heading.
noRecordHeld	SortEnumType	Specifies sorting by the 'no record held' setting.

AppointmentCategoryFilterPayloadFilterInput

Represents filtering options for appointment categories.

Field	Type	Description
and	[AppointmentCategoryFilterPayloadFilterInput!]
or	[AppointmentCategoryFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering appointment category data.
reference	QueryCommonStringOperationFilterInput	Represents the reference associated with a filtered appointment category.
name	QueryCommonStringOperationFilterInput	Represents the name associated with a filtered appointment category.
priority	QueryCommonIntegerOperationFilterInput	Filters by priority.
entityType	EntityTypeFilterPayloadFilterInput	Represents the entity type associated with a filtered appointment category.

AppointmentCategoryPayloadSortInput

Represents sorting options for appointment category payloads.

Field	Type	Description
priority	SortEnumType	Specifies sorting by priority.
reference	SortEnumType	Specifies sorting by reference.
name	SortEnumType	Specifies sorting by name.

AppointmentGroupFilterPayloadFilterInput

A filter used to narrow down appointment groups based on specific criteria such as reference or name.

Field	Type	Description
and	[AppointmentGroupFilterPayloadFilterInput!]
or	[AppointmentGroupFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering appointment group data.
reference	QueryCommonStringOperationFilterInput	Filters appointment groups by a unique reference identifier.
name	QueryCommonStringOperationFilterInput	Filters appointment groups by their name.
priority	QueryCommonIntegerOperationFilterInput	Filters by priority.

AppointmentGroupPayloadSortInput

Represents sorting options for appointment group payloads.

Field	Type	Description
priority	SortEnumType	Specifies sorting by priority.
reference	SortEnumType	Specifies sorting by reference.
name	SortEnumType	Specifies sorting by name.

AppointmentPayloadFilterInput

Represents filtering options for appointments.

Field	Type	Description
and	[AppointmentPayloadFilterInput!]
or	[AppointmentPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering appointment data.
isOnStatutoryRegisters	QueryCommonBooleanOperationFilterInput	Filters appointments based on whether they appear on statutory registers.
notes	QueryCommonStringOperationFilterInput	Filters appointments by notes content.
auditDate	QueryCommonDateTimeOperationFilterInput	Filters appointments by audit date.
eventId	QueryCommonIntegerOperationFilterInput	Filters appointments by event identifier.
eventDate	QueryCommonDateTimeOperationFilterInput	Filters appointments by event date.
otherEventDate	QueryCommonDateTimeOperationFilterInput	Filters appointments by other event date.
level	QueryCommonIntegerOperationFilterInput	Filters appointments by appointment level.
isNotAttendee	QueryCommonBooleanOperationFilterInput	Filters appointments by whether the individual is not an attendee.
reminder	QueryCommonDateTimeOperationFilterInput	Filters appointments based on whether a reminder is set.
isActive	QueryCommonBooleanOperationFilterInput	Filters appointments by active status.
appointedTo	EntityBaseFilterPayloadFilterInput	Filters appointments by the entity the appointment is made to.
appointee	EntityBaseFilterPayloadFilterInput	Filters appointments by the appointee.
auditUser	UserPayloadFilterInput	Filters appointments by audit user.
eventType	EventTypePayloadFilterInput	Filters appointments by event type.
alternateAppointee	EntityBaseFilterPayloadFilterInput	Filters appointments by alternate appointee.
appointmentStatus	AppointmentStatusFilterPayloadFilterInput	Filters appointments by appointment status.
occupation	OccupationPayloadFilterInput	Filters appointments by occupation.
appointmentGroup	AppointmentGroupFilterPayloadFilterInput	Filters appointments by appointment group.
appointmentType	AppointmentTypeFilterPayloadFilterInput	Filters appointments by appointment type.

AppointmentPayloadSortInput

Represents sorting options for appointment payloads.

Field	Type	Description
isOnStatutoryRegisters	SortEnumType	Specifies sorting by whether the appointment appears on statutory registers.
notes	SortEnumType	Specifies sorting by notes.
auditDate	SortEnumType	Specifies sorting by audit date.
eventId	SortEnumType	Specifies sorting by event identifier.
eventDate	SortEnumType	Specifies sorting by event date.
otherEventDate	SortEnumType	Specifies sorting by other event date.
level	SortEnumType	Specifies sorting by appointment level.
isNotAttendee	SortEnumType	Specifies sorting by the ‘not attendee’ flag.
reminder	SortEnumType	Specifies sorting by reminder setting.
isActive	SortEnumType	Specifies sorting by active status.
appointmentStatus	AppointmentStatusPayloadSortInput	Specifies sorting by appointment status.
appointmentGroup	AppointmentGroupPayloadSortInput	Specifies sorting by appointment group.
appointmentType	AppointmentTypePayloadSortInput	Specifies sorting by appointment type.

AppointmentStatusFilterPayloadFilterInput

A filter used to narrow down appointment statuses based on attributes like reference, name, or entity type.

Field	Type	Description
and	[AppointmentStatusFilterPayloadFilterInput!]
or	[AppointmentStatusFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering appointment status data.
reference	QueryCommonStringOperationFilterInput	Filters appointment statuses by a unique reference identifier.
name	QueryCommonStringOperationFilterInput	Filters appointment statuses by their name.
priority	QueryCommonIntegerOperationFilterInput	Filters by priority.
entityType	EntityTypeFilterPayloadFilterInput	Filters appointment statuses based on the type of entity they are associated with (e.g., individual or company).

AppointmentStatusPayloadSortInput

Represents sorting options for appointment status payloads.

Field	Type	Description
priority	SortEnumType	Specifies sorting by priority.
reference	SortEnumType	Specifies sorting by reference.
name	SortEnumType	Specifies sorting by name.

AppointmentTypeFilterPayloadFilterInput

A filter used to narrow down appointment types based on specific criteria such as reference, name, or category.

Field	Type	Description
and	[AppointmentTypeFilterPayloadFilterInput!]
or	[AppointmentTypeFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering appointment type data.
reference	QueryCommonStringOperationFilterInput	Filters appointment types by a unique reference identifier.
name	QueryCommonStringOperationFilterInput	Filters appointment types by their name.
priority	QueryCommonIntegerOperationFilterInput	Filters by priority.
isHidden	QueryCommonBooleanOperationFilterInput	Filters appointment types based on whether they are hidden from the user interface or active for selection.
isNotInCompanyTypes	QueryCommonBooleanOperationFilterInput	Filters appointment types not belonging to the specified company types.
appointmentCategory	AppointmentCategoryFilterPayloadFilterInput	Represents the appointment category associated with a filtered appointment type.
entityType	EntityTypeFilterPayloadFilterInput	Filters appointment types based on their entity type.

AppointmentTypePayloadSortInput

Represents sorting options for appointment type payloads.

Field	Type	Description
priority	SortEnumType	Specifies sorting by priority.
reference	SortEnumType	Specifies sorting by reference.
name	SortEnumType	Specifies sorting by name.
isHidden	SortEnumType	Specifies sorting by hidden status.
isNotInCountryCodes	SortEnumType	Specifies sorting by exclusion from country codes.
isNotInCompanyTypes	SortEnumType	Specifies sorting by exclusion from company types.
appointmentCategory	AppointmentCategoryPayloadSortInput	Specifies sorting by appointment category.

AuditTrailPayloadFilterInput

Filter input for audit trail entries, enabling filtering by identifiers, dates, users, entities, and event metadata.

Field	Type	Description
and	[AuditTrailPayloadFilterInput!]
or	[AuditTrailPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filters audit trail entries by their unique identifier.
auditDate	QueryCommonDateTimeOperationFilterInput	Filters audit trail entries by the audit action timestamp.
eventDate	QueryCommonDateTimeOperationFilterInput	Filters audit trail entries by the effective event date.
notes	QueryCommonStringOperationFilterInput	Filters audit trail entries by notes or comments.
user	UserPayloadFilterInput	Filters audit trail entries by the user who performed the action.
entity	EntityBaseFilterPayloadFilterInput	Filters audit trail entries by the primary entity involved.
otherEntity	EntityBaseFilterPayloadFilterInput	Filters audit trail entries by any secondary/related entity.
eventType	EventTypePayloadFilterInput	Filters audit trail entries by the type of event (e.g., create, update, delete).

AuditTrailPayloadSortInput

Specifies sorting options for audit trail entries.

Field	Type	Description
auditDate	SortEnumType	Sorts audit trail entries by the audit action timestamp.
eventDate	SortEnumType	Sorts audit trail entries by the effective event date.
notes	SortEnumType	Sorts audit trail entries by notes or comments.
user	UserPayloadSortInput	Sorts audit trail entries by the user who performed the action.
entity	EntityPayloadSortInput	Sorts audit trail entries by the primary entity involved.
otherEntity	EntityPayloadSortInput	Sorts audit trail entries by any secondary/related entity.
eventType	EventTypePayloadSortInput	Sorts audit trail entries by the event type.

CompanyFilterPayloadFilterInput

An input object used to filter results when querying company data, allowing for narrowing down results based on various attributes like entity type, incorporation date, or status.

Field	Type	Description
and	[CompanyFilterPayloadFilterInput!]
or	[CompanyFilterPayloadFilterInput!]
id	IdOperationFilterInput	Represents the unique identifier for filtering company data.
entityName	QueryCommonStringOperationFilterInput	Filters based on the company's name or a partial match of the name.
entityReference	QueryCommonStringOperationFilterInput	Filters based on the unique reference code assigned to the company.
entityType	EntityTypeFilterPayloadFilterInput	Filters based on the type of entity, whether it's a company, partnership, trust, or other forms of legal entities.
country	CountryFilterPayloadFilterInput	Filters companies based on the country where they are registered or operate.
subCountry	SubCountryFilterPayloadFilterInput	Filters based on subdivisions within a country, such as states, provinces, or regions.
personOptions	PersonOptionsFilterPayloadFilterInput	Filters based on the options or preferences associated with individuals related to the company, such as directors or officers.
managedBy	UserPayloadFilterInput	Filters companies based on the user or system managing their records, used for administrative purposes.
partner	PartnerFilterPayloadFilterInput	Represents the partner associated with a filtered company.
incorporationDate	QueryCommonDateOperationFilterInput	Filters companies based on their incorporation date, often used to query entities that were established within a certain time frame.
currentAccountingPeriodEndDate	QueryCommonDateOperationFilterInput	Filters companies by their current accounting period end date, which is key for financial reporting and compliance.
isHistoricalRecord	QueryCommonBooleanOperationFilterInput	A boolean filter used to include or exclude entities that are no longer active, such as dissolved or merged companies.
isLive	QueryCommonBooleanOperationFilterInput	Filters companies based on their live or active status, returning only those that are currently operating.
companyNumber	QueryCommonStringOperationFilterInput	Filters companies by their registration/company number.
hasDormantCompanyResolution	QueryCommonBooleanOperationFilterInput	Filters companies by whether a dormant company resolution exists.
dormantCompanyResolutionPassedOn	QueryCommonDateOperationFilterInput	Filters companies by the date a dormant company resolution was passed.
hasStandardDormantAccounts	QueryCommonBooleanOperationFilterInput	Filters companies by whether standard dormant accounts are used.
fileReference	QueryCommonStringOperationFilterInput	Filters companies by their file reference.
updatedAt	QueryCommonDateTimeOperationFilterInput	Filters by updated at.
companyStatus	CompanyStatusFilterPayloadFilterInput	Filters companies based on their operational status, such as 'Active', 'Dormant', or 'Dissolved'.
companyType	CompanyTypeFilterPayloadFilterInput	Filters based on the legal structure of the company, such as 'Limited', 'Public Limited Company', or 'LLP'.
currency	CurrencyFilterPayloadFilterInput	Filters based on the currency that the company primarily operates in, used in financial reporting and transactions.
userGrouping	UserGroupingFilterPayloadFilterInput	Filters companies by the associated user grouping.
udf	UdfFilterInput	Filters by udf.

CompanyPayloadSortInput

Input type for company payload sort.

Field	Type	Description
entityReference	SortEnumType	Specifies sorting by entity reference.
updatedAt	SortEnumType	Specifies sorting by updated at.
entityName	SortEnumType	Specifies sorting by entity name.
isHistoricalRecord	SortEnumType	Specifies sorting by is historical record.
companyNumber	SortEnumType	Specifies sorting by company number.
incorporationDate	SortEnumType	Specifies sorting by incorporation date.
dissolvedDate	SortEnumType	Specifies sorting by dissolved date.
lastAccountingPeriodEndDate	SortEnumType	Specifies sorting by last accounting period end date.
currentAccountingPeriodEndDate	SortEnumType	Specifies sorting by current accounting period end date.
lastAccountingPeriodExtendedDate	SortEnumType	Specifies sorting by last accounting period extended date.
industrialClassificationOther	SortEnumType	Specifies sorting by industrial classification other.
lastAccountsDate	SortEnumType	Specifies sorting by last accounts date.
accountsSignedDate	SortEnumType	Specifies sorting by accounts signed date.
accountsFiledDate	SortEnumType	Specifies sorting by accounts filed date.
isAccountsFiledOverridden	SortEnumType	Specifies sorting by is accounts filed overridden.
accountsInReviewDate	SortEnumType	Specifies sorting by accounts in review date.
nextAccountsDate	SortEnumType	Specifies sorting by next accounts date.
accountsOverdueDate	SortEnumType	Specifies sorting by accounts overdue date.
isAccountsOverdueOverridden	SortEnumType	Specifies sorting by is accounts overdue overridden.
hasAccountsOverseasExtension	SortEnumType	Specifies sorting by has accounts overseas extension.
lastMembersScheduleDate	SortEnumType	Specifies sorting by last members schedule date.
lastAnnualReturnDate	SortEnumType	Specifies sorting by last annual return date.
annualReturnSignedDate	SortEnumType	Specifies sorting by annual return signed date.
annualReturnFiledDate	SortEnumType	Specifies sorting by annual return filed date.
nextAnnualReturnDate	SortEnumType	Specifies sorting by next annual return date.
isNextAnnualReturnDateAutomatic	SortEnumType	Specifies sorting by is next annual return date automatic.
annualReturnOverdueDate	SortEnumType	Specifies sorting by annual return overdue date.
isMembersScheduleAsRequired	SortEnumType	Specifies sorting by is members schedule as required.
isMembersScheduleNotOnPaper	SortEnumType	Specifies sorting by is members schedule not on paper.
lastAnnualMeetingDate	SortEnumType	Specifies sorting by last annual meeting date.
annualMeetingMinutesSignedDate	SortEnumType	Specifies sorting by annual meeting minutes signed date.
nextAnnualMeetingDate	SortEnumType	Specifies sorting by next annual meeting date.
isNextAnnualMeetingDateAutomatic	SortEnumType	Specifies sorting by is next annual meeting date automatic.
annualMeetingOverdueDate	SortEnumType	Specifies sorting by annual meeting overdue date.
lastMeetingApproveAccountsDate	SortEnumType	Specifies sorting by last meeting approve accounts date.
meetingApproveAccountsMinutesSignedDate	SortEnumType	Specifies sorting by meeting approve accounts minutes signed date.
financialPeriodFromDate	SortEnumType	Specifies sorting by financial period from date.
financialPeriodToDate	SortEnumType	Specifies sorting by financial period to date.
isFinancialPeriodAutomatic	SortEnumType	Specifies sorting by is financial period automatic.
becameSingleMemberCompanyOnDate	SortEnumType	Specifies sorting by became single member company on date.
registeredEmailAddress	SortEnumType	Specifies sorting by registered email address.
documentReference	SortEnumType	Specifies sorting by document reference.
isLive	SortEnumType	Specifies sorting by is live.
hasDormantCompanyResolution	SortEnumType
dormantCompanyResolutionPassedOn	SortEnumType
hasStandardDormantAccounts	SortEnumType
fileReference	SortEnumType
country	CountryPayloadSortInput	Specifies sorting by country.
currency	CurrencyPayloadSortInput	Specifies sorting by currency.
companyType	CompanyTypePayloadSortInput	Specifies sorting by company type.
companyStatus	CompanyStatusPayloadSortInput	Specifies sorting by company status.
udf	UdfOrderSortInput	Specifies sorting by udf.

CompanyStatusFilterPayloadFilterInput

Filters companies by status-related attributes like reference, name, or entity type.

Field	Type	Description
and	[CompanyStatusFilterPayloadFilterInput!]
or	[CompanyStatusFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering company status data.
reference	QueryCommonStringOperationFilterInput	Filters by the reference code assigned to a company’s status.
name	QueryCommonStringOperationFilterInput	Filters by the name of the company status (e.g., 'Active', 'Dissolved').
entityType	EntityTypeFilterPayloadFilterInput	Filters by the entity type, such as 'Company' or 'Partnership'.

CompanyStatusPayloadSortInput

Sort companies based on their operational status.

Field	Type	Description
priority	SortEnumType	Sort company statuses by their assigned priority level.
reference	SortEnumType	Sort company statuses by their reference code.
name	SortEnumType	Sort company statuses by their name (e.g., Active, Dissolved).

CompanyTypeFilterPayloadFilterInput

Filters companies based on their specific type.

Field	Type	Description
and	[CompanyTypeFilterPayloadFilterInput!]
or	[CompanyTypeFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering company type data.
reference	QueryCommonStringOperationFilterInput	Filters based on a reference identifier for the company type.
name	QueryCommonStringOperationFilterInput	Filters based on the company type's name.
countryIds	QueryIdListOperationFilterInput	Filter company types by the country codes where they are applicable.
isHidden	QueryCommonBooleanOperationFilterInput	A boolean filter to exclude or include hidden companies from the results.
isNotInCountries	QueryCommonBooleanOperationFilterInput	Filters by is not in countries.
isNotInCountryCodes	QueryCommonBooleanOperationFilterInput	Filters companies that are not registered in the specified countries.
entityType	EntityTypeFilterPayloadFilterInput	Filters companies by their entity type (e.g., company, trust, partnership).

CompanyTypePayloadSortInput

Sort company types based on their attributes.

Field	Type	Description
priority	SortEnumType	Sort company types by their assigned priority level.
reference	SortEnumType	Sort company types by their reference code.
name	SortEnumType	Sort company types by their name (e.g., Limited, PLC).

ConnectAddressToEntityInput

Input type for connect address to entity.

Field	Type	Description
entityId	ID!	The entity id value for this input.
addressTypeId	ID!	The address type id value for this input.
addressId	ID!	The address id value for this input.

ConnectEntitiesToEntityBatchInput

Input type used to associate entities with a specific entity batch.

Field		Type	Description
entityIds		[ID!]!	Entity ids to connect to the entity batch.

ConnectEntitiesToEntitySecurityGroupInput

Input type used to associate entities with a specified security group.

Field		Type	Description
entityIds		[ID!]!	Entity ids to connect to the entity security group.
entitySecurityGroupsAppliesTo		SecurityGroupAppliesToInput	Security group applies-to settings to connect.

ConnectEntitiesToEntitySetInput

Input type used to associate entities with a specified entity set.

Field		Type	Description
entityIds		[ID!]!	The entity ids to connect to an entity set.

ConnectEntityBatchesToEntityInput

Input type used to associate entity batches with a specific entity.

Field		Type	Description
entityBatches		[ID!]!	Entity batches to connect to another entity.

ConnectEntitySecurityGroupsToEntityInput

Input type used to associate one or more security groups with an entity.

Field		Type	Description
entitySecurityGroups		[ID!]!	Entity security groups to connect to another entity.
entitySecurityGroupsAppliesTo		SecurityGroupAppliesToInput	Applies-to settings for the entity security groups to connect.

ConnectEntitySetsToEntityInput

Input type used to associate one or more entity sets with an entity.

Field		Type	Description
entitySets		[ID!]!	The entity sets to connect to another entity.

ConnectEntityTypeToAddressTypeInput

Input type for connecting an entity type to an address type.

Field	Type	Description
entityTypeId	ID!	The entity type ID to connect to the address type.
sequence	Int!	The display sequence for the connected address type.
isRequired	Boolean!	Indicates whether the address type is required for the entity type.

CorporateRelationshipControlByEnumOperationFilterInput

Filter corporate relationships based on control-by enumeration operations.

Field	Type	Description
eq	CorporateRelationshipControlBy	Filter corporate relationships where the control-by value equals the specified value.
neq	CorporateRelationshipControlBy	Filter corporate relationships where the control-by value does not equal the specified value.
in	[CorporateRelationshipControlBy!]	Filter corporate relationships where the control-by value is within a specified list.
nin	[CorporateRelationshipControlBy!]	Filter corporate relationships where the control-by value is not within a specified list.

CorporateRelationshipFilterPayloadFilterInput

Filter corporate relationships based on attributes like control, dates, and entities involved.

Field	Type	Description
and	[CorporateRelationshipFilterPayloadFilterInput!]
or	[CorporateRelationshipFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filter corporate relationships by their unique identifier.
description	QueryCommonStringOperationFilterInput	Filter corporate relationships by their description.
priority	CorporateRelationshipPriorityEnumOperationFilterInput	Filter corporate relationships by their assigned priority level.
fromRelationship	QueryCommonStringOperationFilterInput	Filter relationships by the type of relationship from the source entity.
toRelationship	QueryCommonStringOperationFilterInput	Filter relationships by the type of relationship to the target entity.
fromDate	QueryCommonDateTimeOperationFilterInput	Filter relationships by the start date of the relationship.
toDate	QueryCommonDateTimeOperationFilterInput	Filter relationships by the end date of the relationship.
control	QueryCommonDecimalOperationFilterInput	Filter relationships based on control attributes.
controlBy	CorporateRelationshipControlByEnumOperationFilterInput	Filter relationships based on who exercises control.
fromEntity	EntityBaseFilterPayloadFilterInput	Filter relationships by the source entity.
childEntity	EntityBaseFilterPayloadFilterInput	Filter relationships by the target or child entity.
corporateStructure	CorporateStructureFilterPayloadFilterInput	Filter relationships by the corporate structure type.

CorporateRelationshipPayloadSortInput

Represents corporate relationship payload sort input type.

Field	Type	Description
description	SortEnumType	Specifies sorting by description.
priority	SortEnumType	Specifies sorting by priority.
fromRelationship	SortEnumType	Specifies sorting by from relationship.
toRelationship	SortEnumType	Specifies sorting by to relationship.
fromDate	SortEnumType	Specifies sorting by from date.
toDate	SortEnumType	Specifies sorting by to date.
control	SortEnumType	Specifies sorting by control.
controlBy	SortEnumType	Specifies sorting by control by.
corporateStructure	CorporateStructurePayloadSortInput	Specifies sorting by corporate structure.
fromEntity	EntityPayloadSortInput	Specifies sorting by from entity.
childEntity	EntityPayloadSortInput	Specifies sorting by child entity.

CorporateRelationshipPriorityEnumOperationFilterInput

Filter corporate relationships based on priority enumeration operations.

Field	Type	Description
eq	CorporateRelationshipPriority	Filter corporate relationships where the priority equals the specified value.
neq	CorporateRelationshipPriority	Filter corporate relationships where the priority does not equal the specified value.
in	[CorporateRelationshipPriority!]	Filter corporate relationships where the priority is within a specified list.
nin	[CorporateRelationshipPriority!]	Filter corporate relationships where the priority is not within a specified list.

CorporateStructureFilterPayloadFilterInput

Filter corporate structures based on attributes like ID, reference, or name.

Field	Type	Description
and	[CorporateStructureFilterPayloadFilterInput!]
or	[CorporateStructureFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filter corporate structures by their unique identifier.
reference	QueryCommonStringOperationFilterInput	Filter corporate structures by their reference code.
name	QueryCommonStringOperationFilterInput	Filter corporate structures by their name.

CorporateStructurePayloadSortInput

Sort corporate structures based on attributes like priority, reference, or name.

Field	Type	Description
priority	SortEnumType	Sort corporate structures by their assigned priority level.
reference	SortEnumType	Sort corporate structures by their reference code.
name	SortEnumType	Sort corporate structures by their name.

CountryFilterPayloadFilterInput

Filters entities based on country-specific details.

Field	Type	Description
and	[CountryFilterPayloadFilterInput!]
or	[CountryFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering country data.
name	QueryCommonStringOperationFilterInput	Filters based on the name of the country.
countryCode	QueryCommonStringOperationFilterInput	Filters based on the two-letter or three-letter ISO country code.
countryCode3	QueryCommonStringOperationFilterInput	Filters based on the three-letter ISO country code (e.g., 'USA', 'GBR').
iso3166Description	QueryCommonStringOperationFilterInput	Filters by the ISO 3166 description, which is the international standard for country codes and codes of their subdivisions.
isEEA	QueryCommonBooleanOperationFilterInput	Filters by whether the country is part of the European Economic Area (EEA).
isUSA	QueryCommonBooleanOperationFilterInput	Filters by whether the country is the United States.

CountryPayloadSortInput

Specifies sorting options for country records.

Field		Type	Description
name		SortEnumType	Sorts countries by their full name.
countryCode		SortEnumType	Sorts countries by their two-letter ISO country code.

CreateAddressInput

Input type for creating an address.

Field	Type	Description
reference	String	The reference for the address to create.
street1	String!	The first address line for the address to create.
street2	String	The second address line for the address to create.
street3	String	The third address line for the address to create.
postTown	String!	The post town for the address to create.
area	String	The area or region for the address to create.
countryId	ID!	The country ID for the address to create.
postalCode	String!	The postal code for the address to create.
latitude	String	The latitude of the address to create.
longitude	String	The longitude of the address to create.
isShared	Boolean

CreateAddressTypeInput

Input type for creating an address type.

Field	Type	Description
reference	String!	The reference for the address type to create.
name	String!	The name for the address type to create.
isHeading	Boolean	Indicates whether the new address type is a heading.
isNameOnline	Boolean	Indicates whether the address type name is displayed online.
noRecordHeld	String!	The following text is inserted into the past address details if there is a gap between the cessation of one address, and the start of another address.
isNotInCountryCodes	Boolean	Indicates whether the address type is excluded from the specified countries.
countryIds	[ID!]	The country IDs associated with the address type to create.
isCompanyRecordsAddressType	Boolean	Indicates whether this is a company records address type.
isNotShared	Boolean	Indicates whether the address type is not shared.
isHidden	Boolean	Indicates whether the address type is hidden.
securityGroup	Int	The security group associated with the address type to create.

CreateCompanyInput

Input type used for creating a new company.

Field	Type	Description
eventDate	LocalDate	The event date for creating a company.
entityName	String!	The name of the entity for the company creation.
companyTypeId	ID	The company type ID for the company creation.
entityReference	String	The entity reference for the company creation.
companyNumber	String	The company number for the company creation.
incorporationDate	LocalDate	The incorporation date for the company creation.
companyStatusId	ID	The company status ID for the company creation.
countryId	ID!	The country ID for the company creation.
subCountryId	ID	The sub-country ID for the company creation.
udfs	[UdfInput!]	The udfs value for this input.
pendingData	PendingDataInput

CreateCompanyStatusInput

Input type used for creating a new company status.

Field	Type	Description
reference	String!	The reference for creating a new company status.
name	String!	The name for creating a new company status.
entityTypeId	ID!	The entity type ID for creating a new company status.

CreateCompanyTypeInput

Input type used for creating a new company type.

Field	Type	Description
reference	String!	The reference for creating a new company type.
name	String!	The name for creating a new company type.
entityTypeId	ID!	The entity type ID for creating a new company type.
isNotInCountries	Boolean	Country codes excluded for the new company type.
countryIds	[ID!]	Country codes associated with the new company type.
isHidden	Boolean	Indicates if the new company type is hidden.

CreateDataLibraryInput

Input type for creating a data library record.

Field	Type	Description
entityId	ID!	The entity ID for the data library record to create.
dataLibraryTypeId	ID!	The data library type ID for the record to create.
parentDataLibraryId	ID	The parent data library ID for the record to create.
otherEntityIds	[ID!]	Other entity IDs to connect to the data library record to create.
assignedToId	ID	The assigned-to user ID for the data library record to create.
dataLibraryStatusId	ID	The data library status ID for the record to create.
reminderDate	LocalDate	Reminder date for the data library record to create.
notes	String!	Notes for the data library record to create.
dateFrom	LocalDate	The 'from' date for the data library record to create.
dateTo	LocalDate	The 'to' date for the data library record to create.
expiryDate	LocalDate	Expiry date for the data library record to create.
description	String!	Description for the data library record to create.
physicalLocation	String!	Physical location for the data library record to create.
electronicLocation	String!	Electronic location for the data library record to create.
isHistorical	Boolean!	Indicates whether the data library record to create is historical.
udfs	[UdfInput!]!	User-defined field values for the data library record to create.
pendingData	PendingDataInput	The pending data value for this input.

CreateEntityBatchInput

Input type used for creating a new entity batch.

Field	Type	Description
reference	String!	The reference for creating a new entity batch.
name	String!	The name for creating a new entity batch.
batchUserId	ID	The user ID for creating a new entity batch.

CreateEntityIdentificationInput

Input used to create a new entity identification.

Field	Type	Description
entityId	ID!	The entity ID the identification will be associated with.
entityIdentificationType	EntityIdentificationType!	The type of identification being created.
identification	String!	The actual identification value.

CreateEntitySecurityGroupInput

Input type used for creating a new entity security group.

Field	Type	Description
reference	String!	The reference for creating a new entity security group.
name	String!	The name for creating a new entity security group.
userRoleId	ID	Represents the user role identifier to associate when creating an entity security group.
liveReference	String	The live reference for the new entity security group.
entitySecurityGroupAuto	String	Indicates if the new entity security group is automatic.
entitySecurityGroupRollUp	EntitySecurityGroupRollUp	The roll-up setting for the new entity security group.
entitySecurityGroupApplies	String	The applies-to settings for the new entity security group.

CreateEntitySetInput

Input type used for creating a new entity set.

Field	Type	Description
reference	String!	The reference for creating a new entity set.
name	String!	The name for creating a new entity set.
appliesTo	[EntityTypeCategory!]	The set types for creating a new entity set.

CreateEntityTypeInput

Input type used for creating a new entity type.

Field		Type	Description
reference		String!	The reference for creating a new entity type.
name		String!	The name for creating a new entity type.

CreateGroupStructureInput

Input type for create group structure.

Field	Type	Description
entityId	ID	The entity id value for this input.
documentDate	DateTime	The document date value for this input.
storedStructureDescription	String	The stored structure description value for this input.
includeSavedFilterId	ID	The include saved filter id value for this input.
criteria	GroupStructureCriteriaInput	The criteria value for this input.

CreateIndividualInput

Input type used for creating a new individual record.

Field	Type	Description
eventDate	LocalDate	Specifies the event date for creating an individual input.
forenames	String!	Specifies the forenames for creating an individual input.
surname	String!	The surname of the individual being created.
displayAs	IndividualNameFormat!	The display name of the individual being created.
entityReference	String	A reference entity for the individual being created.
title	String	The title of the individual being created.
occupation	String	The occupation of the individual being created.
nationalityId	ID	The nationality ID for the individual being created.
dateOfBirth	LocalDate	The date of birth for the individual being created.
nationalIdentificationNumber	String	The national identification number of the individual.
passportNumber	String	The passport number of the individual.
countryId	ID	The country ID associated with the individual.
subCountryId	ID	The sub-country ID associated with the individual.
udfs	[UdfInput!]	The udfs value for this input.
pendingData	PendingDataInput

CreateNationalityInput

Input type used for creating a new nationality.

Field	Type	Description
name	String!	Specifies the name for creating a nationality input.
countryId	ID!	Specifies the country ID for creating a nationality input.
subCountryId	ID	Specifies the sub-country ID for creating a nationality input.

CreateOtherEntityInput

Input type used for creating a new type of entity.

Field	Type	Description
eventDate	LocalDate	Specifies the event date for creating another entity input.
entityName	String!	Specifies the entity name for creating another entity input.
entityTypeId	ID	Specifies the entity type ID for creating another entity input.
companyNumber	String	Specifies the company number for creating another entity input.
incorporationDate	LocalDate	Specifies the incorporation date for creating another entity input.
countryId	ID	Specifies the country ID for creating another entity input.
subCountryId	ID	Specifies the sub-country ID for creating another entity input.
entityReference	String	Specifies the entity reference for creating another entity input.
udfs	[UdfInput!]	The udfs value for this input.

CreatePartnerInput

Input type used for creating a new partner.

Field	Type	Description
reference	String!	Specifies the reference for creating a partner input.
name	String!	Specifies the name for creating a partner input.
initials	String	Specifies the initials for creating a partner input.

CreatePendingAppointmentBatchDataInput

Input type for creating pending appointment batch data.

Field	Type	Description
entityId	ID!	The entity ID for the pending appointment batch item to create.
eventDate	LocalDate	The event date for the pending appointment batch item to create.
jobTitle	String	The job title for the pending appointment batch item to create.
appointmentTypeIds	[ID!]!	The appointment type IDs for the batch item to create.
appointmentGroupId	ID	The appointment group ID for the batch item to create.
appointmentLevel	Int	The appointment level for the batch item to create.
appointmentStatusId	ID	The appointment status ID for the batch item to create.
appointmentReminderDate	LocalDate	The reminder date for the pending appointment batch item to create.
alternateToEntityId	ID	The entity ID of the person this pending appointment is an alternate to.

CreatePendingAppointmentInput

Input type for creating a pending appointment.

Field	Type	Description
entityId	ID!	The entity ID for the pending appointment to create.
boardMeetingDate	LocalDate	The board meeting date for the pending appointment to create.
consentToActGiven	Boolean	Indicates whether consent to act has been given.
doesNotAttendMeetings	Boolean	Indicates whether the appointee does not attend meetings.
notes	String	Notes for the pending appointment to create.
showNotesOnRegister	Boolean	Indicates whether notes should be shown on the register.
eventDate	LocalDate	The event date for the pending appointment to create.
trackingStatus	TrackingStatusInput!	Shared tracking-related input fields for pending event mutations.
signatoryStatus	SignatoryStatusInput	Shared signatory-related input fields for pending event mutations.
appointments	[CreatePendingAppointmentBatchDataInput!]!	Appointments to create for the pending appointment.

CreatePendingChangeJobTitleBatchDataInput

Input type for create pending change job title batch data.

Field	Type	Description
entityId	ID!	The entity id value for this input.
eventDate	LocalDate	The event date value for this input.
appointmentTypeIds	[ID!]	The appointment type ids value for this input.
jobTitle	String	The new job title for the appointee.

CreatePendingChangeJobTitleInput

Input type for create pending change job title.

Field	Type	Description
entityId	ID!	The entity id value for this input.
eventDate	LocalDate	The event date value for this input.
boardMeetingDate	LocalDate
trackingStatus	TrackingStatusInput!	Shared tracking-related input fields for pending event mutations.
signatoryStatus	SignatoryStatusInput	Shared signatory-related input fields for pending event mutations.
changeJobTitles	[CreatePendingChangeJobTitleBatchDataInput!]!	The change job title batch data for this input.

CreatePendingDeathBatchDataInput

Input type for create pending death batch data.

Field		Type	Description
entityId		ID!	The entity id value for this input.
eventDate		LocalDate	The event date value for this input.

CreatePendingDeathInput

Input type for create pending death.

Field	Type	Description
entityId	ID!	The entity id value for this input.
notes	String	The notes value for this input.
showNotesOnRegister	Boolean	The show notes on register value for this input.
eventDate	LocalDate	The event date value for this input.
trackingStatus	TrackingStatusInput!	Shared tracking-related input fields for pending event mutations.
signatoryStatus	SignatoryStatusInput	Shared signatory-related input fields for pending event mutations.
appointments	[CreatePendingDeathBatchDataInput!]!	The appointments value for this input.

CreatePendingRemovalBatchDataInput

Input type for create pending removal batch data.

Field	Type	Description
entityId	ID!	The entity id value for this input.
eventDate	LocalDate	The event date value for this input.
appointmentTypeIds	[ID!]!	The appointment type ids value for this input.

CreatePendingRemovalInput

Input type for create pending removal.

Field	Type	Description
entityId	ID!	The entity id value for this input.
boardMeetingDate	LocalDate	The board meeting date value for this input.
eventDate	LocalDate	The event date value for this input.
notes	String	The notes value for this input.
showNotesOnRegister	Boolean	The show notes on register value for this input.
trackingStatus	TrackingStatusInput!	Shared tracking-related input fields for pending event mutations.
signatoryStatus	SignatoryStatusInput	Shared signatory-related input fields for pending event mutations.
appointments	[CreatePendingRemovalBatchDataInput!]!	The appointments value for this input.

CreatePendingReplacementBatchDataInput

Input type for creating pending replacement batch data.

Field	Type	Description
entityId	ID!	The entity ID for the pending replacement batch item to create.
eventDate	LocalDate	The event date for the pending replacement batch item to create.
jobTitle	String	The job title for the pending replacement batch item to create.
appointmentTypeIds	[ID!]!	The appointment type IDs for the batch item to create.
appointmentGroupId	ID	The appointment group ID for the batch item to create.
appointmentLevel	Int	The appointment level for the batch item to create.
appointmentStatusId	ID	The appointment status ID for the batch item to create.
appointmentReminderDate	LocalDate	The reminder date for the pending replacement batch item to create.
replaceWithEntityId	ID!	The entity ID of the person this appointment replaces.

CreatePendingReplacementInput

Input type for creating a pending replacement.

Field	Type	Description
entityId	ID!	The entity ID for the pending replacement to create.
boardMeetingDate	LocalDate	The board meeting date for the pending replacement to create.
consentToActGiven	Boolean	Indicates whether consent to act has been given.
doesNotAttendMeetings	Boolean	Indicates whether the appointee does not attend meetings.
notes	String	Notes for the pending replacement to create.
showNotesOnRegister	Boolean	Indicates whether notes should be shown on the register.
eventDate	LocalDate	The event date for the pending replacement to create.
trackingStatus	TrackingStatusInput!	Shared tracking-related input fields for pending event mutations.
signatoryStatus	SignatoryStatusInput	Shared signatory-related input fields for pending event mutations.
appointments	[CreatePendingReplacementBatchDataInput!]!	Appointments to create for the pending replacement.

CreatePendingResignationBatchDataInput

Input type for creating pending resignation batch data.

Field	Type	Description
entityId	ID!	The entity ID for the pending resignation batch item to create.
eventDate	LocalDate	The event date for the pending resignation batch item to create.
appointmentTypeIds	[ID!]!	The appointment type IDs for the batch item to create.
alternateToEntityId	ID	The alternate entity ID for the pending resignation batch item to create.

CreatePendingResignationInput

Input type for creating a pending resignation.

Field	Type	Description
entityId	ID!	The entity ID for the pending resignation to create.
boardMeetingDate	LocalDate	The board meeting date for the pending resignation to create.
notes	String	Notes for the pending resignation to create.
showNotesOnRegister	Boolean	Indicates whether notes should be shown on the register.
eventDate	LocalDate	The event date for the pending resignation to create.
trackingStatus	TrackingStatusInput!	Shared tracking-related input fields for pending event mutations.
signatoryStatus	SignatoryStatusInput	Shared signatory-related input fields for pending event mutations.
appointments	[CreatePendingResignationBatchDataInput!]!	Resignations to create for the pending resignation.

CreatePendingShareClassInput

Input type for creating a pending share class.

Field	Type	Description
entityId	ID!	The entity ID for the pending share class to create.
eventDate	LocalDate!	The event date for the pending share class to create.
boardMeetingDate	LocalDate	The board meeting date for the pending share class to create.
resolutionForm	ResolutionForm	The enum value that specifies the form of the shareholders' resolution authorising the share class.
meetingNoticeDate	LocalDate	The meeting notice date, used when the resolution form is notice.
meetingDate	LocalDate	The meeting date, also used as the resolution passed date for written resolutions.
meetingTime	String	The text value for the meeting time, used when the resolution form is notice.
shareClassName	String!	The name of the share class to create.
notes	String	Notes for the pending share class to create.
showNotesOnRegister	Boolean	Indicates whether notes should be shown on the register.
shareClassCode	String	The short code for the share class (e.g. "ORD").
currencyId	ID	The ID value that identifies the currency of the share class.
authorisedShares	Float	The numeric value for the total number of authorised shares.
authorisedUnlimited	Boolean	A Boolean value indicating whether the authorised share quantity is unlimited.
issuedShares	Float	The numeric value for the total number of issued shares.
nominalValue	Float	The numeric value for the nominal (par) value per share.
noNominalValue	Boolean	A Boolean value indicating whether the share class has no par value.
authorisedCapital	Float	The numeric value for the total authorised capital in no-par mode.
issuedCapital	Float	The numeric value for the total issued capital in no-par mode.
nonCapital	Boolean	A Boolean value indicating whether these are non-capital shares.
capitalWeighting	Float	The numeric value for the capital weighting of the share class.
nonVoting	Boolean	A Boolean value indicating whether these are non-voting shares.
votesPerShare	Float	The numeric value for the number of votes per share.
weighting	Float	The numeric value for the voting weighting of the share class.
isPartlyPaid	Boolean	A Boolean value indicating whether the shares are partly paid.
partlyPaidNominalValueDue	Float	The numeric value for the nominal value due on partly-paid shares.
partlyPaidPremiumDue	Float	The numeric value for the share premium due on partly-paid shares.
wholePremium	Boolean	A Boolean value indicating whether the whole premium is due on partly-paid shares.
callMadeDate	LocalDate	The date the call was made, used when the shares are partly paid.
issuedSharesCash	Float	The numeric value for the portion of issued shares issued for cash consideration.
issuedSharesNonCash	Float	The numeric value for the portion of issued shares not issued for cash consideration.
rightsDescription	String	The text value describing the rights attached to the share class.
shareType	ShareType	The enum value that specifies the type of shares (Common, Preferred, Deferred, Other).
showShareholdersOnRegister	Boolean	A Boolean value indicating whether shareholders are shown on the Register of Members.
referenceNumber	Int	The numeric value for the next reference number to allocate to a share class of the issuing company.
applyCategoryNumbering	Boolean	A Boolean value indicating whether category-level numbering applies to allotments, transfers, and certificates for this share class.
useAutoShareClassReferenceNumber	Boolean	A Boolean value indicating whether the share class reference number is allocated automatically when the event is actioned instead of taken from shareClassReferenceNumber.
shareClassReferenceNumber	Int	The numeric value for the reference number of the share class itself. Must not be supplied together with useAutoShareClassReferenceNumber.
shareEventLabel	String	The text value for the share event label identifying the type of share event (used by Share Management when enabled). Maximum 12 characters.
trackingStatus	TrackingStatusInput!	Shared tracking-related input fields for pending event mutations.
signatoryStatus	SignatoryStatusInput	Shared signatory-related input fields for pending event mutations.

CreateSubCountryInput

Input type used for creating a new sub-country.

Field	Type	Description
subCountryCode	String!	Specifies the sub-country code for creating a sub-country input.
name	String!	Specifies the name for creating a sub-country input.
countryId	ID!	Specifies the country ID for creating a sub-country input.

CreateUserGroupingInput

Input type used for creating a new user grouping.

Field		Type	Description
reference		String!	Specifies the reference for creating a user grouping input.
description		String!	Specifies the description for creating a user grouping input.

CreateUserInput

Input type for create user.

Field	Type	Description
name	String!	The name value for this input.
initials	String	The initials value for this input.
networkId	String	The network id value for this input.
loginEmail	String!	The login email value for this input.
isDisabled	Boolean
isHidden	Boolean
defaultRoleId	ID!	The default role id value for this input.
securityGroupIds	[ID!]

CurrencyFilterPayloadFilterInput

Filters based on currency attributes.

Field	Type	Description
and	[CurrencyFilterPayloadFilterInput!]
or	[CurrencyFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering currency data.
reference	QueryCommonStringOperationFilterInput	Filters by the reference code for a currency.
name	QueryCommonStringOperationFilterInput	Filters by the name of the currency (e.g., 'Dollar', 'Euro').
currencyCode	QueryCommonStringOperationFilterInput	Filters by the official currency code (e.g., 'USD', 'EUR').
prefix	QueryCommonStringOperationFilterInput	Filters by the prefix symbol used before a currency (e.g., '$').
suffix	QueryCommonStringOperationFilterInput	Filters by the suffix symbol used after a currency (e.g., '€').
country	CountryFilterPayloadFilterInput	Filters currency data based on the associated country.

CurrencyPayloadSortInput

Specifies sorting options for currency records.

Field	Type	Description
currencyCode	SortEnumType	Sorts currencies by their official three-letter ISO currency code.
name	SortEnumType	Sorts currencies by their descriptive name (e.g., US Dollar, Euro).
prefix	SortEnumType	Sorts currencies by the prefix symbol used before the amount (e.g., $).
suffix	SortEnumType	Sorts currencies by the suffix symbol used after the amount (e.g., €).
reference	SortEnumType	Sorts currencies by their reference code.
country	CountryPayloadSortInput	Sorts currencies by the associated country.

DataLibraryCategoryPayloadFilterInput

Represents filtering options for data library categories.

Field	Type	Description
and	[DataLibraryCategoryPayloadFilterInput!]
or	[DataLibraryCategoryPayloadFilterInput!]
id	IdOperationFilterInput	Specifies filtering by ID.
priority	QueryCommonIntegerOperationFilterInput	Specifies filtering by priority.
name	QueryCommonStringOperationFilterInput	Specifies filtering by name.
reference	QueryCommonStringOperationFilterInput	Specifies filtering by reference.
isHidden	QueryCommonBooleanOperationFilterInput	Specifies filtering by hidden status.

DataLibraryCategoryPayloadSortInput

Represents sorting options for data library categories.

Field	Type	Description
name	SortEnumType	Specifies sorting by name.
reference	SortEnumType	Specifies sorting by reference.
priority	SortEnumType	Specifies sorting by priority.
isHidden	SortEnumType	Specifies sorting by hidden status.

DataLibraryPayloadFilterInput

Filter input for Data Library records, enabling filtering by identifiers, metadata, dates, status, and related entities.

Field	Type	Description
and	[DataLibraryPayloadFilterInput!]
or	[DataLibraryPayloadFilterInput!]
id	IdOperationFilterInput	Filters Data Library records by their unique identifier.
priority	QueryCommonIntegerOperationFilterInput	Filters Data Library records by their display or processing priority.
reference	QueryCommonIntegerOperationFilterInput	Filters Data Library records by their reference code.
recordAccessGroup	QueryCommonIntegerOperationFilterInput	Filters Data Library records by the access group assigned to them.
description	QueryCommonStringOperationFilterInput	Filters Data Library records by their description text.
notes	QueryCommonStringOperationFilterInput	Filters Data Library records by notes or additional comments.
physicalLocation	QueryCommonStringOperationFilterInput	Filters Data Library records by their physical storage location.
electronicLocation	QueryCommonStringOperationFilterInput	Filters Data Library records by their electronic storage location.
versionNumber	QueryCommonStringOperationFilterInput	Filters Data Library records by their version number.
changedAt	QueryCommonDateTimeOperationFilterInput	Filters Data Library records by the timestamp of last change.
auditDate	QueryCommonDateTimeOperationFilterInput	Filters Data Library records by their audit date.
dateFrom	QueryCommonDateTimeOperationFilterInput	Filters by date from.
dateTo	QueryCommonDateTimeOperationFilterInput	Filters Data Library records by their 'to' date field.
reminderDate	QueryCommonDateTimeOperationFilterInput	Filters Data Library records by their reminder date.
expiryDate	QueryCommonDateTimeOperationFilterInput	Filters Data Library records by their expiry date.
signedOn	QueryCommonDateTimeOperationFilterInput	Filters Data Library records by the date they were signed.
rolledOverDate	QueryCommonDateTimeOperationFilterInput	Filters Data Library records by the date they were rolled over.
isPending	QueryCommonBooleanOperationFilterInput	Filters Data Library records based on whether they are pending.
isHistorical	QueryCommonBooleanOperationFilterInput	Filters Data Library records based on whether they are historical.
isLocked	QueryCommonBooleanOperationFilterInput	Filters Data Library records based on whether they are locked.
isRolledOver	QueryCommonBooleanOperationFilterInput	Filters Data Library records based on whether they have been rolled over.
type	DataLibraryTypePayloadFilterInput	Filters Data Library records by their type.
entity	EntityBaseFilterPayloadFilterInput	Filters Data Library records by the associated entity.
status	DataLibraryStatusPayloadFilterInput	Filters Data Library records by their status.
country	CountryFilterPayloadFilterInput	Filters Data Library records by the associated country.
subCountry	SubCountryFilterPayloadFilterInput	Filters Data Library records by the associated sub-country.
auditUser	UserPayloadFilterInput	Filters Data Library records by the user who performed the audit.
assignedTo	UserPayloadFilterInput	Filters Data Library records by the user assigned to them.
parent	DataLibraryPayloadFilterInput	Filters Data Library records by their parent record.
signedBy	UserPayloadFilterInput	Filters Data Library records by the user who signed them.

DataLibraryPayloadSortInput

Represents sorting options for data library payloads.

Field	Type	Description
priority	SortEnumType	Specifies sorting by priority.
reference	SortEnumType	Specifies sorting by reference.
recordAccessGroup	SortEnumType	Specifies sorting by record access group.
description	SortEnumType	Specifies sorting by description.
notes	SortEnumType	Specifies sorting by notes.
physicalLocation	SortEnumType	Specifies sorting by physical location.
electronicLocation	SortEnumType	Specifies sorting by electronic location.
versionNumber	SortEnumType	Specifies sorting by version number.
changedAt	SortEnumType	Specifies sorting by the last changed timestamp.
auditDate	SortEnumType	Specifies sorting by audit date.
dateFrom	SortEnumType	Specifies sorting by date from.
dateTo	SortEnumType	Specifies sorting by end date.
reminderDate	SortEnumType	Specifies sorting by reminder date.
expiryDate	SortEnumType	Specifies sorting by expiry date.
signedOn	SortEnumType	Specifies sorting by signature date.
rolledOverDate	SortEnumType	Specifies sorting by date of rollover.
isPending	SortEnumType	Specifies sorting by pending status.
isHistorical	SortEnumType	Specifies sorting by historical status.
isLocked	SortEnumType	Specifies sorting by locked status.
isRolledOver	SortEnumType	Specifies sorting by rolled over status.
type	DataLibraryTypePayloadSortInput	Specifies sorting by type.
entity	EntityPayloadSortInput	Specifies sorting by entity.
status	DataLibraryStatusPayloadSortInput	Specifies sorting by status.
country	CountryPayloadSortInput	Specifies sorting by country.
subCountry	SubCountryPayloadSortInput	Specifies sorting by sub-country.
auditUser	UserPayloadSortInput	Specifies sorting by audit user.
assignedTo	UserPayloadSortInput	Specifies sorting by assignee.
parent	DataLibraryPayloadSortInput	Specifies sorting by parent entity.
signedBy	UserPayloadSortInput	Specifies sorting by who signed the record.

DataLibraryStatusPayloadFilterInput

Represents filtering options for data library statuses.

Field	Type	Description
and	[DataLibraryStatusPayloadFilterInput!]
or	[DataLibraryStatusPayloadFilterInput!]
id	IdOperationFilterInput	Specifies filtering by ID.
priority	QueryCommonIntegerOperationFilterInput	Specifies filtering by priority.
name	QueryCommonStringOperationFilterInput	Specifies filtering by name.
reference	QueryCommonStringOperationFilterInput	Specifies filtering by reference.

DataLibraryStatusPayloadSortInput

Represents sorting options for data library statuses.

Field	Type	Description
name	SortEnumType	Specifies sorting by name.
reference	SortEnumType	Specifies sorting by reference.
priority	SortEnumType	Specifies sorting by priority.

DataLibraryTypePayloadFilterInput

Represents filtering options for data library types.

Field	Type	Description
and	[DataLibraryTypePayloadFilterInput!]
or	[DataLibraryTypePayloadFilterInput!]
id	IdOperationFilterInput	Specifies filtering by ID.
priority	QueryCommonIntegerOperationFilterInput	Specifies filtering by priority.
name	QueryCommonStringOperationFilterInput	Specifies filtering by name.
reference	QueryCommonStringOperationFilterInput	Specifies filtering by reference.
rolloverStatus	QueryCommonStringOperationFilterInput	Specifies filtering by rollover status.
systemPredefined	QueryCommonBooleanOperationFilterInput	Specifies filtering by system predefined values.
showStatus	QueryCommonBooleanOperationFilterInput	Specifies filtering by show status.
allowPending	QueryCommonBooleanOperationFilterInput	Specifies filtering by whether pending status is allowed.
isEntityRequired	QueryCommonBooleanOperationFilterInput	Specifies filtering by whether specifying an entity is mandatory.
allowConnected	QueryCommonBooleanOperationFilterInput	Specifies filtering by whether connections are allowed.
allowOtherConnectedEntities	QueryCommonBooleanOperationFilterInput	Specifies filtering by whether other connected entities are allowed.
allowAssignedTo	QueryCommonBooleanOperationFilterInput	Specifies filtering by whether assignation is allowed.
isNotInCountryCodes	QueryCommonBooleanOperationFilterInput	Filters data libraries which are not in the listed countries.
usageType	QueryDataLibraryUsageTypeEnumOperationFilterInput	Specifies filtering data library types by usage type.
dataLibraryCategory	DataLibraryCategoryPayloadFilterInput	Specifies filtering data library types by data library category.

DataLibraryTypePayloadSortInput

Represents sorting options for data library types.

Field	Type	Description
name	SortEnumType	Specifies sorting by the Data Library type name/description.
reference	SortEnumType	Specifies sorting by the Data Library type quick reference code.
rolloverStatus	SortEnumType	Specifies sorting by the status applied during rollover for this type (if configured).
priority	SortEnumType	Specifies sorting by priority.
systemPredefined	SortEnumType	Specifies sorting by whether this is a system‑predefined Data Library type.
showStatus	SortEnumType	Specifies sorting by whether status is enabled for this type.
allowPending	SortEnumType	Specifies sorting by whether records of this type can be saved as Pending.
isEntityRequired	SortEnumType	Specifies sorting by whether an entity is required for records of this type.
allowConnected	SortEnumType	Specifies sorting by whether other records can be connected to this one.
allowOtherConnectedEntities	SortEnumType	Specifies sorting by whether other connected entities are enabled.
allowAssignedTo	SortEnumType	Specifies sorting by whether 'Assigned To' is enabled for this type.
isNotInCountryCodes	SortEnumType	Specifies sorting by the flag that excludes this type from selected countries.
usageType	SortEnumType	Specifies sorting by the usage mode of the type (Data Library & Document Properties / Type Only / Document Properties Only).
dataLibraryCategory	DataLibraryCategoryPayloadSortInput	Specifies sorting by data library category.

DataLibraryUdfPayloadFilterInput

Filter input for Data Library user‑defined fields (UDFs), enabling filtering by attributes such as reference, name/short name, data type, applicability (countries, entity types), visibility, access group, default/save formulas, display conditions, connection options, and rollover settings.

Field	Type	Description
and	[DataLibraryUdfPayloadFilterInput!]
or	[DataLibraryUdfPayloadFilterInput!]
id	IdOperationFilterInput	Filters user-defined fields by their unique identifier.
name	QueryCommonStringOperationFilterInput	Filters user-defined fields by their descriptive name.
priority	QueryCommonIntegerOperationFilterInput	Filters user-defined fields by their display or processing priority.
shortName	QueryCommonStringOperationFilterInput	Filters user-defined fields by their short name or alias.
countryIds	QueryIdListOperationFilterInput	Filters user-defined fields by the countries they apply to.
entityTypeIds	QueryIdListOperationFilterInput	Filters user-defined fields by the entity types they are associated with.
isSystemPredefined	QueryCommonBooleanOperationFilterInput	Filters user-defined fields based on whether they are system-predefined.
isRequired	QueryCommonBooleanOperationFilterInput	Filters user-defined fields based on whether they are mandatory.
reference	QueryCommonStringOperationFilterInput	Filters user-defined fields by their reference code.
storageLocation	StorageLocationEnumOperationFilterInput	Filters user-defined fields by their storage location or table number.
dataType	DataTypeEnumOperationFilterInput	Filters user-defined fields by their data type (e.g., text, number, date).
dataLibraryType	DataLibraryTypePayloadFilterInput	Filters user-defined fields by the Data Library type they belong to.

DataLibraryUdfPayloadSortInput

Specifies sorting options for user-defined fields within Data Library records.

Field	Type	Description
reference	SortEnumType	Sorts user-defined fields by their reference code.
priority	SortEnumType	Sorts user-defined fields by their display or processing priority.
name	SortEnumType	Sorts user-defined fields by their descriptive name.
shortName	SortEnumType	Sorts user-defined fields by their short name or alias.
storageLocation	SortEnumType	Sorts user-defined fields by their storage location or table number.
dataType	SortEnumType	Sorts user-defined fields by their data type (e.g., text, number, date).
isSystemPredefined	SortEnumType	Sorts user-defined fields based on whether they are system-predefined.
isRequired	SortEnumType	Sorts user-defined fields based on whether they are mandatory.

DataTypeEnumOperationFilterInput

Filter data types using enumeration-based operations.

Field	Type	Description
eq	DataType	Filter data types where the value equals the specified type.
neq	DataType	Filter data types where the value does not equal the specified type.
in	[DataType!]	Filter data types where the value is within a specified list.
nin	[DataType!]	Filter data types where the value is not within a specified list.

DeleteAddressInput

Input type for deleting an address.

Field		Type	Description
id		ID!	The ID of the address to delete.

DeleteAddressTypeInput

Input type for deleting an address type.

Field		Type	Description
id		ID!	The ID of the address type to delete.

DeleteCompanyInput

Input type used for specifying the details required to delete a company.

Field		Type	Description
id		ID!	The ID of the company to delete.

DeleteCompanyStatusInput

Input type used for specifying the details required to delete a company status.

Field		Type	Description
id		ID!	The ID of the company status to delete.

DeleteCompanyTypeInput

Input type used for specifying the details required to delete a company type.

Field		Type	Description
id		ID!	The ID of the company type to delete.

DeleteDataLibraryInput

Input type for deleting a data library record.

Field		Type	Description
id		ID!	The ID of the data library record to delete.

DeleteEntityBatchInput

Input type used for specifying the details required to delete an entity batch.

Field		Type	Description
id		ID!	The ID of the entity batch to delete.

DeleteEntityIdentificationInput

Input type used to specify which entity identification should be deleted.

Field		Type	Description
id		ID!	The unique identifier of the entity identification to delete.

DeleteEntitySecurityGroupInput

Represents an error encountered during the creation of an entity security group.

Field		Type	Description
id		ID!	The ID of the entity security group to delete.

DeleteEntitySetInput

Represents an error encountered during the creation of an entity set.

Field		Type	Description
id		ID!	The ID of the entity set to delete.

DeleteEntityTypeInput

Input type used for specifying the details required to delete an entity type.

Field		Type	Description
id		ID!	The ID of the entity type to delete.

DeleteIndividualInput

Input type used for specifying the details required to delete an individual.

Field		Type	Description
id		ID!	The ID of the individual to delete.

DeleteNationalityInput

Input type used for specifying the details required to delete a nationality.

Field		Type	Description
id		ID!	The ID of the nationality to delete.

DeleteOtherEntityInput

Input type used for specifying the details required to delete another type of entity.

Field		Type	Description
id		ID!	The ID of the other entity to delete.

DeletePartnerInput

Input type used for specifying the details required to delete a partner.

Field		Type	Description
id		ID!	The ID of the partner to delete.

DeletePendingEventBatchItemInput

Field		Type	Description
id		ID!
batchId		Int!

DeletePendingEventInput

Input type used for specifying the details required to delete a pending event.

Field		Type	Description
id		ID!	The ID of the pending event to delete.

DeleteSubCountryInput

Input type used for specifying the details required to delete a sub-country.

Field		Type	Description
id		ID!	The ID of the sub-country to delete.

DeleteUserGroupingInput

Input type used for specifying the details required to delete a user grouping.

Field		Type	Description
id		ID!	The ID of the user grouping to delete.

DeleteUserInput

Input type for delete user.

Field		Type	Description
id		ID!	The unique identifier.

DisconnectAddressFromEntityInput

Input type for disconnect address from entity.

Field	Type	Description
entityId	ID!	The entity id value for this input.
addressTypeId	ID!	The address type id value for this input.
addressId	ID!	The address id value for this input.

DisconnectEntitiesFromEntityBatchInput

Input type used to disconnect entities from a specified entity batch.

Field		Type	Description
entityIds		[ID!]!	Entity ids to disconnect from the entity batch.

DisconnectEntitiesFromEntitySecurityGroupInput

Input type used to disconnect entities from a specified security group.

Field		Type	Description
entityIds		[ID!]!	Entity ids to disconnect from the security group.
entitySecurityGroupsAppliesTo		SecurityGroupAppliesToInput	Security group applies-to settings to disconnect.

DisconnectEntitiesFromEntitySetInput

Input type used to disconnect entities from a specified entity set.

Field		Type	Description
entityIds		[ID!]!	The entity ids to disconnect from an entity set.

DisconnectEntityBatchesFromEntityInput

Input type used to disconnect one or more batches from an entity.

Field		Type	Description
entityBatches		[ID!]!	Entity batches to disconnect from another entity.

DisconnectEntitySecurityGroupsFromEntityInput

Input type used to disconnect one or more security groups from an entity.

Field		Type	Description
entitySecurityGroups		[ID!]!	Entity security groups to disconnect from another entity.
entitySecurityGroupsAppliesTo		SecurityGroupAppliesToInput	Applies-to settings for the security groups to disconnect.

DisconnectEntitySetsFromEntityInput

Input type used to disconnect one or more entity sets from an entity.

Field		Type	Description
entitySets		[ID!]!	The entity sets to disconnect from another entity.

DisconnectEntityTypeFromAddressTypeInput

Input type for disconnecting an entity type from an address type.

Field		Type	Description
entityTypeId		ID!	The entity type ID to disconnect from the address type.

DocumentPayloadFilterInput

Filter input for documents, enabling filtering by identifiers, metadata, status, and related entities.

Field	Type	Description
and	[DocumentPayloadFilterInput!]
or	[DocumentPayloadFilterInput!]
id	IdOperationFilterInput	Filters documents by their unique identifier.
fileName	QueryCommonStringOperationFilterInput	Filters documents by their file name.
reference	QueryCommonIntegerOperationFilterInput	Filters documents by their reference code.
documentType	QueryCommonStringOperationFilterInput	Filters documents by their type (e.g., PDF, Word).
createdAt	QueryCommonDateTimeOperationFilterInput	Filters documents by their creation timestamp.
documentDate	QueryCommonDateTimeOperationFilterInput	Filters documents by their associated document date.
status	DocumentStatusEnumOperationFilterInput	Filters by status.
signedAt	QueryCommonDateTimeOperationFilterInput	Filters by signed at.
entity	EntityBaseFilterPayloadFilterInput	Filters documents by the associated entity.
signedAs	AppointmentTypeFilterPayloadFilterInput	Filters by signed as.
signedBy	EntityBaseFilterPayloadFilterInput	Filters by signed by.

DocumentPayloadSortInput

Specifies sorting options for document records.

Field	Type	Description
fileName	SortEnumType	Sorts documents by their file name.
reference	SortEnumType	Sorts documents by their reference code.
documentType	SortEnumType	Sorts documents by their type.
createdAt	SortEnumType	Sorts documents by their creation timestamp.
documentDate	SortEnumType	Sorts documents by their associated document date.
signedAt	SortEnumType	Specifies sorting by signed at.
entity	EntityPayloadSortInput	Specifies sorting by entity.
signedAs	AppointmentTypePayloadSortInput	Specifies sorting by signed as.
signedBy	EntityPayloadSortInput	Specifies sorting by signed by.

DocumentStatusEnumOperationFilterInput

Input type for document status enum operation filter.

Field	Type	Description
eq	DocumentStatus	Filters by eq.
neq	DocumentStatus	Filters by neq.
in	[DocumentStatus!]	Filters by in.
nin	[DocumentStatus!]	Filters by nin.

EntityBaseFilterPayloadFilterInput

Provides a base filter for entities based on multiple attributes.

Field	Type	Description
and	[EntityBaseFilterPayloadFilterInput!]
or	[EntityBaseFilterPayloadFilterInput!]
id	IdOperationFilterInput	Represents the unique identifier for filtering base entity data.
entityName	QueryCommonStringOperationFilterInput	Filters entities based on their name.
entityReference	QueryCommonStringOperationFilterInput	Represents the entity reference associated with a filtered base entity.
entityType	EntityTypeFilterPayloadFilterInput	Filters entities by their type (e.g., individual, company).
country	CountryFilterPayloadFilterInput	Filters entities by the associated country.
subCountry	SubCountryFilterPayloadFilterInput	Filters entities based on sub-country regions.
personOptions	PersonOptionsFilterPayloadFilterInput	Filters entities based on available person-related options.
managedBy	UserPayloadFilterInput	Filters entities by their managing user or group.
partner	PartnerFilterPayloadFilterInput	Represents the partner associated with a filtered base entity.

EntityBatchFilterPayloadFilterInput

Filters entities based on batch attributes.

Field	Type	Description
and	[EntityBatchFilterPayloadFilterInput!]
or	[EntityBatchFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering entity batch payload data.
reference	QueryCommonStringOperationFilterInput	Filters by the reference code for a batch of entities.
name	QueryCommonStringOperationFilterInput	Filters by the name of the batch.
batchUser	UserPayloadFilterInput	Filters by the user associated with the batch.

EntityBatchPayloadSortInput

Input object specifying sorting options for entity batch queries.

Field	Type	Description
reference	SortEnumType	Sorts entity batches by their reference code.
priority	SortEnumType	Sorts entity batches by their assigned priority.
name	SortEnumType	Sorts entity batches by their name.
batchUser	UserPayloadSortInput	Sorts entity batches by the user associated with the batch.

EntityPayloadSortInput

Input object specifying sorting options for entity queries.

Field	Type	Description
entityReference	SortEnumType	Sorts entities by the entity's reference code.
entityName	SortEnumType	Sorts entities by the name of the entity.
entityType	EntityTypePayloadSortInput	Sorts entities by the type or classification of the entity.
country	CountryPayloadSortInput	Sorts entities by the country associated with the entity.
subCountry	SubCountryPayloadSortInput	Sorts entities by the sub-country (e.g., state or province) associated with the entity.

EntitySecurityGroupFilterPayloadFilterInput

Filters entities based on security group attributes.

Field	Type	Description
and	[EntitySecurityGroupFilterPayloadFilterInput!]
or	[EntitySecurityGroupFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering entity security group data.
reference	QueryCommonStringOperationFilterInput	Filters by the reference code for the security group.
name	QueryCommonStringOperationFilterInput	Filters by the name of the security group.
liveReference	QueryCommonStringOperationFilterInput	Filters by the live reference used in security group-related operations.
systemPredefined	QueryCommonBooleanOperationFilterInput	Filters based on whether the security group is predefined by the system.
entitySecurityGroupAuto	QueryCommonStringOperationFilterInput	Filters entities based on whether security groups are automatically assigned.
entitySecurityGroupRollUp	QueryCommonIntegerOperationFilterInput	Filters entity security groups by their roll-up settings.
entitySecurityGroupApplies	QueryCommonStringOperationFilterInput	Filters based on whether a specific security group applies to the entity.
userRole	UserRoleFilterPayloadFilterInput	Filters by the user role assigned within the security group.

EntitySecurityGroupPayloadSortInput

Input type for entity security group payload sort.

Field	Type	Description
reference	SortEnumType	Specifies sorting by reference.
name	SortEnumType	Specifies sorting by name.
liveReference	SortEnumType	Specifies sorting by live reference.
userRole	UserRolePayloadSortInput	Specifies sorting by user role.

EntitySetFilterPayloadFilterInput

Filters entities based on sets they belong to.

Field	Type	Description
and	[EntitySetFilterPayloadFilterInput!]
or	[EntitySetFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering entity set data.
reference	QueryCommonStringOperationFilterInput	Filters by the reference code for the entity set.
name	QueryCommonStringOperationFilterInput	Filters by the name of the entity set.
priority	QueryCommonIntegerOperationFilterInput	Filters by priority.
appliesTo	QueryEntityTypeCategoryListOperationFilterInput

EntitySetPayloadSortInput

Input type for entity set payload sort.

Field	Type	Description
reference	SortEnumType	Specifies sorting by reference.
name	SortEnumType	Specifies sorting by name.
priority	SortEnumType	Specifies sorting by priority.

EntityTypeFilterPayloadFilterInput

Filters entities based on their entity type, such as companies, trusts, or partnerships.

Field	Type	Description
and	[EntityTypeFilterPayloadFilterInput!]
or	[EntityTypeFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering entity type data.
reference	QueryCommonStringOperationFilterInput	Filters by the reference code for an entity type.
name	QueryCommonStringOperationFilterInput	Filters by the name of the entity type (e.g., 'Company', 'Trust').
priority	QueryCommonIntegerOperationFilterInput	Filters by priority.
systemDefined	QueryCommonBooleanOperationFilterInput	Filters by system defined.

EntityTypePayloadSortInput

Input object specifying sorting options for entity type payload queries.

Field	Type	Description
reference	SortEnumType	Sorts entity type payloads by their reference code.
name	SortEnumType	Sorts entity type payloads by their name.
priority	SortEnumType	Sorts entity type payloads by their assigned priority.
systemDefined	SortEnumType	Specifies sorting by system defined.

EventGroupPayloadFilterInput

Input object used to filter event group payloads based on specified criteria.

Field	Type	Description
and	[EventGroupPayloadFilterInput!]
or	[EventGroupPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filters event groups by their unique identifier.
reference	QueryCommonStringOperationFilterInput	Filters event groups by their reference code.
name	QueryCommonStringOperationFilterInput	Filters event groups by their name.

EventGroupPayloadSortInput

Input object specifying sorting options for event group payload queries.

Field		Type	Description
reference		SortEnumType	Sorts event group payloads by their reference code.
name		SortEnumType	Sorts event group payloads by their name.

EventTypePayloadFilterInput

Input object used to filter event type payloads based on specified criteria.

Field	Type	Description
and	[EventTypePayloadFilterInput!]
or	[EventTypePayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filters event types by their unique identifier.
reference	QueryCommonStringOperationFilterInput	Filters event types by their reference code.
name	QueryCommonStringOperationFilterInput	Filters event types by their name.
description	QueryCommonStringOperationFilterInput	Filters by description.
eventGroup	EventGroupPayloadFilterInput	Filters event types by the associated event group.

EventTypePayloadSortInput

Input object specifying sorting options for event type payload queries.

Field	Type	Description
reference	SortEnumType	Sorts event type payloads by their reference code.
name	SortEnumType	Sorts event type payloads by their name.
description	SortEnumType	Sorts event type payloads by their description.
eventGroupId	SortEnumType	Sorts event type payloads by the associated event group identifier.

FilterTypeEnumOperationFilterInput

Input type for filter type enum operation filter.

Field	Type	Description
eq	FilterType	Filters by eq.
neq	FilterType	Filters by neq.
in	[FilterType!]	Filters by in.
nin	[FilterType!]	Filters by nin.

GroupStructureCriteriaInput

Input type for group structure criteria.

Field	Type	Description
corporateStructureId	ID	The corporate structure id value for this input.
structureType	GroupStructureType	The structure type value for this input.
asAtDate	DateTime	The as at date value for this input.
ownershipMinPercentage	Decimal	The ownership min percentage value for this input.
ownershipMaxPercentage	Decimal	The ownership max percentage value for this input.

IdOperationFilterInput

Input object used to filter results based on ID operations, such as equality or inclusion.

Field	Type	Description
eq	ID	Filters records where the ID equals the provided value.
neq	ID	Filters records where the ID does not equal the provided value.
in	[ID]	Filters records where the ID is included in the provided list of values.
nin	[ID]	Filters records where the ID is not included in the provided list of values.

IndividualFilterPayloadFilterInput

Filters individual records based on various criteria, such as personal information or entity associations.

Field	Type	Description
and	[IndividualFilterPayloadFilterInput!]
or	[IndividualFilterPayloadFilterInput!]
id	IdOperationFilterInput	Represents the unique identifier for filtering individual data.
entityName	QueryCommonStringOperationFilterInput	Filters individuals based on the name of the entity they are associated with.
entityReference	QueryCommonStringOperationFilterInput	Represents the entity reference associated with a filtered individual.
entityType	EntityTypeFilterPayloadFilterInput	Filters individuals based on the type of entity they are associated with (e.g., company, partnership).
country	CountryFilterPayloadFilterInput	Filters individuals based on their country of residence or operation.
subCountry	SubCountryFilterPayloadFilterInput	Filters individuals based on subdivisions within a country, such as states or provinces.
personOptions	PersonOptionsFilterPayloadFilterInput	Filters based on various person-related options, such as additional roles or responsibilities.
managedBy	UserPayloadFilterInput	Filters individuals by the user or group managing their records.
partner	PartnerFilterPayloadFilterInput	Represents the partner associated with a filtered individual.
occupation	QueryCommonStringOperationFilterInput	Filters individuals by their occupation or profession.
dateOfBirth	QueryCommonDateOperationFilterInput	Filters individuals by their date of birth.
dateOfDeath	QueryCommonDateOperationFilterInput	Filters individuals by their date of death, often for historical records.
isHistoricalRecord	QueryCommonBooleanOperationFilterInput	A boolean filter that includes or excludes historical records of individuals.
nationality	NationalityFilterPayloadFilterInput	Filters individuals by their nationality.
udf	UdfFilterInput	Filters by udf.

IndividualPayloadSortInput

Input object specifying sorting options for individual payload queries.

Field	Type	Description
entityReference	SortEnumType	Sorts individual payloads by their entity reference code.
entityName	SortEnumType	Sorts individual payloads by their entity name.
updatedAt	SortEnumType	Sorts individual payloads by their last update timestamp.
forenames	SortEnumType	Sorts individual payloads by their forenames.
surname	SortEnumType	Sorts individual payloads by their surname.
sortName	SortEnumType	Sorts individual payloads by their sort name.
isHistoricalRecord	SortEnumType	Sorts individual payloads by whether they are historical records.
title	SortEnumType	Sorts individual payloads by their title.
honours	SortEnumType	Sorts individual payloads by their honours or distinctions.
salutation	SortEnumType	Sorts individual payloads by their salutation.
previousName	SortEnumType	Sorts individual payloads by their previous name.
occupation	SortEnumType	Sorts individual payloads by their occupation.
dateOfBirth	SortEnumType	Sorts individual payloads by their date of birth.
dateOfDeath	SortEnumType	Sorts individual payloads by their date of death.
nationalIdentificationNumber	SortEnumType	Sorts individual payloads by their national identification number.
passportNumber	SortEnumType	Sort individuals by their passport number.
country	CountryPayloadSortInput	Sort individuals by their country of residence or registration.
managedBy	UserPayloadSortInput	Sort individuals by the user or team managing their record.
udf	UdfOrderSortInput	Specifies sorting by udf.

IndustrialClassificationFilterPayloadFilterInput

Represents filtering input for industrial classification data.

Field	Type	Description
and	[IndustrialClassificationFilterPayloadFilterInput!]
or	[IndustrialClassificationFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering industrial classification data.
name	QueryCommonStringOperationFilterInput	Represents the name associated with a filtered industrial classification.
reference	QueryCommonStringOperationFilterInput	Filters by reference.
code	QueryCommonStringOperationFilterInput	Filters by code.
country	CountryFilterPayloadFilterInput	Represents the country associated with a filtered industrial classification.

IndustrialClassificationPayloadSortInput

Sort industrial classifications based on their attributes.

Field	Type	Description
reference	SortEnumType	Sort industrial classifications by their reference code.
name	SortEnumType	Sort industrial classifications by their name.
code	SortEnumType	Sort industrial classifications by their classification code.
country	CountryPayloadSortInput	Sort industrial classifications by their associated country.

JobNotificationStatusEnumOperationFilterInput

Input type for job notification status enum operation filter.

Field	Type	Description
eq	JobNotificationStatus	Filters by eq.
neq	JobNotificationStatus	Filters by neq.
in	[JobNotificationStatus!]	Filters by in.
nin	[JobNotificationStatus!]	Filters by nin.

JobPayloadFilterInput

Input type for job payload filter.

Field	Type	Description
and	[JobPayloadFilterInput!]
or	[JobPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	The unique identifier.
jobType	JobTypeEnumOperationFilterInput	Filters by job type.
jobNotificationStatus	JobNotificationStatusEnumOperationFilterInput	Filters by job notification status.
errorMessage	QueryCommonStringOperationFilterInput	Filters by error message.
description	QueryCommonStringOperationFilterInput	Filters by description.
createdAt	QueryCommonDateTimeOperationFilterInput	Filters by created at.
updatedAt	QueryCommonDateTimeOperationFilterInput	Filters by updated at.
startedAt	QueryCommonDateTimeOperationFilterInput	Filters by started at.
document	DocumentPayloadFilterInput	Filters by document.

JobPayloadSortInput

Input type for job payload sort.

Field	Type	Description
errorMessage	SortEnumType	Specifies sorting by error message.
description	SortEnumType	Specifies sorting by description.
createdAt	SortEnumType	Specifies sorting by created at.
updatedAt	SortEnumType	Specifies sorting by updated at.
startedAt	SortEnumType	Specifies sorting by started at.
document	DocumentPayloadSortInput	Specifies sorting by document.

JobTypeEnumOperationFilterInput

Input type for job type enum operation filter.

Field	Type	Description
eq	JobType	Filters by eq.
neq	JobType	Filters by neq.
in	[JobType!]	Filters by in.
nin	[JobType!]	Filters by nin.

NationalityFilterPayloadFilterInput

Filters nationality records based on standard attributes.

Field	Type	Description
and	[NationalityFilterPayloadFilterInput!]
or	[NationalityFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering nationality data.
name	QueryCommonStringOperationFilterInput	Filters by the name of the nationality.
country	CountryFilterPayloadFilterInput	Represents the country associated with a filtered nationality.
subCountry	SubCountryFilterPayloadFilterInput	Represents the sub-country associated with a filtered nationality.

NationalityPayloadSortInput

Sort nationalities based on their attributes.

Field	Type	Description
name	SortEnumType	Sort nationalities by their name.
priority	SortEnumType	Sort nationalities by their assigned priority level.
country	CountryPayloadSortInput	Sort nationalities by their associated country.
subCountry	SubCountryPayloadSortInput	Sort nationalities by their associated sub-country.

OccupationPayloadFilterInput

Filter occupations based on attributes like ID, priority, or reference.

Field	Type	Description
and	[OccupationPayloadFilterInput!]
or	[OccupationPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filter occupations by their unique identifier.
priority	QueryCommonIntegerOperationFilterInput	Filter occupations by their assigned priority level.
reference	QueryCommonStringOperationFilterInput	Filter occupations by their reference code.

OccupationPayloadSortInput

Sort occupations based on attributes like ID, priority, or reference.

Field		Type	Description
priority		SortEnumType	Sort occupations by their assigned priority level.
reference		SortEnumType	Sort occupations by their reference code.

OtherEntityFilterPayloadFilterInput

Filters used to query non-company entities such as trusts, partnerships, or organizations.

Field	Type	Description
and	[OtherEntityFilterPayloadFilterInput!]
or	[OtherEntityFilterPayloadFilterInput!]
id	IdOperationFilterInput	Represents the unique identifier for filtering other entity data.
entityName	QueryCommonStringOperationFilterInput	Filters based on the entity's name or a partial match of the name.
entityReference	QueryCommonStringOperationFilterInput	Represents the entity reference associated with a filtered other entity.
entityType	EntityTypeFilterPayloadFilterInput	Filters based on the entity type, whether it is a company, trust, partnership, or other.
country	CountryFilterPayloadFilterInput	Filters entities based on the country of operation or registration.
subCountry	SubCountryFilterPayloadFilterInput	Filters based on a specific region or subdivision within a country.
personOptions	PersonOptionsFilterPayloadFilterInput	Filters based on options or attributes related to individuals associated with the entity.
managedBy	UserPayloadFilterInput	Filters based on the user or team managing the entity's records.
partner	PartnerFilterPayloadFilterInput	Represents the partner associated with a filtered other entity.
companyNumber	QueryCommonStringOperationFilterInput	Filters entities based on their assigned registration or company number.
dissolvedDate	QueryCommonDateOperationFilterInput	Filters entities based on their dissolution date, useful for querying entities that are no longer operational.
occupation	QueryCommonStringOperationFilterInput	Filters based on the occupation or business type of the entity.
incorporationDate	QueryCommonDateOperationFilterInput	Filters based on the incorporation or registration date of the entity.
isHistoricalRecord	QueryCommonBooleanOperationFilterInput	A boolean filter to include or exclude historical or inactive records from the results.
udf	UdfFilterInput	Filters by udf.

OtherEntityPayloadSortInput

Sort other entities based on attributes like name, type, and jurisdiction.

Field	Type	Description
updatedAt	SortEnumType	Sort other entities by the date they were last updated.
entityReference	SortEnumType	Sort other entities by their reference code.
entityName	SortEnumType	Sort other entities by their name.
isHistoricalRecord	SortEnumType	Sort other entities based on whether they are marked as historical records.
companyNumber	SortEnumType	Sort other entities by their company registration number.
incorporationDate	SortEnumType	Sort other entities by their incorporation or registration date.
dissolvedDate	SortEnumType	Sort other entities by their dissolution date.
occupation	SortEnumType	Sort other entities by their occupation.
country	CountryPayloadSortInput	Sort other entities by their country of registration or operation.
udf	UdfOrderSortInput	Specifies sorting by udf.

PartnerFilterPayloadFilterInput

Represents filtering input for partner entities.

Field	Type	Description
and	[PartnerFilterPayloadFilterInput!]
or	[PartnerFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering partner data.
reference	QueryCommonStringOperationFilterInput	Filters partners by their reference code.
name	QueryCommonStringOperationFilterInput	Represents the name associated with a filtered partner.
initials	QueryCommonStringOperationFilterInput	Represents the initials associated with a filtered partner.

PartnerPayloadSortInput

Input object specifying sorting options for partner payload queries.

Field	Type	Description
initials	SortEnumType	Sorts partner payloads by their initials.
name	SortEnumType	Sorts partner payloads by their name.
priority	SortEnumType	Sorts partner payloads by their assigned priority.
reference	SortEnumType	Sorts partner payloads by their reference code.

PastAddressPayloadFilterInput

Filter input used to narrow past address query results.

Field	Type	Description
and	[PastAddressPayloadFilterInput!]
or	[PastAddressPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filters by past address identifier.
validTo	QueryCommonDateTimeOperationFilterInput	Filters by valid-to date.
entity	EntityBaseFilterPayloadFilterInput	Filters by the associated entity.
address	AddressFilterPayloadFilterInput	Filters by address.
addressType	AddressTypeFilterPayloadFilterInput	Filters by address type.

PastAddressPayloadSortInput

Sort input used to order past address query results.

Field	Type	Description
validTo	SortEnumType	Sorts by valid-to date.
entity	EntityPayloadSortInput	Sorts by associated entity.
address	AddressPayloadSortInput	Sorts by address.
addressType	AddressTypePayloadSortInput	Sorts by address type.

PendingAppointmentPayloadFilterInput

Represents filtering options for pending appointments.

Field	Type	Description
and	[PendingAppointmentPayloadFilterInput!]
or	[PendingAppointmentPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering pending appointment data.
eventDate	QueryCommonDateOperationFilterInput	Filters pending appointments by event date.
positionsDescription	QueryCommonStringOperationFilterInput	Filters pending appointments by positions description.
eventMessage	QueryCommonStringOperationFilterInput	Filters pending appointments by event message.
officerReminder	QueryCommonDateOperationFilterInput	Filters pending appointments by officer reminder date.
officerLevel	QueryCommonIntegerOperationFilterInput	Filters pending appointments by officer level.
pendingEvent	PendingEventPayloadFilterInput	Filters pending appointments by related pending event.
company	EntityBaseFilterPayloadFilterInput	Filters pending appointments by company.
person	EntityBaseFilterPayloadFilterInput	Filters pending appointments by person.
alternateTo	EntityBaseFilterPayloadFilterInput	Filters pending appointments by the person they are an alternate to.
replaceWith	EntityBaseFilterPayloadFilterInput	Filters pending appointments by the person being replaced.
event	AppointmentPayloadFilterInput	Filters pending appointments by related appointment event.
officerGroup	AppointmentGroupFilterPayloadFilterInput	Filters pending appointments by officer group.
officerStatus	AppointmentStatusFilterPayloadFilterInput	Filters pending appointments by officer status.
officerOccupation	OccupationPayloadFilterInput	Filters pending appointments by officer occupation.
officerReplacementOccupation	OccupationPayloadFilterInput	Filters pending appointments by replacement officer occupation.

PendingAppointmentPayloadSortInput

Specifies sorting options for pending appointment records.

Field	Type	Description
eventDate	SortEnumType	Sorts pending appointments by the event date.
positionsDescription	SortEnumType	Sorts pending appointments by the positions description.
eventMessage	SortEnumType	Sorts pending appointments by the event message or details.
officerLevel	SortEnumType	Sorts pending appointments by the officer level.
officerReminder	SortEnumType	Sorts pending appointments by the officer reminder setting or date.
pending	PendingEventPayloadSortInput	Sorts pending appointments by their pending status flag.
alternateTo	EntityPayloadSortInput	Sorts pending appointments by the alternate-to appointee.
company	EntityPayloadSortInput	Sorts pending appointments by the associated company.
event	AppointmentPayloadSortInput	Sorts pending appointments by the associated event.
person	EntityPayloadSortInput	Sorts pending appointments by the associated person (appointee).
replaceWith	EntityPayloadSortInput	Sorts pending appointments by the replacement appointee.
officerGroup	AppointmentGroupPayloadSortInput	Sorts pending appointments by the officer group.
officerStatus	AppointmentStatusPayloadSortInput	Sorts pending appointments by the officer status.
officerOccupation	OccupationPayloadSortInput	Sorts pending appointments by the officer's occupation.
officerReplacementOccupation	OccupationPayloadSortInput	Sorts pending appointments by the replacement officer's occupation.

PendingDataInput

Input type for pending data.

Field	Type	Description
isPending	Boolean!	The is pending value for this input.
assignedToId	ID	The assigned to id value for this input.
trackingStatusId	ID	The tracking status id value for this input.
reminderDate	DateTime	The reminder date value for this input.
trackingNotes	String	The tracking notes value for this input.

PendingEventPayloadFilterInput

Input type for pending event payload filter.

Field	Type	Description
and	[PendingEventPayloadFilterInput!]
or	[PendingEventPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	The unique identifier.
reference	QueryCommonIntegerOperationFilterInput	Filters by reference.
description	QueryCommonStringOperationFilterInput	Filters by description.
eventDate	QueryCommonDateTimeOperationFilterInput	Filters by event date.
reminderDate	QueryCommonDateTimeOperationFilterInput	Filters by reminder date.
auditDate	QueryCommonDateTimeOperationFilterInput	Filters by audit date.
notes	QueryCommonStringOperationFilterInput	Filters by notes.
isHistorical	QueryCommonBooleanOperationFilterInput	Filters by is historical.
isActioned	QueryCommonBooleanOperationFilterInput	Filters by is actioned.
isHidden	QueryCommonBooleanOperationFilterInput	Filters by is hidden.
entity	EntityBaseFilterPayloadFilterInput	Filters by entity.
eventType	EventTypePayloadFilterInput	Filters by event type.
assignedTo	UserPayloadFilterInput	Filters by assigned to.
createdBy	UserPayloadFilterInput	Filters by created by.

PendingEventPayloadSortInput

Input object specifying sorting options for pending event payload queries.

Field	Type	Description
reference	SortEnumType	Specifies sorting by reference.
eventDate	SortEnumType	Sorts pending event payloads by their event date.
reminderDate	SortEnumType	Sorts pending event payloads by their reminder date.
auditDate	SortEnumType	Sorts pending event payloads by their audit date.
description	SortEnumType	Sorts pending event payloads by their description.
notes	SortEnumType	Sorts pending event payloads by their notes or additional information.
isHistorical	SortEnumType	Sorts pending event payloads by whether they are historical records.
isActioned	SortEnumType	Sorts pending event payloads by whether they have been actioned.
isHidden	SortEnumType	Sorts pending event payloads by whether they are hidden from view.
entity	EntityPayloadSortInput	Specifies sorting by entity.
eventType	EventTypePayloadSortInput	Specifies sorting by event type.
assignedTo	UserPayloadSortInput	Specifies sorting by assigned to.
createdBy	UserPayloadSortInput	Specifies sorting by created by.

PersonOptionsFilterPayloadFilterInput

Filters person-related records based on options or preferences.

Field	Type	Description
and	[PersonOptionsFilterPayloadFilterInput!]
or	[PersonOptionsFilterPayloadFilterInput!]
hasShareCertificates	QueryCommonBooleanOperationFilterInput	Filters by has share certificates.
hasStockTransferForms	QueryCommonBooleanOperationFilterInput	Filters by has stock transfer forms.
hasRegisterAddendums	QueryCommonBooleanOperationFilterInput	Filters by has register addendums.
hasOtherDirectorships	QueryCommonBooleanOperationFilterInput	Filters by has other directorships.

QueryCommonBooleanOperationFilterInput

Represents filtering operations based on boolean values.

Field		Type	Description
eq		Boolean	Represents an equality comparison for boolean values.
neq		Boolean	Represents a non-equality comparison for boolean values.

QueryCommonDateOperationFilterInput

A filter for date fields, supporting various comparison operations.

Field	Type	Description
and	[QueryCommonDateOperationFilterInput!]
or	[QueryCommonDateOperationFilterInput!]
eq	Date	Filters records where the date equals the provided value.
neq	Date	Filters records where the date does not equal the provided value.
gt	Date	Filters records where the date is greater than the provided value.
gte	Date	Filters records where the date is greater than or equal to the provided value.
lt	Date	Filters records where the date is less than the provided value.
lte	Date	Filters records where the date is less than or equal to the provided value.
in	[Date]	Filters by in.
nin	[Date]	Filters by nin.

QueryCommonDateTimeOperationFilterInput

Filter date-time fields using common comparison operations.

Field	Type	Description
and	[QueryCommonDateTimeOperationFilterInput!]
or	[QueryCommonDateTimeOperationFilterInput!]
eq	DateTime	Filter date-time fields where the value equals the specified date.
neq	DateTime	Filter date-time fields where the value does not equal the specified date.
gt	DateTime	Filter date-time fields where the value is greater than the specified date.
gte	DateTime	Filter date-time fields where the value is greater than or equal to the specified date.
lt	DateTime	Filter date-time fields where the value is less than the specified date.
lte	DateTime	Filter date-time fields where the value is less than or equal to the specified date.

QueryCommonDecimalOperationFilterInput

Filter input type for performing operations on decimal fields.

Field	Type	Description
and	[QueryCommonDecimalOperationFilterInput!]
or	[QueryCommonDecimalOperationFilterInput!]
eq	Float	Matches records where the decimal value is equal to the specified value.
neq	Float	Matches records where the decimal value is not equal to the specified value.
gt	Float	Matches records where the decimal value is greater than the specified value.
gte	Float	Matches records where the decimal value is greater than or equal to the specified value.
lt	Float	Matches records where the decimal value is less than the specified value.
lte	Float	Matches records where the decimal value is less than or equal to the specified value.

QueryCommonIntegerOperationFilterInput

A filter for integer fields, supporting various comparison operations.

Field	Type	Description
and	[QueryCommonIntegerOperationFilterInput!]
or	[QueryCommonIntegerOperationFilterInput!]
eq	Int	Filters records where the integer equals the provided value.
neq	Int	Filters records where the integer does not equal the provided value.
gt	Int	Filters records where the integer is greater than the provided value.
gte	Int	Filters records where the integer is greater than or equal to the provided value.
lt	Int	Filters records where the integer is less than the provided value.
lte	Int	Filters records where the integer is less than or equal to the provided value.
in	[Int]	Filters by in.
nin	[Int]	Filters by nin.

QueryCommonStringOperationFilterInput

A filter for string fields, supporting operations like equality, containment, and comparison.

Field	Type	Description
and	[QueryCommonStringOperationFilterInput!]
or	[QueryCommonStringOperationFilterInput!]
eq	String	Filters records where the string equals the provided value.
neq	String	Filters records where the string does not equal the provided value.
contains	String	Filters records where the string contains the provided substring.
ncontains	String	Represents a filter condition where the string does not contain a specific value.
startsWith	String	Filters records where the string starts with the provided substring.
nstartsWith	String	Filters records where the string does not start with the provided substring.
endsWith	String	Filters records where the string ends with the provided substring.
nendsWith	String	Filters records where the string does not end with the provided substring.
in	[String]	Filter string fields where the value is within a specified list.
nin	[String]	Filter string fields where the value is not within a specified list.

QueryDataLibraryUsageTypeEnumOperationFilterInput

Filter Data Library usage types using enumeration-based operations.

Field	Type	Description
eq	DataLibraryUsageType	Filter usage types where the value equals the specified type.
neq	DataLibraryUsageType	Filter usage types where the value does not equal the specified type.
in	[DataLibraryUsageType!]	Filter usage types where the value is within a specified list.
nin	[DataLibraryUsageType!]	Filter usage types where the value is not within a specified list.

QueryEntityTypeCategoryListOperationFilterInput

Field		Type	Description
all		[EntityTypeCategory]
none		[EntityTypeCategory]
some		[EntityTypeCategory]
any		Boolean

QueryIdListOperationFilterInput

Filter queries based on a list of ID values using logical operations.

Field	Type	Description
all	[ID]	Filter where all specified IDs must match.
none	[ID]	Filter where none of the specified IDs match.
some	[ID]	Filter where some of the specified IDs match.
any	Boolean	Filter where any of the specified IDs match.

QueryIdStringOperationFilterInput

Represents filtering operations based on string identifiers.

Field	Type	Description
and	[QueryIdStringOperationFilterInput!]
or	[QueryIdStringOperationFilterInput!]
eq	ID	Represents an equality comparison for string identifiers.
neq	ID	Represents a non-equality comparison for string identifiers.
in	[ID]	Filter ID string fields where the value is within a specified list.
nin	[ID]	Filter ID string fields where the value is not within a specified list.

QueryStringListOperationFilterInput

A filter for string lists, supporting operations like all, any, or none.

Field	Type	Description
all	[String]	Filters records where all elements in the string list match the provided condition.
none	[String]	Filters records where none of the elements in the string list match the provided condition.
some	[String]	Filters records where some elements in the string list match the provided condition.
any	Boolean	Filters records where any element in the string list matches the provided condition.

SavedFilterPayloadFilterInput

Input type for saved filter payload filter.

Field	Type	Description
and	[SavedFilterPayloadFilterInput!]
or	[SavedFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	The unique identifier.
filterType	FilterTypeEnumOperationFilterInput	Filters by filter type.
name	QueryCommonStringOperationFilterInput	Filters by name.
ownedBy	UserPayloadFilterInput	Filters by owned by.

SavedFilterPayloadSortInput

Input type for saved filter payload sort.

Field		Type	Description
name		SortEnumType	Specifies sorting by name.
ownedBy		UserPayloadSortInput	Specifies sorting by owned by.

SecurityGroupAppliesToInput

Input type used for specifying the scope of a security group.

Field	Type	Description
autoAddRemoveSecurityGroups	Boolean	Indicates whether security groups are automatically added or removed.
naCorporateAppointeesOrShareholders	Boolean	Applies to non-corporate appointees or shareholders.
company	Boolean	Specifies the company to which the security group applies.
appointments	Boolean	Specifies the appointments to which the security group applies.
shareHolders	Boolean	Specifies the shareholders to which the security group applies.
guarantors	Boolean	Specifies the guarantors to which the security group applies.
committees	Boolean	Specifies the committees to which the security group applies.
committeeAppointments	Boolean	Specifies the committee appointments to which the security group applies.
registrations	Boolean	Specifies the registrations to which the security group applies.
branches	Boolean	Specifies the branches to which the security group applies.

ShareCategoryFilterPayloadFilterInput

Input object used to filter share category payloads based on specified criteria.

Field	Type	Description
and	[ShareCategoryFilterPayloadFilterInput!]
or	[ShareCategoryFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filters share categories by their unique identifier.
reference	QueryCommonStringOperationFilterInput	Filters share categories by their reference code.
name	QueryCommonStringOperationFilterInput	Filters share categories by their name.
code	QueryCommonStringOperationFilterInput	Filters share categories by their code.

ShareClassFilterPayloadFilterInput

Input object used to filter share class payloads based on specified criteria.

Field	Type	Description
and	[ShareClassFilterPayloadFilterInput!]
or	[ShareClassFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filters share classes by their unique identifier.
reference	QueryCommonStringOperationFilterInput	Filters share classes by their reference code.
name	QueryCommonStringOperationFilterInput	Filters share classes by their name.
code	QueryCommonStringOperationFilterInput	Filters share classes by their code.
issuedShares	QueryCommonDecimalOperationFilterInput	Filters share classes by the number of issued shares.
nominalValue	QueryCommonDecimalOperationFilterInput	Filters share classes by their nominal value.
isNonCapitalShares	QueryCommonBooleanOperationFilterInput	Filters share classes based on whether they are non-capital shares.
isNonVotingShares	QueryCommonBooleanOperationFilterInput	Filters share classes based on whether they are non-voting shares.
votesPerShare	QueryCommonDecimalOperationFilterInput	Filters share classes by the number of votes per share.
isPartlyPaid	QueryCommonBooleanOperationFilterInput	Filters share classes based on whether they are partly paid.
createdAt	QueryCommonDateOperationFilterInput	Filters share classes by their creation date.
canceledAt	QueryCommonDateOperationFilterInput	Filters share classes by their cancellation date.
capitalWeighting	QueryCommonDecimalOperationFilterInput	Filters share classes by their capital weighting.
votingWeighting	QueryCommonDecimalOperationFilterInput	Filters share classes by their voting weighting.
longName	QueryCommonStringOperationFilterInput	Filters share classes by their long name.
issuer	EntityBaseFilterPayloadFilterInput	Filters share classes by their issuer.
currency	CurrencyFilterPayloadFilterInput	Filters share classes by their associated currency.
shareCategory	ShareCategoryFilterPayloadFilterInput	Filters share classes by their share category.

ShareFilterPayloadFilterInput

Input object used to filter share payloads based on specified criteria.

Field	Type	Description
and	[ShareFilterPayloadFilterInput!]
or	[ShareFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Filters shares by their unique identifier.
allotmentDate	QueryCommonDateOperationFilterInput	Filters shares by their allotment date.
numberOfShares	QueryCommonDecimalOperationFilterInput	Filters by number of shares.
considerationPerShare	QueryCommonDecimalOperationFilterInput	Filters by consideration per share.
applicationDate	QueryCommonDateTimeOperationFilterInput	Filters by application date.
applicationAmount	QueryCommonDecimalOperationFilterInput	Filters by application amount.
notes	QueryCommonStringOperationFilterInput	Filters by notes.
shareClass	ShareClassFilterPayloadFilterInput	Filters by share class.
shareholder	EntityBaseFilterPayloadFilterInput	Filters by shareholder.
beneficiary	EntityBaseFilterPayloadFilterInput	Filters by beneficiary.

SharePayloadSortInput

Specifies sorting options for share payloads.

Field	Type	Description
allotmentDate	SortEnumType	Sorts by allotment date.
numberOfShares	SortEnumType	Sorts by number of shares.
considerationPerShare	SortEnumType	Sorts by consideration per share.
applicationDate	SortEnumType	Sorts by application date.
applicationAmount	SortEnumType	Sorts by application amount.
notes	SortEnumType	Sorts by notes.
shareholder	EntityPayloadSortInput	Sorts by shareholder.
beneficiary	EntityPayloadSortInput	Sorts by beneficiary.

SignatoryStatusInput

Input type for signatory status.

Field	Type	Description
signedByEntityId	ID	The ID of the entity that will sign the pending appointment.
signedAsId	ID	The ID representing the capacity or role in which the pending appointment will be signed.
signedOnDate	LocalDate	The date on which the pending appointment will be signed.

StorageLocationEnumOperationFilterInput

Filter storage locations using enumeration-based operations.

Field	Type	Description
eq	StorageLocation	Filter storage locations where the value equals the specified location.
neq	StorageLocation	Filter storage locations where the value does not equal the specified location.
in	[StorageLocation!]	Filter storage locations where the value is within a specified list.
nin	[StorageLocation!]	Filter storage locations where the value is not within a specified list.

SubCountryFilterPayloadFilterInput

Filters by subdivisions within a country, such as states, provinces, or regions.

Field	Type	Description
and	[SubCountryFilterPayloadFilterInput!]
or	[SubCountryFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering sub-country payload data.
subCountryCode	QueryCommonStringOperationFilterInput	Filters by the code assigned to a subdivision within a country.
name	QueryCommonStringOperationFilterInput	Filters by the name of the subdivision within a country (e.g., state or province).
country	CountryFilterPayloadFilterInput	Filters sub-country data based on the associated country.

SubCountryPayloadSortInput

Input object specifying sorting options for sub-country queries.

Field	Type	Description
name	SortEnumType	Sorts sub-countries by their name.
subCountryCode	SortEnumType	Sorts sub-countries by their sub-country code.
country	CountryPayloadSortInput	Sorts sub-countries by the country associated with the sub-country.

TrackingStatusInput

Input type for tracking status.

Field	Type	Description
assignedToId	ID	The assigned-to user ID for the pending event to create.
trackingStatusId	ID!	The tracking status ID for the pending event to create.
reminderDate	LocalDate	Reminder date for the pending event to create.
trackingNotes	String	Tracking notes for the pending event to create.

TrustFilterPayloadFilterInput

Input type for trust filter payload filter.

Field	Type	Description
and	[TrustFilterPayloadFilterInput!]
or	[TrustFilterPayloadFilterInput!]
id	IdOperationFilterInput	The unique identifier.
entityName	QueryCommonStringOperationFilterInput	Filters by entity name.
entityReference	QueryCommonStringOperationFilterInput	Filters by entity reference.
entityType	EntityTypeFilterPayloadFilterInput	Filters by entity type.
country	CountryFilterPayloadFilterInput	Filters by country.
subCountry	SubCountryFilterPayloadFilterInput	Filters by sub country.
personOptions	PersonOptionsFilterPayloadFilterInput	Filters by person options.
managedBy	UserPayloadFilterInput	Filters by managed by.
partner	PartnerFilterPayloadFilterInput	Filters by partner.
updatedAt	QueryCommonDateTimeOperationFilterInput	Filters by updated at.
incorporationDate	QueryCommonDateOperationFilterInput	Filters by incorporation date.
trustStatus	CompanyStatusFilterPayloadFilterInput	Filters by trust status.
domicile	QueryCommonStringOperationFilterInput	Filters by domicile.
isOverseas	QueryCommonBooleanOperationFilterInput	Filters by is overseas.
trustType	QueryCommonStringOperationFilterInput	Filters by trust type.
vestedDate	QueryCommonDateOperationFilterInput	Filters by vested date.
tfnNumber	QueryCommonStringOperationFilterInput	Filters by tfn number.
irdNumber	QueryCommonStringOperationFilterInput	Filters by ird number.
gstNumber	QueryCommonStringOperationFilterInput	Filters by gst number.
gstGroup	QueryCommonStringOperationFilterInput	Filters by gst group.
arsnNumber	QueryCommonStringOperationFilterInput	Filters by arsn number.
trustDeedIssuedAt	QueryCommonDateOperationFilterInput	Filters by trust deed issued at.
description	QueryCommonStringOperationFilterInput	Filters by description.
placeOfEstablishment	QueryCommonStringOperationFilterInput	Filters by place of establishment.
legalOwnership	QueryCommonStringOperationFilterInput	Filters by legal ownership.
controlledEntity	QueryCommonStringOperationFilterInput	Filters by controlled entity.
taxEntityType	QueryCommonStringOperationFilterInput	Filters by tax entity type.
taxConsolidationGroup	QueryCommonStringOperationFilterInput	Filters by tax consolidation group.
taxOther	QueryCommonStringOperationFilterInput	Filters by tax other.
udf	UdfFilterInput	Filters by udf.

TrustPayloadSortInput

Input type for trust payload sort.

Field	Type	Description
entityReference	SortEnumType	Specifies sorting by entity reference.
updatedAt	SortEnumType	Specifies sorting by updated at.
entityName	SortEnumType	Specifies sorting by entity name.
isHistoricalRecord	SortEnumType	Specifies sorting by is historical record.
incorporationDate	SortEnumType	Specifies sorting by incorporation date.
trustStatus	CompanyStatusPayloadSortInput	Specifies sorting by trust status.
domicile	SortEnumType	Specifies sorting by domicile.
isOverseas	SortEnumType	Specifies sorting by is overseas.
trustType	SortEnumType	Specifies sorting by trust type.
vestedDate	SortEnumType	Specifies sorting by vested date.
tfnNumber	SortEnumType	Specifies sorting by tfn number.
irdNumber	SortEnumType	Specifies sorting by ird number.
gstNumber	SortEnumType	Specifies sorting by gst number.
gstGroup	SortEnumType	Specifies sorting by gst group.
arsnNumber	SortEnumType	Specifies sorting by arsn number.
trustDeedIssuedAt	SortEnumType	Specifies sorting by trust deed issued at.
description	SortEnumType	Specifies sorting by description.
placeOfEstablishment	SortEnumType	Specifies sorting by place of establishment.
legalOwnership	SortEnumType	Specifies sorting by legal ownership.
controlledEntity	SortEnumType	Specifies sorting by controlled entity.
taxEntityType	SortEnumType	Specifies sorting by tax entity type.
taxConsolidationGroup	SortEnumType	Specifies sorting by tax consolidation group.
taxOther	SortEnumType	Specifies sorting by tax other.
country	CountryPayloadSortInput	Specifies sorting by country.
udf	UdfOrderSortInput	Specifies sorting by udf.

UdfFilterInput

Input type for udf filter.

Field		Type	Description
name		String	Filters by name.
value		UdfOperationFilterInput	Filters by value.

UdfFilterPayloadFilterInput

Represents the filtering input for user-defined fields (UDF).

Field	Type	Description
and	[UdfFilterPayloadFilterInput!]
or	[UdfFilterPayloadFilterInput!]
id	IdOperationFilterInput	Represents the unique identifier for filtering UDF data.
name	QueryCommonStringOperationFilterInput	Represents the name associated with a filtered UDF.
priority	QueryCommonIntegerOperationFilterInput	Filters by priority.
shortName	QueryCommonStringOperationFilterInput	Represents the short name associated with a filtered UDF.
countryIds	QueryIdListOperationFilterInput	Filters user-defined fields (UDFs) by the country codes they apply to.
entityTypeIds	QueryIdListOperationFilterInput	Filters user-defined fields (UDFs) by the entity type IDs they are associated with.
isSystemPredefined	QueryCommonBooleanOperationFilterInput	Filters by is system predefined.
isRequired	QueryCommonBooleanOperationFilterInput	Boolean flag indicating if the UDF is required.
reference	QueryCommonStringOperationFilterInput	Filters user-defined fields (UDFs) by their reference code.

UdfInput

Input type for a user-defined field (UDF) entry.

Field		Type	Description
key		String!	The key or name of the user-defined field.
value		Any	The value of the user-defined field.

UdfOperationFilterInput

Input type for udf operation filter.

Field	Type	Description
and	[UdfOperationFilterInput!]
or	[UdfOperationFilterInput!]
eq	String	Filters by eq.
neq	String	Filters by neq.
contains	String	Filters by contains.
ncontains	String	Filters by ncontains.
startsWith	String	Filters by starts with.
nstartsWith	String	Filters by nstarts with.
endsWith	String	Filters by ends with.
nendsWith	String	Filters by nends with.
in	[String]	Filters by in.
nin	[String]	Filters by nin.
gt	String	Filters by gt.
gte	String	Filters by gte.
lt	String	Filters by lt.
lte	String	Filters by lte.

UdfOrderSortInput

Input type for udf order sort.

Field		Type	Description
name		String!	Specifies sorting by name.
direction		SortEnumType!	Specifies sorting by direction.

UdfPayloadSortInput

Input object specifying sorting options for user-defined field (UDF) payload queries.

Field	Type	Description
reference	SortEnumType	Sorts user-defined field (UDF) payloads by their reference code.
priority	SortEnumType	Specifies sorting by priority.
name	SortEnumType	Sorts user-defined field (UDF) payloads by their name.
shortName	SortEnumType	Sorts user-defined field (UDF) payloads by their short name or alias.
isSystemPredefined	SortEnumType	Specifies sorting by is system predefined.
isRequired	SortEnumType	Sorts user-defined field (UDF) payloads by whether they are required fields.

UpdateAddressInput

Input type for updating an address.

Field	Type	Description
reference	String	The reference for the address to update.
street1	String	The first address line for the address to update.
street2	String	The second address line for the address to update.
street3	String	The third address line for the address to update.
postTown	String	The post town for the address to update.
area	String	The area or region for the address to update.
countryId	ID	The country ID for the address to update.
postalCode	String	The postal code for the address to update.
latitude	String	The latitude of the address to update.
longitude	String	The longitude of the address to update.
isShared	Boolean

UpdateAddressTypeInput

Input type for updating an address type.

Field	Type	Description
name	String!	The name for the address type to update.
isHeading	Boolean	Indicates whether the address type is a heading.
isNameOnline	Boolean	Indicates whether the address type name is displayed online.
noRecordHeld	String	The following text is inserted into the past address details if there is a gap between the cessation of one address, and the start of another address.
isNotInCountryCodes	Boolean	Indicates whether the address type is excluded from the specified countries.
countryIds	[ID!]	The country IDs associated with the address type to update.
isCompanyRecordsAddressType	Boolean	Indicates whether this is a company records address type.
isNotShared	Boolean	Indicates whether the address type is not shared.
isHidden	Boolean	Indicates whether the address type is hidden.
securityGroup	Int	The security group associated with the address type to update.

UpdateCompanyInput

Input type used for updating details of a company.

Field	Type	Description
eventDate	LocalDate	The event date for updating a company.
entityName	String	The name of the entity associated with the company update.
companyTypeId	ID	The company type ID for updating the company.
partnerId	ID	The partner ID associated with the company update.
isHistoricalRecord	Boolean	Indicates if the company is a historical record.
companyNumber	String	The company number for the company update.
incorporationDate	LocalDate	The incorporation date for the company update.
dissolvedDate	LocalDate	The dissolution date for the company update.
lastAccountingPeriodEndDate	LocalDate	The last accounting period end date for the company.
currentAccountingPeriodEndDate	LocalDate	The current accounting period end date for the company.
lastAccountingPeriodExtendedDate	LocalDate	The last extended accounting period end date for the company.
companyStatusId	ID	The company status ID for the company update.
industrialClassification1Id	ID	The first industrial classification ID for the company.
industrialClassification2Id	ID	The second industrial classification ID for the company.
industrialClassification3Id	ID	The third industrial classification ID for the company.
industrialClassification4Id	ID	The fourth industrial classification ID for the company.
industrialClassificationOther	String	The other industrial classification details for the company.
lastAccountsDate	LocalDate	The last accounts date for the company.
accountsSignedDate	LocalDate	The accounts signed date for the company.
accountsFiledDate	LocalDate	The accounts filed date for the company.
isAccountsFiledOverridden	Boolean	Indicates if the accounts filed date is overridden.
accountsInReviewDate	LocalDate	The accounts in review date for the company.
accountsOverdueDate	LocalDate	The accounts overdue date for the company.
isAccountsOverdueOverridden	Boolean	Indicates if the accounts overdue date is overridden.
hasAccountsOverseasExtension	Boolean	Indicates if the accounts have an overseas extension.
lastMembersScheduleDate	LocalDate	The last members schedule date for the company.
lastAnnualReturnDate	LocalDate	The last annual return date for the company.
annualReturnSignedDate	LocalDate	The annual return signed date for the company.
annualReturnFiledDate	LocalDate	The annual return filed date for the company.
nextAnnualReturnDate	LocalDate	The next annual return date for the company.
isNextAnnualReturnDateAutomatic	Boolean	Indicates if the next annual return date is automatic.
isMembersScheduleAsRequired	Boolean	Indicates if the members schedule is as required.
isMembersScheduleNotOnPaper	Boolean	Indicates if the members schedule is not on paper.
lastAnnualMeetingDate	LocalDate	The last annual meeting date for the company.
annualMeetingMinutesSignedDate	LocalDate	The annual meeting minutes signed date for the company.
nextAnnualMeetingDate	LocalDate	The next annual meeting date for the company.
isNextAnnualMeetingDateAutomatic	Boolean	Indicates if the next annual meeting date is automatic.
lastMeetingApproveAccountsDate	LocalDate	The last meeting approve accounts date for the company.
meetingApproveAccountsMinutesSignedDate	LocalDate	The minutes signed date for the meeting approving accounts.
financialPeriodFromDate	LocalDate	The financial period start date for the company.
financialPeriodToDate	LocalDate	The financial period end date for the company.
isFinancialPeriodAutomatic	Boolean	Indicates if the financial period is automatic.
countryId	ID	The country ID associated with the company update.
subCountryId	ID	The sub-country ID associated with the company update.
isLive	Boolean	Indicates if the company is live.
registeredEmailAddress	String	The registered email address for the company.
udfs	[UdfInput!]	The udfs value for this input.
hasDormantCompanyResolution	Boolean	Indicates if the company has a dormant company resolution.
dormantCompanyResolutionPassedOn	LocalDate	The date when the dormant company resolution was passed.
hasStandardDormantAccounts	Boolean	Indicates if the company has standard dormant accounts.
fileReference	String	The file reference for the company.
userGroupingId	ID	The user grouping ID associated with the company.
managedById	ID	The ID of the user who manages the company.

UpdateCompanyOptionsInput

Input type used for updating company-related options or settings.

Field	Type	Description
systemDefaultRegisterSettings	Boolean	System default register settings for company options.
separateRegistersForDirectorsSecretaries	Boolean	Separate registers for directors and secretaries in options.
registersListByName	Boolean	Registers listed by name for company options.
provideSpaceOnRegisterForManualEntries	Boolean	Provides space on register for manual entries in options.
globalDocumentReferenceFormat	Boolean	Represents the global format used to generate document references across the system.
defaultDocumentReferenceFormat	Boolean	Specifies the default document reference format when no global format is defined.
documentFormatSeparator	DocumentReferenceSeparator	Defines the character or symbol used to separate segments in a document reference.
documentFormatSegment1	DocumentReferenceSegment	Represents the first segment in the document reference format structure.
documentFormatSegment2	DocumentReferenceSegment	Represents the second segment in the document reference format structure.
documentFormatSegment3	DocumentReferenceSegment	Represents the third segment in the document reference format structure

UpdateCompanyStatusInput

Input type used for updating details of a company status.

Field		Type	Description
name		String	The name of the company status to update.
entityTypeId		ID	The entity type ID for the company status to update.

UpdateCompanyTypeInput

Input type used for updating details of a company type.

Field	Type	Description
name	String	The name of the company type to update.
isNotInCountries	Boolean	Country codes excluded for the company type to update.
countryIds	[ID!]	Country codes associated with the company type to update.
entityTypeId	ID	The entity type ID for the company type to update.
isHidden	Boolean	Indicates if the company type is hidden.

UpdateDataLibraryInput

Input type for updating a data library record.

Field	Type	Description
assignedToId	ID	The assigned-to user ID for the data library record to update.
dataLibraryStatusId	ID	The data library status ID for the record to update.
reminderDate	LocalDate	Reminder date for the data library record to update.
notes	String!	Notes for the data library record to update.
dateFrom	LocalDate	The 'from' date for the data library record to update.
dateTo	LocalDate	The 'to' date for the data library record to update.
expiryDate	LocalDate	Expiry date for the data library record to update.
description	String!	Description for the data library record to update.
physicalLocation	String!	Physical location for the data library record to update.
electronicLocation	String!	Electronic location for the data library record to update.
isHistorical	Boolean!	Indicates whether the data library record to update is historical.
udfs	[UdfInput!]!	User-defined field values for the data library record to update.

UpdateEntityBatchInput

Input type used for updating details of an entity batch.

Field		Type	Description
name		String	The name of the entity batch to update.
batchUserId		ID	The user ID associated with the entity batch to update.

UpdateEntityIdentificationInput

Input used to update an existing entity identification.

Field		Type	Description
identification		String!	The updated identification value.

UpdateEntitySecurityGroupInput

Input type used for updating details of an entity security group.

Field	Type	Description
name	String	The name of the entity security group to update.
userRoleId	ID	Represents the user role identifier to associate when updating an entity security group.
liveReference	String	The live reference for the entity security group.
entitySecurityGroupAuto	String	Indicates if the entity security group is automatic.
entitySecurityGroupRollUp	EntitySecurityGroupRollUp	The roll-up setting for the entity security group.
entitySecurityGroupApplies	String	Specifies the applies-to settings for the entity security group.

UpdateEntitySetInput

Input type used for updating details of an entity set.

Field		Type	Description
name		String	The name of the entity set to update.
appliesTo		[EntityTypeCategory!]	The set types to update for the entity set.

UpdateEntityTypeInput

Input type used for updating details of an entity type.

Field		Type	Description
name		String	The name of the entity type to update.

UpdateIndividualInput

Input type used for updating details of an individual.

Field	Type	Description
eventDate	LocalDate	Specifies the event date for updating an individual input.
forenames	String	Specifies the forenames for updating an individual input.
surname	String	Specifies the surname for updating an individual input.
displayAs	IndividualNameFormat	Specifies the display name for updating an individual input.
partnerId	ID	Specifies the partner ID for updating an individual input.
isHistoricalRecord	Boolean	Indicates if the individual is a historical record in updates.
title	String	Specifies the title for updating an individual input.
honours	String	Specifies the honors for updating an individual input.
salutation	String	Specifies the salutation for updating an individual input.
previousName	String	Specifies the previous name for updating an individual input.
occupation	String	Specifies the occupation for updating an individual input.
nationalityId	ID	Specifies the nationality ID for updating an individual input.
dateOfBirth	LocalDate	Specifies the date of birth for updating an individual input.
dateOfDeath	LocalDate	Specifies the date of death for updating an individual input.
nationalIdentificationNumber	String	Specifies the national identification number for updating an individual input.
passportNumber	String	Specifies the passport number for updating an individual input.
countryId	ID	Specifies the country ID for updating an individual input.
subCountryId	ID	Specifies the sub-country ID for updating an individual input.
udfs	[UdfInput!]	The udfs value for this input.
fileReference	String	Specifies the file reference for updating an individual input.
userGroupingId	ID	Specifies the user grouping ID for updating an individual input.
managedById	ID	Specifies the managed by (user) ID for updating an individual input.

UpdateNationalityInput

Input type used for updating details of a nationality.

Field	Type	Description
name	String	Specifies the name for updating a nationality input.
countryId	ID	Specifies the country ID for updating a nationality input.
subCountryId	ID	Specifies the sub-country ID for updating a nationality input.

UpdateOtherEntityInput

Input type used for updating details of another type of entity.

Field	Type	Description
eventDate	LocalDate	Specifies the event date for updating another entity input.
entityName	String	Specifies the entity name for updating another entity input.
partnerId	ID	Specifies the partner ID for updating another entity input.
isHistoricalRecord	Boolean	Indicates if the entity is a historical record in updates.
entityTypeId	ID	Specifies the entity type ID for updating another entity input.
companyNumber	String	Specifies the company number for updating another entity input.
incorporationDate	LocalDate	Specifies the incorporation date for updating another entity input.
dissolvedDate	LocalDate	Specifies the dissolved date for updating another entity input.
occupation	String	Specifies the occupation for updating another entity input.
countryId	ID	Specifies the country ID for updating another entity input.
subCountryId	ID	Specifies the sub-country ID for updating another entity input.
udfs	[UdfInput!]	The udfs value for this input.
fileReference	String	Specifies the file reference for updating another entity input.
userGroupingId	ID	Specifies the user grouping ID for updating another entity input.
managedById	ID	Specifies the managed by (user) ID for updating another entity input.

UpdatePartnerInput

Input type used for updating details of a partner.

Field		Type	Description
name		String	Specifies the name for updating a partner input.
initials		String	Specifies the initials for updating a partner input.

UpdatePendingAppointmentBatchDataInput

Input type for update pending appointment batch data.

Field	Type	Description
pendingAppointmentId	ID	Identifier of the pending appointment batch item to update; when omitted, the batch item is treated as new.
entityId	ID!	The entity id value for this input.
eventDate	LocalDate	The event date value for this input.
appointmentTypeIds	[ID!]!	The appointment type ids value for this input.
jobTitle	String	The job title value for this input.
appointmentGroupId	ID	The appointment group id value for this input.
appointmentLevel	Int	The appointment level value for this input.
appointmentReminderDate	LocalDate	The appointment reminder date value for this input.
appointmentStatusId	ID	The appointment status id value for this input.
alternateToEntityId	ID	The alternate to entity id value for this input.

UpdatePendingAppointmentInput

Input type for update pending appointment.

Field	Type	Description
boardMeetingDate	LocalDate	The board meeting date value for this input.
consentToActGiven	Boolean	The consent to act given value for this input.
doesNotAttendMeetings	Boolean	The does not attend meetings value for this input.
notes	String	The notes value for this input.
showNotesOnRegister	Boolean	The show notes on register value for this input.
eventDate	LocalDate	The event date value for this input.
trackingStatus	TrackingStatusInput	The tracking status value for this input.
signatoryStatus	SignatoryStatusInput	The signatory status value for this input.
appointments	[UpdatePendingAppointmentBatchDataInput!]	The appointments value for this input.

UpdatePendingChangeJobTitleBatchDataInput

Input type for update pending change job title batch data.

Field	Type	Description
pendingAppointmentId	ID	Identifier of the pending change job title batch item to update; when omitted, the batch item is treated as new.
entityId	ID!	The entity id value for this input.
eventDate	LocalDate	The event date value for this input.
appointmentTypeIds	[ID!]	The appointment type ids value for this input.
jobTitle	String	The new job title for the appointee.

UpdatePendingChangeJobTitleInput

Input type for update pending change job title.

Field	Type	Description
eventDate	LocalDate	The event date value for this input.
boardMeetingDate	LocalDate
trackingStatus	TrackingStatusInput	Shared tracking-related input fields for pending event mutations.
signatoryStatus	SignatoryStatusInput	Shared signatory-related input fields for pending event mutations.
changeJobTitles	[UpdatePendingChangeJobTitleBatchDataInput!]	The change job title batch data for this input.

UpdatePendingDeathBatchDataInput

Input type for update pending death batch data.

Field	Type	Description
pendingAppointmentId	ID	Identifier of the pending death batch item to update; when omitted, the batch item is treated as new.
entityId	ID!	The entity id value for this input.
eventDate	LocalDate	The event date value for this input.

UpdatePendingDeathInput

Input type for update pending death.

Field	Type	Description
notes	String	The notes value for this input.
showNotesOnRegister	Boolean	The show notes on register value for this input.
eventDate	LocalDate	The event date value for this input.
trackingStatus	TrackingStatusInput	The tracking status value for this input.
signatoryStatus	SignatoryStatusInput	The signatory status value for this input.
appointments	[UpdatePendingDeathBatchDataInput!]	The appointments value for this input.

UpdatePendingRemovalBatchDataInput

Input type for update pending removal batch data.

Field	Type	Description
pendingAppointmentId	ID	Identifier of the pending removal batch item to update; when omitted, the batch item is treated as new.
entityId	ID!	The entity id value for this input.
eventDate	LocalDate	The event date value for this input.
appointmentTypeIds	[ID!]!	The appointment type ids value for this input.

UpdatePendingRemovalInput

Input type for update pending removal.

Field	Type	Description
boardMeetingDate	LocalDate	The board meeting date value for this input.
notes	String	The notes value for this input.
showNotesOnRegister	Boolean	The show notes on register value for this input.
eventDate	LocalDate	The event date value for this input.
trackingStatus	TrackingStatusInput	The tracking status value for this input.
signatoryStatus	SignatoryStatusInput	The signatory status value for this input.
appointments	[UpdatePendingRemovalBatchDataInput!]	The removal batch items for this input.

UpdatePendingReplacementBatchDataInput

Input type for update pending replacement batch data.

Field	Type	Description
pendingAppointmentId	ID	Identifier of the pending replacement batch item to update; when omitted, the batch item is treated as new.
entityId	ID!	The entity id value for this input.
eventDate	LocalDate	The event date value for this input.
jobTitle	String	The job title value for this input.
appointmentTypeIds	[ID!]!	The appointment type ids value for this input.
appointmentGroupId	ID	The appointment group id value for this input.
appointmentLevel	Int	The appointment level value for this input.
appointmentStatusId	ID	The appointment status id value for this input.
appointmentReminderDate	LocalDate	The appointment reminder date value for this input.
replaceWithEntityId	ID!	The entity ID of the person this appointment replaces.

UpdatePendingReplacementInput

Input type for update pending replacement.

Field	Type	Description
boardMeetingDate	LocalDate	The board meeting date value for this input.
consentToActGiven	Boolean	The consent to act given value for this input.
doesNotAttendMeetings	Boolean	The does not attend meetings value for this input.
notes	String	The notes value for this input.
showNotesOnRegister	Boolean	The show notes on register value for this input.
eventDate	LocalDate	The event date value for this input.
trackingStatus	TrackingStatusInput	The tracking status value for this input.
signatoryStatus	SignatoryStatusInput	The signatory status value for this input.
appointments	[UpdatePendingReplacementBatchDataInput!]	The replacement batch items for this input.

UpdatePendingResignationBatchDataInput

Input type for update pending resignation batch data.

Field	Type	Description
pendingAppointmentId	ID	Identifier of the pending resignation batch item to update; when omitted, the batch item is treated as new.
entityId	ID!	The entity id value for this input.
eventDate	LocalDate	The event date value for this input.
appointmentTypeIds	[ID!]!	The appointment type ids value for this input.

UpdatePendingResignationInput

Input type for update pending resignation.

Field	Type	Description
boardMeetingDate	LocalDate	The board meeting date value for this input.
notes	String	The notes value for this input.
showNotesOnRegister	Boolean	The show notes on register value for this input.
eventDate	LocalDate	The event date value for this input.
trackingStatus	TrackingStatusInput	The tracking status value for this input.
signatoryStatus	SignatoryStatusInput	The signatory status value for this input.
appointments	[UpdatePendingResignationBatchDataInput!]	The appointments value for this input.

UpdatePersonOptionsInput

Input type used for updating person-related options or settings.

Field	Type	Description
hasShareCertificates	Boolean	Indicates if share certificates are updated in person options.
hasStockTransferForms	Boolean	Indicates if stock transfer forms are updated in person options.
hasRegisterAddendums	Boolean	Indicates if register addendums are updated in person options.
hasOtherDirectorships	Boolean	Indicates if other directorships are updated in person options.

UpdateSubCountryInput

Input type used for updating details of a sub-country.

Field		Type	Description
name		String	Specifies the name for updating a sub-country input.

UpdateUserGroupingInput

Input type used for updating details of a user grouping.

Field		Type	Description
description		String	Describes an update for a user grouping input.

UpdateUserInput

Input type for update user.

Field	Type	Description
name	String	The name value for this input.
initials	String	The initials value for this input.
networkId	String	The network id value for this input.
loginEmail	String	The login email value for this input.
isDisabled	Boolean
isHidden	Boolean
defaultRoleId	ID	The default role id value for this input.
securityGroupIds	[ID!]

UserGroupingFilterPayloadFilterInput

Represents filtering options for user groupings.

Field	Type	Description
and	[UserGroupingFilterPayloadFilterInput!]
or	[UserGroupingFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering user grouping data.
priority	QueryCommonIntegerOperationFilterInput	Filters user groupings by their assigned priority.
description	QueryCommonStringOperationFilterInput	Represents the description of the filtered user grouping.
reference	QueryCommonStringOperationFilterInput	Filters user groupings by their reference code.

UserGroupingPayloadSortInput

Input object specifying sorting options for user grouping payload queries.

Field	Type	Description
priority	SortEnumType	Sorts user grouping payloads by their assigned priority.
description	SortEnumType	Sorts user grouping payloads by their description.
reference	SortEnumType	Sorts user grouping payloads by their reference code.

UserPayloadFilterInput

Input type for user payload filter.

Field	Type	Description
and	[UserPayloadFilterInput!]
or	[UserPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	The unique identifier.
reference	QueryCommonStringOperationFilterInput	Filters by reference.
name	QueryCommonStringOperationFilterInput	Filters by name.
initials	QueryCommonStringOperationFilterInput	Filters by initials.
securityGroupIds	QueryIdListOperationFilterInput
isDisabled	QueryCommonBooleanOperationFilterInput

UserPayloadSortInput

Sort users based on attributes such as name, reference, or login activity.

Field	Type	Description
initials	SortEnumType	Sort users by their initials.
name	SortEnumType	Sort users by their full name.
reference	SortEnumType	Sort users by their reference code.

UserRoleFilterPayloadFilterInput

Represents filtering options for user role payloads.

Field	Type	Description
and	[UserRoleFilterPayloadFilterInput!]
or	[UserRoleFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier used to filter user roles.
reference	QueryCommonStringOperationFilterInput	Represents the reference string used in user role filtering.
name	QueryCommonStringOperationFilterInput	Represents the name used to filter user role entries.

UserRolePayloadSortInput

Input object specifying sorting options for user role payload queries.

Field		Type	Description
reference		SortEnumType	Sorts user role payloads by their reference code.
name		SortEnumType	Sorts user role payloads by their name.

Enums

ApplyPolicy

This could refer to an authorization or security policy that governs access control, specifying how and when certain operations should be applied based on predefined rules.

Value	Description
BEFORE_RESOLVER	Before the resolver was executed.
AFTER_RESOLVER	After the resolver was executed.
VALIDATION	The policy is applied in the validation step before the execution.

CorporateRelationshipControlBy

Specifies the entity or factor that exercises control in a corporate relationship.

Value	Description
SHARES	Represents the shares option for corporate relationship control by.
BOARDS	Represents the boards option for corporate relationship control by.
OTHER	Represents the other option for corporate relationship control by.
UNKNOWN	Represents the unknown option for corporate relationship control by.

CorporateRelationshipPriority

Defines the priority level assigned to a corporate relationship.

Value	Description
HIGH	Represents the high option for corporate relationship priority.
MEDIUM	Represents the medium option for corporate relationship priority.
LOW	Represents the low option for corporate relationship priority.
UNKNOWN	Represents the unknown option for corporate relationship priority.

DataLibraryUsageType

Represents the usage type of a Data Library record (e.g., structured, unstructured).

Value	Description
DATA_LIBRARY_AND_DOCUMENT_PROPERTY	Represents the data library and document property option for data library usage type.
DATA_LIBRARY_ONLY	Represents the data library only option for data library usage type.
DOCUMENT_PROPERTY_ONLY	Represents the document property only option for data library usage type.

DataType

Represents the type of data being stored or processed (e.g., string, integer, boolean).

Value	Description
TEXT	Represents the text option for data type.
LONG	Represents the long option for data type.
DOUBLE	Represents the double option for data type.
BOOL	Represents the bool option for data type.
DATE	Represents the date option for data type.
MEMO	Represents the memo option for data type.
HEADING	Represents the heading option for data type.
SUB_HEADING	Represents the sub heading option for data type.
DECIMAL	Represents the decimal option for data type.
PERCENTAGE	Represents the percentage option for data type.
SPECIAL	Represents the special option for data type.
STANDARD_DATA_TYPE_MASK	Represents the standard data type mask option for data type.
SPECIAL_SHARE_CAT	Represents the special share cat option for data type.
SPECIAL_SHARE_SCHEME	Represents the special share scheme option for data type.
SPECIAL_SHARE_SCHEME_ISSUE	Represents the special share scheme issue option for data type.
SPECIAL_ADDRESS	Represents the special address option for data type.
SPECIAL_NOTE	Represents the special note option for data type.
SPECIAL_SPOOL	Represents the special spool option for data type.
SPECIAL_DATA_TYPE_MASK	Represents the special data type mask option for data type.
EMPTY	Represents the empty option for data type.
OTHER	Represents the other option for data type.

DocumentLogStatus

Represents document log status.

Value	Description
NOT_STARTED	Represents the not started option for document log status.
IN_PROGRESS	Represents the in progress option for document log status.
COMPLETED	Represents the completed option for document log status.

DocumentReferenceSegment

Represents a segment or component used in constructing a document reference format.

Value	Description
NONE	Represents the none option for document reference segment.
QUICK_REFERENCE	Represents the quick reference option for document reference segment.
USER_GROUPING	Represents the user grouping option for document reference segment.
FILE_REFERENCE	Represents the file reference option for document reference segment.
MANAGED_BY	Represents the managed by option for document reference segment.
MANAGE_BY_INITIALS	Represents the manage by initials option for document reference segment.
PARTNER	Represents the partner option for document reference segment.
PARTNER_INITIALS	Represents the partner initials option for document reference segment.
REGISTRATION_NUMBER	Represents the registration number option for document reference segment.
COUNTRY_CODE	Represents the country code option for document reference segment.
DOCUMENT_REFERENCE	Represents the document reference option for document reference segment.

DocumentReferenceSeparator

Represents the separator used between segments in a document reference string.

Value	Description
NONE	Represents the none option for document reference separator.
SPACE	Represents the space option for document reference separator.
SLASH	Represents the slash option for document reference separator.
DOT	Represents the dot option for document reference separator.
DASH	Represents the dash option for document reference separator.
COLON	Represents the colon option for document reference separator.
PLUS_SIGN	Represents the plus sign option for document reference separator.
ASTERISK	Represents the asterisk option for document reference separator.

DocumentStatus

Represents the current status of a document (e.g., Draft, Final, Archived).

Value	Description
IN_PROGRESS	Represents the in progress option for document status.
COMPLETED	Represents the completed option for document status.
DRAFT	Represents the draft option for document status.

EntityIdentificationType

Represents a category or classification of entity identification (e.g., tax ID, registration number).

Value	Description
UNKNOWN	Represents the unknown option for entity identification type.
IDV_CODE	Represents the idv code option for entity identification type.

EntitySecurityGroupRollUp

Represents a roll-up configuration for entity security groups.

Value	Description
STOP_AND_PROCESS	Represents the stop and process option for entity security group roll up.
ADD_RIGHTS_AND_CONTINUE	Represents the add rights and continue option for entity security group roll up.
REMOVE_RIGHTS_AND_CONTINUE	Represents the remove rights and continue option for entity security group roll up.

EntityTypeCategory

Represents a classification category for entity types (e.g., individual, company, trust).

Value	Description
COMPANY	Represents the company option for entity type category.
INDIVIDUAL	Represents the individual option for entity type category.
INCORPORATION	Represents the incorporation option for entity type category.
PARTNERSHIP	Represents the partnership option for entity type category.
OTHER_ENTITY	Represents the other entity option for entity type category.

FilterType

Represents filter type.

Value	Description
UNKNOWN	Represents the unknown option for filter type.
MY_PORTAL	Represents the my portal option for filter type.
QUICK_SEARCH	Represents the quick search option for filter type.
COMPANY_LIST	Represents the company list option for filter type.
COMPANY_LIST_REPORT	Represents the company list report option for filter type.
COMPANY_DETAILS	Represents the company details option for filter type.
COMPANY_DETAILS_REPORT	Represents the company details report option for filter type.
COMPANY_REGISTERS	Represents the company registers option for filter type.
INDIVIDUAL_LIST	Represents the individual list option for filter type.
INDIVIDUAL_LIST_REPORT	Represents the individual list report option for filter type.
INDIVIDUAL_DETAILS	Represents the individual details option for filter type.
INDIVIDUAL_DETAILS_REPORT	Represents the individual details report option for filter type.
CORPORATE_LIST	Represents the corporate list option for filter type.
CORPORATE_LIST_REPORT	Represents the corporate list report option for filter type.
CORPORATE_DETAILS	Represents the corporate details option for filter type.
CORPORATE_DETAILS_REPORT	Represents the corporate details report option for filter type.
INCORPORATION_LIST	Represents the incorporation list option for filter type.
INCORPORATION_LIST_REPORT	Represents the incorporation list report option for filter type.
INCORPORATION_DETAILS	Represents the incorporation details option for filter type.
INCORPORATION_DETAILS_REPORT	Represents the incorporation details report option for filter type.
BATCH_MANAGER	Represents the batch manager option for filter type.
BATCH_LABELS	Represents the batch labels option for filter type.
GROUP_STRUCTURE	Represents the group structure option for filter type.
GROUP_SEARCH	Represents the group search option for filter type.

GroupStructureType

Represents group structure type.

Value	Description
DOWN	Represents the down option for group structure type.
UP	Represents the up option for group structure type.
UP_AND_DOWN	Represents the up and down option for group structure type.

IndividualNameFormat

Specifies the format of an individual's name, such as 'First Last' or 'Last, First'.

Value	Description
FORENAMES_SURNAME	Represents the forenames surname option for individual name format.
SURNAME_FORENAMES	Represents the surname forenames option for individual name format.

JobNotificationStatus

Represents the status of a job notification.

Value	Description
NO_CHANGE	Represents the no change option for job notification status.
STARTED	Represents the started option for job notification status.
COMPLETED	Represents the completed option for job notification status.
ABORTED	Represents the aborted option for job notification status.
WAITING	Represents the waiting option for job notification status.
FAILED	Represents the failed option for job notification status.

JobType

Represents job type.

Value	Description
BATCH	Represents the batch option for job type.
TEST_JOB	Represents the test job option for job type.
QUICK_SPOOL_DOCUMENT	Represents the quick spool document option for job type.
QUICK_SPOOL_DOCUMENT_MEMORY	Represents the quick spool document memory option for job type.
SPOOL_PENDING	Represents the spool pending option for job type.
SPOOL_GROUP_STRUCTURE	Represents the spool group structure option for job type.
PRINT_SPOOL	Represents the print spool option for job type.
PRINT_SPOOL_MEMORY	Represents the print spool memory option for job type.
ACTION_PENDING	Represents the action pending option for job type.
DELETE_PENDING	Represents the delete pending option for job type.
EMAIL_DOCUMENTS	Represents the email documents option for job type.
EMAIL_DOCUMENTS_SMTP	Represents the email documents smtp option for job type.
ELECTRONIC_FILING_SEND_RECEIVE	Represents the electronic filing send receive option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_GENERIC	Represents the electronic filing send receive generic option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_AU	Represents the electronic filing send receive au option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_IE	Represents the electronic filing send receive ie option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_IE2	Represents the electronic filing send receive ie2 option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_IE_DOWNLOAD	Represents the electronic filing send receive ie download option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_INBOX	Represents the electronic filing send receive inbox option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_UK	Represents the electronic filing send receive uk option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_UK2	Represents the electronic filing send receive uk2 option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_UK3	Represents the electronic filing send receive uk3 option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_US_DE	Represents the electronic filing send receive us de option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_US_SEC	Represents the electronic filing send receive us sec option for job type.
ELECTRONIC_FILING_SEND_RECEIVE_IE_REG_SYS_API	Represents the electronic filing send receive ie reg sys api option for job type.
RUN_PLUGIN	Represents the run plugin option for job type.
RUN_SCRIPT	Represents the run script option for job type.
RUN_DOTNET_PLUGIN	Represents the run dotnet plugin option for job type.
UPDATE_NOTES	Represents the update notes option for job type.
DELETE_NOTES	Represents the delete notes option for job type.
PRINT_DOC	Represents the print doc option for job type.
IMPORT_FROM_EXTERNAL_SOURCE	Represents the import from external source option for job type.
IMPORT_EXPORT_DATABASE	Represents the import export database option for job type.
DELETE_FOLDER_TREE	Represents the delete folder tree option for job type.
SIGN_DOCUMENT	Represents the sign document option for job type.
IMPORT_DOCUMENT	Represents the import document option for job type.
PREVIEW_TEMPLATE_DOCUMENT	Represents the preview template document option for job type.
SPOOLER_JOB	Represents the spooler job option for job type.
SPOOL_BLANK_FROM	Represents the spool blank from option for job type.
SPOOL_DOCUMENT	Represents the spool document option for job type.

ResolutionForm

The enum value that specifies the form of a shareholders' resolution.

Value	Description
NOTICE_RESOLUTION_MINUTES	Represents a resolution passed at a meeting held on notice.
SHORT_NOTICE_RESOLUTION_MINUTES	Represents a resolution passed at a meeting held at short notice.
WRITTEN_FORM	Represents a resolution passed in written form.

ShareType

Represents the type of share (e.g., ordinary, preference, non-voting).

Value	Description
COMMON	Represents the common option for share type.
PREFERRED	Represents the preferred option for share type.
DEFERRED	Represents the deferred option for share type.
OTHER	Represents the other option for share type.

SortEnumType

Enumeration type specifying the available sorting options for queries or results.

Value	Description
ASC	Represents the asc option for sort enum type.
DESC	Represents the desc option for sort enum type.

StorageLocation

Represents the physical or logical location where data is stored (e.g., database, cloud, file system).

Value	Description
GENERAL	Represents the general option for storage location.
ENTITY_SPECIFIC	Represents the entity specific option for storage location.
CALCULATED	Represents the calculated option for storage location.
ENTITY_TABLE	Represents the entity table option for storage location.

StorageTable

Represents the target storage table used for storing records within the system.

Value	Description
GENERAL	Represents the general option for storage table.
COMPANY	Represents the company option for storage table.
INDIVIDUAL	Represents the individual option for storage table.
CORPORATE	Represents the corporate option for storage table.
INCORPORATION	Represents the incorporation option for storage table.
PARTNERSHIP	Represents the partnership option for storage table.
BRANCHES_AND_REGISTRATIONS	Represents the branches and registrations option for storage table.

UdfTextFlag

Represents udf text flag.

Value	Description
NORMAL	Represents the normal option for udf text flag.
UPPER	Represents the upper option for udf text flag.
PASSWORD	Represents the password option for udf text flag.
CHOICE_LIST	Represents the choice list option for udf text flag.
LIMITED_CHOICE_LIST	Represents the limited choice list option for udf text flag.
DATA_CHOICE_LIST	Represents the data choice list option for udf text flag.
RELOAD_ON_CHANGE	Represents the reload on change option for udf text flag.
CODED_LIST	Represents the coded list option for udf text flag.
SINGLE_LINE_EDIT	Represents the single line edit option for udf text flag.
ENCRYPTED	Represents the encrypted option for udf text flag.
LIST_MANAGER_CHOICE_LIST	Represents the list manager choice list option for udf text flag.
COUNTRY_CODE	Represents the country code option for udf text flag.
SUB_COUNTRY_CODE	Represents the sub country code option for udf text flag.
URL	Represents the url option for udf text flag.
IMAGE_URL	Represents the image url option for udf text flag.
MAIL_TO_URL	Represents the mail to url option for udf text flag.
USER	Represents the user option for udf text flag.
CURRENCY	Represents the currency option for udf text flag.
RADIO_CHOICE	Represents the radio choice option for udf text flag.
RADIO_ACROSS	Represents the radio across option for udf text flag.
CHECKBOX	Represents the checkbox option for udf text flag.
CHECKBOX_ACROSS	Represents the checkbox across option for udf text flag.
QUICK_REF	Represents the quick ref option for udf text flag.
USERS	Represents the users option for udf text flag.
COUNTRY_CODES	Represents the country codes option for udf text flag.
QUICK_REFERENCE	Represents the quick reference option for udf text flag.
HTML	Represents the html option for udf text flag.
SPECIAL	Represents the special option for udf text flag.

UserDateFormat

Represents user date format.

Value	Description
DAY_MONTH_YEAR	Represents the day month year option for user date format.
MONTH_DAY_YEAR	Represents the month day year option for user date format.
YEAR_MONTH_DAY	Represents the year month day option for user date format.

UserNumberFormat

Represents user number format.

Value	Description
COMMA_DECIMAL	Represents the comma decimal option for user number format.
DECIMAL_COMMA	Represents the decimal comma option for user number format.

ValidationSeverity

Severity of a validation issue.

Value	Description
INFORMATION	An informational validation message.
WARNING	A validation warning.
ERROR	A validation error.

Scalars

Any

A general-purpose placeholder type that can accept any value.

Boolean

The Boolean scalar type represents true or false.

Date

A data type representing a specific day, month, and year.

DateTime

Represents a date and time value in the system.

Decimal

Represents a decimal data type used for precise numeric values.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

LocalDate

Represents a date without a time zone or time component, following the ISO-8601 format (YYYY-MM-DD)

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Interfaces

Entity

A core object in the system representing a company, organization, or other legal entity with properties such as name, registration number, and incorporation date.

Field	Type	Description
country	Country	Represents country for entity.
entityBatches	[EntityBatch!]!	Represents entity batches for entity.
entitySecurityGroups	[EntitySecurityGroup!]!	Represents entity security groups for entity.
entitySets	[EntitySet!]	Represents entity sets for entity.
entityType	EntityType	Represents entity type for entity.
partner	Partner	Represents partner for entity.
personOptions	PersonOptions	Represents person options for entity.
subCountry	SubCountry	Represents sub country for entity.
managedBy	User	Represents managed by for entity.
userGrouping	UserGrouping	Represents user grouping for entity.
id	ID!	The unique identifier.
referenceType	EntityTypeCategory!	Represents reference type for entity.
entityReference	String	Represents entity reference for entity.
entityName	String	Represents entity name for entity.

Possible Types: Company, Individual, MinimalEntityPayload, OtherEntity, Trust

Error

Represents an error object that contains details about an issue encountered during an operation.

Field	Type	Description
extensions	[KeyValuePairOfStringAndJsonElement!]!	Represents extensions for error.
type	String	Represents type for error.
title	String	Represents title for error.
status	Int	Represents status for error.
detail	String	Represents detail for error.
instance	String	Represents instance for error.

Possible Types: ErrorOfAddressMappingPayload, ErrorOfAddressPayload, ErrorOfAddressTypePayload, ErrorOfCompanyOptionsPayload, ErrorOfCompanyPayload, ErrorOfCompanyStatusPayload, ErrorOfCompanyTypePayload, ErrorOfDataLibraryPayload, ErrorOfEntityBatchPayload, ErrorOfEntityIdentificationPayload, ErrorOfEntityPayload, ErrorOfEntitySecurityGroupPayload, ErrorOfEntitySetPayload, ErrorOfEntityTypePayload, ErrorOfIndividualPayload, ErrorOfJobPayload, ErrorOfNationalityPayload, ErrorOfOtherEntityPayload, ErrorOfPartnerPayload, ErrorOfPendingEventPayload, ErrorOfPendingEventStatusPayload, ErrorOfPersonOptionsPayload, ErrorOfSubCountryPayload, ErrorOfUserGroupingPayload, ErrorOfUserPayload, ValidationError

Node

Represents an element in a graph structure, typically used in GraphQL APIs to define a single entry or item in a data set.

Field	Argument	Type	Description
id		ID!	The unique identifier.

Possible Types: Address, AddressType, Appointment, AppointmentCategory, AppointmentGroup, AppointmentStatus, AppointmentType, AuditTrail, Company, CompanyStatus, CompanyType, CorporateRelationship, CorporateStructure, Country, Currency, DataLibrary, DataLibraryCategory, DataLibraryStatus, DataLibraryType, DataLibraryUdf, Document, EntityBatch, EntityIdentification, EntitySecurityGroup, EntitySet, EntityType, EventGroup, EventType, Individual, IndustrialClassification, Job, Nationality, Occupation, OtherEntity, Partner, PastAddressEntry, PendingAppointment, PendingEvent, SavedFilter, Share, ShareCategory, ShareClass, SubCountry, Trust, Udf, User, UserGrouping, UserRole

UdfContainerEntity

Represents the entity that contains user-defined fields (UDFs).

Field	Type	Description
country	Country	Represents country for udf container entity.
entityBatches	[EntityBatch!]!	Represents entity batches for udf container entity.
entitySecurityGroups	[EntitySecurityGroup!]!	Represents entity security groups for udf container entity.
entitySets	[EntitySet!]	Represents entity sets for udf container entity.
entityType	EntityType	Represents entity type for udf container entity.
partner	Partner	Represents partner for udf container entity.
personOptions	PersonOptions	Represents person options for udf container entity.
subCountry	SubCountry	Represents sub country for udf container entity.
managedBy	User	Represents managed by for udf container entity.
userGrouping	UserGrouping	Represents user grouping for udf container entity.
id	ID!	The unique identifier.
referenceType	EntityTypeCategory!	Represents reference type for udf container entity.
entityReference	String	Represents entity reference for udf container entity.
entityName	String	Represents entity name for udf container entity.

Possible Types: Company, Individual, OtherEntity, Trust

Unions

ActionPendingEventError

Represents an error encountered while actioning a pending event.

Type	Description
ErrorOfPendingEventStatusPayload	Represents an error response related to a pending event status payload.
ValidationError	Represents a validation error encountered during input or processing.

ConnectAddressToEntityError

Represents an error that can occur during connect address to entity operations.

Type	Description
ErrorOfAddressMappingPayload	Payload returned for error of address mapping operations.
ValidationError	Represents a validation error encountered during input or processing.

ConnectEntitiesToEntityBatchError

Represents an error encountered while connecting entities to an entity batch.

Type	Description
ErrorOfEntityBatchPayload	Represents an error payload specific to entity batch-related operations.
ValidationError	Represents a validation error encountered during input or processing.

ConnectEntitiesToEntitySecurityGroupError

Represents an error encountered during the update of an entity set.

Type	Description
ErrorOfEntitySecurityGroupPayload	Represents an error payload specific to entity security group-related operations.
ValidationError	Represents a validation error encountered during input or processing.

ConnectEntitiesToEntitySetError

Represents an error encountered while connecting entities to an entity set.

Type	Description
ErrorOfEntitySetPayload	Represents an error payload specific to entity set-related operations.
ValidationError	Represents a validation error encountered during input or processing.

ConnectEntityBatchesToEntityError

Represents an error encountered while connecting entity batches to an entity.

Type	Description
ErrorOfEntityPayload	Represents an error payload specific to entity-related operations.
ValidationError	Represents a validation error encountered during input or processing.

ConnectEntitySecurityGroupsToEntityError

Represents an error encountered while connecting entities to a security group.

Type	Description
ErrorOfEntityPayload	Represents an error payload specific to entity-related operations.
ValidationError	Represents a validation error encountered during input or processing.

ConnectEntitySetsToEntityError

Represents an error encountered while connecting entity sets to an entity.

Type	Description
ErrorOfEntityPayload	Represents an error payload specific to entity-related operations.
ValidationError	Represents a validation error encountered during input or processing.

ConnectEntityTypeToAddressTypeError

Represents an error encountered while connecting an entity type to an address type.

Type	Description
ErrorOfAddressTypePayload	Represents an error response related to an address type payload.
ValidationError	Represents a validation error encountered during input or processing.

CreateAddressError

Represents an error encountered during the creation of an address.

Type	Description
ErrorOfAddressPayload	Represents an error response related to an address payload.
ValidationError	Represents a validation error encountered during input or processing.

CreateAddressTypeError

Represents an error encountered during the creation of an address type.

Type	Description
ErrorOfAddressTypePayload	Represents an error response related to an address type payload.
ValidationError	Represents a validation error encountered during input or processing.

CreateCompanyError

Represents an error encountered during the creation of a company.

Type	Description
ValidationError	Represents a validation error encountered during input or processing.
ErrorOfCompanyPayload	Represents an error payload specific to company-related operations.

CreateCompanyStatusError

Represents an error encountered during the creation of a company status.

Type	Description
ErrorOfCompanyStatusPayload	Represents an error payload specific to company status-related operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateCompanyTypeError

Represents an error encountered during the creation of a company type.

Type	Description
ErrorOfCompanyTypePayload	Represents an error payload specific to company type-related operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateDataLibraryError

Represents an error encountered during the creation of a data library record.

Type	Description
ErrorOfDataLibraryPayload	Represents an error response related to a Data Library payload.
ValidationError	Represents a validation error encountered during input or processing.

CreateEntityBatchError

Represents an error encountered during the creation of an entity batch.

Type	Description
ErrorOfEntityBatchPayload	Represents an error payload specific to entity batch-related operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateEntityIdentificationError

Represents an error that occurred during the creation of an entity identification.

Type	Description
ErrorOfEntityIdentificationPayload	Represents an error returned in the context of entity identification operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateEntitySecurityGroupError

Represents an error encountered while connecting security groups to an entity.

Type	Description
ErrorOfEntitySecurityGroupPayload	Represents an error payload specific to entity security group-related operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateEntitySetError

Represents an error encountered while connecting entity sets to an entity.

Type	Description
ErrorOfEntitySetPayload	Represents an error payload specific to entity set-related operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateEntityTypeError

Represents an error encountered during the creation of an entity type.

Type	Description
ErrorOfEntityTypePayload	Represents an error payload specific to entity type-related operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateGroupStructureError

Represents an error that can occur during create group structure operations.

Type	Description
ErrorOfJobPayload	Payload returned for error of job operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateIndividualError

Represents an error encountered during the creation of an individual record.

Type	Description
ValidationError	Represents a validation error encountered during input or processing.
ErrorOfIndividualPayload	Represents an error payload specific to individual-related operations.

CreateNationalityError

Represents an error encountered during the creation of a nationality.

Type	Description
ErrorOfNationalityPayload	Represents an error payload specific to nationality-related operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateOtherEntityError

Represents an error encountered during the creation of another type of entity.

Type	Description
ValidationError	Represents a validation error encountered during input or processing.
ErrorOfOtherEntityPayload	Represents an error payload specific to other types of entities.

CreatePartnerError

Represents an error encountered during the creation of a partner.

Type	Description
ErrorOfPartnerPayload	Represents an error payload specific to partner-related operations.
ValidationError	Represents a validation error encountered during input or processing.

CreatePendingAppointmentError

Represents an error encountered during the creation of a pending appointment.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

CreatePendingChangeJobTitleError

Represents an error that can occur during create pending change job title operations.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

CreatePendingDeathError

Represents an error that can occur during create pending death operations.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

CreatePendingRemovalError

Represents an error that can occur during create pending removal operations.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

CreatePendingReplacementError

Represents an error encountered during the creation of a pending replacement.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

CreatePendingResignationError

Represents an error encountered during the creation of a pending resignation.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

CreatePendingShareClassError

Represents an error encountered during the creation of a pending share class.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

CreateSubCountryError

Represents an error encountered during the creation of a sub-country.

Type	Description
ErrorOfSubCountryPayload	Represents an error payload specific to sub-country-related operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateUserError

Represents an error that can occur during create user operations.

Type	Description
ErrorOfUserPayload	Payload returned for error of user operations.
ValidationError	Represents a validation error encountered during input or processing.

CreateUserGroupingError

Represents an error encountered during the creation of a user grouping.

Type	Description
ErrorOfUserGroupingPayload	Represents an error payload specific to user grouping-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteAddressError

Represents an error encountered during the deletion of an address.

Type	Description
ErrorOfAddressPayload	Represents an error response related to an address payload.
ValidationError	Represents a validation error encountered during input or processing.

DeleteAddressTypeError

Represents an error encountered during the deletion of an address type.

Type	Description
ErrorOfAddressTypePayload	Represents an error response related to an address type payload.
ValidationError	Represents a validation error encountered during input or processing.

DeleteCompanyError

Represents an error encountered during the deletion of a company.

Type	Description
ErrorOfCompanyPayload	Represents an error payload specific to company-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteCompanyStatusError

Represents an error encountered during the deletion of a company status.

Type	Description
ErrorOfCompanyStatusPayload	Represents an error payload specific to company status-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteCompanyTypeError

Represents an error encountered during the deletion of a company type.

Type	Description
ErrorOfCompanyTypePayload	Represents an error payload specific to company type-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteDataLibraryError

Represents an error encountered during the deletion of a data library record.

Type	Description
ErrorOfDataLibraryPayload	Represents an error response related to a Data Library payload.
ValidationError	Represents a validation error encountered during input or processing.

DeleteEntityBatchError

Represents an error encountered during the deletion of an entity batch.

Type	Description
ErrorOfEntityBatchPayload	Represents an error payload specific to entity batch-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteEntityIdentificationError

Error object returned if deletion of an entity identification fails.

Type	Description
ErrorOfEntityIdentificationPayload	Represents an error returned in the context of entity identification operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteEntitySecurityGroupError

The payload returned after creating an entity security group, containing details of the security group and any errors.

Type	Description
ErrorOfEntitySecurityGroupPayload	Represents an error payload specific to entity security group-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteEntitySetError

The payload returned after creating an entity set, containing details of the entity set and any errors.

Type	Description
ErrorOfEntitySetPayload	Represents an error payload specific to entity set-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteEntityTypeError

Represents an error encountered during the deletion of an entity type.

Type	Description
ErrorOfEntityTypePayload	Represents an error payload specific to entity type-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteIndividualError

Represents an error encountered during the deletion of an individual.

Type	Description
ErrorOfIndividualPayload	Represents an error payload specific to individual-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteNationalityError

Represents an error encountered during the deletion of a nationality.

Type	Description
ErrorOfNationalityPayload	Represents an error payload specific to nationality-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteOtherEntityError

Represents an error encountered during the deletion of another type of entity.

Type	Description
ErrorOfOtherEntityPayload	Represents an error payload specific to other types of entities.
ValidationError	Represents a validation error encountered during input or processing.

DeletePartnerError

Represents an error encountered during the deletion of a partner.

Type	Description
ErrorOfPartnerPayload	Represents an error payload specific to partner-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeletePendingEventBatchItemError

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

DeletePendingEventError

Represents an error encountered during the deletion of a pending event.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

DeleteSubCountryError

Represents an error encountered during the deletion of a sub-country.

Type	Description
ErrorOfSubCountryPayload	Represents an error payload specific to sub-country-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteUserError

Represents an error that can occur during delete user operations.

Type	Description
ErrorOfUserPayload	Payload returned for error of user operations.
ValidationError	Represents a validation error encountered during input or processing.

DeleteUserGroupingError

Represents an error encountered during the deletion of a user grouping.

Type	Description
ErrorOfUserGroupingPayload	Represents an error payload specific to user grouping-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DisconnectAddressFromEntityError

Represents an error that can occur during disconnect address from entity operations.

Type	Description
ErrorOfAddressMappingPayload	Payload returned for error of address mapping operations.
ValidationError	Represents a validation error encountered during input or processing.

DisconnectEntitiesFromEntityBatchError

Represents an error encountered while disconnecting entities from an entity batch.

Type	Description
ErrorOfEntityBatchPayload	Represents an error payload specific to entity batch-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DisconnectEntitiesFromEntitySecurityGroupError

Represents an error encountered during the deletion of an entity security group.

Type	Description
ErrorOfEntitySecurityGroupPayload	Represents an error payload specific to entity security group-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DisconnectEntitiesFromEntitySetError

Represents an error encountered during the deletion of an entity set.

Type	Description
ErrorOfEntitySetPayload	Represents an error payload specific to entity set-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DisconnectEntityBatchesFromEntityError

Represents an error encountered while disconnecting entity batches from an entity.

Type	Description
ErrorOfEntityPayload	Represents an error payload specific to entity-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DisconnectEntitySecurityGroupsFromEntityError

Represents an error encountered while disconnecting entities from a security group.

Type	Description
ErrorOfEntityPayload	Represents an error payload specific to entity-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DisconnectEntitySetsFromEntityError

Represents an error encountered while disconnecting entities from an entity set.

Type	Description
ErrorOfEntityPayload	Represents an error payload specific to entity-related operations.
ValidationError	Represents a validation error encountered during input or processing.

DisconnectEntityTypeFromAddressTypeError

Represents an error encountered while disconnecting an entity type from an address type.

Type	Description
ErrorOfAddressTypePayload	Represents an error response related to an address type payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdateAddressError

Represents an error encountered during the update of an address.

Type	Description
ErrorOfAddressPayload	Represents an error response related to an address payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdateAddressTypeError

Represents an error encountered during the update of an address type.

Type	Description
ErrorOfAddressTypePayload	Represents an error response related to an address type payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdateCompanyError

Represents an error encountered during the updating of a company.

Type	Description
ValidationError	Represents a validation error encountered during input or processing.
ErrorOfCompanyPayload	Represents an error payload specific to company-related operations.

UpdateCompanyOptionsError

Represents an error encountered during the updating of company-related options.

Type	Description
ErrorOfCompanyOptionsPayload	Represents an error payload specific to company options-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateCompanyStatusError

Represents an error encountered during the updating of a company status.

Type	Description
ErrorOfCompanyStatusPayload	Represents an error payload specific to company status-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateCompanyTypeError

Represents an error encountered during the updating of a company type.

Type	Description
ErrorOfCompanyTypePayload	Represents an error payload specific to company type-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateDataLibraryError

Represents an error encountered during the update of a data library record.

Type	Description
ErrorOfDataLibraryPayload	Represents an error response related to a Data Library payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdateEntityBatchError

Represents an error encountered during the update of an entity batch.

Type	Description
ErrorOfEntityBatchPayload	Represents an error payload specific to entity batch-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateEntityIdentificationError

Error object returned if an update to entity identification fails.

Type	Description
ErrorOfEntityIdentificationPayload	Represents an error returned in the context of entity identification operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateEntitySecurityGroupError

Represents an error encountered while disconnecting security groups from an entity.

Type	Description
ErrorOfEntitySecurityGroupPayload	Represents an error payload specific to entity security group-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateEntitySetError

Represents an error encountered while disconnecting entity sets from an entity.

Type	Description
ErrorOfEntitySetPayload	Represents an error payload specific to entity set-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateEntityTypeError

Represents an error encountered during the updating of an entity type.

Type	Description
ErrorOfEntityTypePayload	Represents an error payload specific to entity type-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateIndividualError

Represents an error encountered during the updating of an individual.

Type	Description
ValidationError	Represents a validation error encountered during input or processing.
ErrorOfIndividualPayload	Represents an error payload specific to individual-related operations.

UpdateNationalityError

Represents an error encountered during the updating of a nationality.

Type	Description
ErrorOfNationalityPayload	Represents an error payload specific to nationality-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateOtherEntityError

Represents an error encountered during the updating of another type of entity.

Type	Description
ValidationError	Represents a validation error encountered during input or processing.
ErrorOfOtherEntityPayload	Represents an error payload specific to other types of entities.

UpdatePartnerError

Represents an error encountered during the updating of a partner.

Type	Description
ErrorOfPartnerPayload	Represents an error payload specific to partner-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdatePendingAppointmentError

Represents an error that can occur during update pending appointment operations.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdatePendingChangeJobTitleError

Represents an error that can occur during update pending change job title operations.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdatePendingDeathError

Represents an error that can occur during update pending death operations.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdatePendingRemovalError

Represents an error that can occur during update pending removal operations.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdatePendingReplacementError

Represents an error that can occur during update pending replacement operations.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdatePendingResignationError

Represents an error that can occur during update pending resignation operations.

Type	Description
ErrorOfPendingEventPayload	Represents an error response related to a pending event payload.
ValidationError	Represents a validation error encountered during input or processing.

UpdatePersonOptionsError

Represents an error encountered during the updating of person-related options.

Type	Description
ErrorOfPersonOptionsPayload	Represents an error payload specific to person options-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateSubCountryError

Represents an error encountered during the updating of a sub-country.

Type	Description
ErrorOfSubCountryPayload	Represents an error payload specific to sub-country-related operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateUserError

Represents an error that can occur during update user operations.

Type	Description
ErrorOfUserPayload	Payload returned for error of user operations.
ValidationError	Represents a validation error encountered during input or processing.

UpdateUserGroupingError

Represents an error encountered during the updating of a user grouping.

Type	Description
ErrorOfUserGroupingPayload	Represents an error payload specific to user grouping-related operations.
ValidationError	Represents a validation error encountered during input or processing.

Query
Mutation
Objects
Inputs
Enums
Scalars
Interfaces
Unions

Schema Types

Query​

Mutation​

Objects​

ActionPendingEventPayload​

Address​

AddressEntry​

AddressType​

AddressTypesCollectionSegment​

AddressesCollectionSegment​

Appointment​

AppointmentCategoriesCollectionSegment​

AppointmentCategory​

AppointmentGroup​

AppointmentGroupsCollectionSegment​

AppointmentStatus​

AppointmentStatusesCollectionSegment​

AppointmentType​

AppointmentTypesCollectionSegment​

AppointmentsCollectionSegment​

AuditTrail​

AuditTrailsCollectionSegment​

CollectionSegmentInfo​

CompaniesCollectionSegment​

Company​

CompanyOptions​

CompanyStatus​

CompanyStatusesCollectionSegment​

CompanyType​

CompanyTypesCollectionSegment​

ConnectAddressToEntityPayload​

ConnectEntitiesToEntityBatchPayload​

ConnectEntitiesToEntitySecurityGroupPayload​

ConnectEntitiesToEntitySetPayload​

ConnectEntityBatchesToEntityPayload​

ConnectEntitySecurityGroupsToEntityPayload​

ConnectEntitySetsToEntityPayload​

ConnectEntityTypeToAddressTypePayload​

CorporateRelationship​

CorporateRelationshipsCollectionSegment​

CorporateStructure​

CorporateStructuresCollectionSegment​

CountriesCollectionSegment​

Country​

CreateAddressPayload​

CreateAddressTypePayload​

CreateCompanyPayload​

CreateCompanyStatusPayload​

CreateCompanyTypePayload​

CreateDataLibraryPayload​

CreateEntityBatchPayload​

CreateEntityIdentificationPayload​

CreateEntitySecurityGroupPayload​

CreateEntitySetPayload​

CreateEntityTypePayload​

CreateGroupStructurePayload​

CreateIndividualPayload​

CreateNationalityPayload​

CreateOtherEntityPayload​

CreatePartnerPayload​

CreatePendingAppointmentPayload​

CreatePendingChangeJobTitlePayload​

CreatePendingDeathPayload​

CreatePendingRemovalPayload​

CreatePendingReplacementPayload​

CreatePendingResignationPayload​

CreatePendingShareClassPayload​

CreateSubCountryPayload​

CreateUserGroupingPayload​

CreateUserPayload​

CurrenciesCollectionSegment​

Currency​

CurrentUser​

DataLibrariesCollectionSegment​

DataLibrary​

DataLibraryCategoriesCollectionSegment​

DataLibraryCategory​

DataLibraryStatus​

DataLibraryStatusesCollectionSegment​

DataLibraryType​

Query

Mutation

Objects

ActionPendingEventPayload

Address

AddressEntry

AddressType

AddressTypesCollectionSegment

AddressesCollectionSegment

Appointment

AppointmentCategoriesCollectionSegment

AppointmentCategory

AppointmentGroup

AppointmentGroupsCollectionSegment

AppointmentStatus

AppointmentStatusesCollectionSegment

AppointmentType

AppointmentTypesCollectionSegment

AppointmentsCollectionSegment

AuditTrail

AuditTrailsCollectionSegment

CollectionSegmentInfo

CompaniesCollectionSegment

Company

CompanyOptions

CompanyStatus

CompanyStatusesCollectionSegment

CompanyType

CompanyTypesCollectionSegment

ConnectAddressToEntityPayload

ConnectEntitiesToEntityBatchPayload

ConnectEntitiesToEntitySecurityGroupPayload

ConnectEntitiesToEntitySetPayload

ConnectEntityBatchesToEntityPayload

ConnectEntitySecurityGroupsToEntityPayload

ConnectEntitySetsToEntityPayload

ConnectEntityTypeToAddressTypePayload

CorporateRelationship

CorporateRelationshipsCollectionSegment

CorporateStructure

CorporateStructuresCollectionSegment

CountriesCollectionSegment

Country

CreateAddressPayload

CreateAddressTypePayload

CreateCompanyPayload

CreateCompanyStatusPayload

CreateCompanyTypePayload

CreateDataLibraryPayload

CreateEntityBatchPayload

CreateEntityIdentificationPayload

CreateEntitySecurityGroupPayload

CreateEntitySetPayload

CreateEntityTypePayload

CreateGroupStructurePayload

CreateIndividualPayload

CreateNationalityPayload

CreateOtherEntityPayload

CreatePartnerPayload

CreatePendingAppointmentPayload

CreatePendingChangeJobTitlePayload

CreatePendingDeathPayload

CreatePendingRemovalPayload

CreatePendingReplacementPayload

CreatePendingResignationPayload

CreatePendingShareClassPayload

CreateSubCountryPayload

CreateUserGroupingPayload

CreateUserPayload

CurrenciesCollectionSegment

Currency

CurrentUser

DataLibrariesCollectionSegment

DataLibrary

DataLibraryCategoriesCollectionSegment

DataLibraryCategory

DataLibraryStatus

DataLibraryStatusesCollectionSegment

DataLibraryType

DataLibraryTypesCollectionSegment