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.
companies	CompaniesCollectionSegment	Retrieves a list of companies based on the specified query filters.
skip	Int
take	Int
where	CompanyFilterPayloadFilterInput
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
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
countries	CountriesCollectionSegment	Retrieves a list of countries.
skip	Int
take	Int
where	CountryFilterPayloadFilterInput
country	Country	Retrieves a specific country by its ID.
id	ID!
currencies	CurrenciesCollectionSegment	Retrieves a list of currencies.
skip	Int
take	Int
where	CurrencyFilterPayloadFilterInput
currency	Currency	Retrieves a specific currency by its ID.
id	ID!
entities	EntitiesCollectionSegment	Fetches a collection of entities by query.
skip	Int
take	Int
where	EntityBaseFilterPayloadFilterInput
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
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
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
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
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
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
nationalities	NationalitiesCollectionSegment	Retrieves a list of nationalities.
skip	Int
take	Int
where	NationalityFilterPayloadFilterInput
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	OccupationFilterPayloadFilterInput
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
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
subCountries	SubCountriesCollectionSegment	Retrieves a list of sub-countries (e.g., states or provinces).
skip	Int
take	Int
where	SubCountryFilterPayloadFilterInput
subCountry	SubCountry	Retrieves a specific sub-country by its ID.
id	ID!
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
user	User	Retrieves a specific user by their ID.
id	ID!
users	UsersCollectionSegment	Retrieves a list of users.
skip	Int
take	Int
where	UserFilterPayloadFilterInput

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
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!
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!
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!
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!
updatePersonOptions	UpdatePersonOptionsPayload!	Mutation to update person-related options.
id	ID!
input	UpdatePersonOptionsInput!
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!

Objects

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.
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.
partner	Partner	The partner associated with the company.
managedBy	User	The user or entity that manages 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.
personOptions	PersonOptions	Person-related options for the company.
subCountry	SubCountry	The sub-country (e.g., state or province) where the company is located.
id	ID!	The unique identifier for the company.
isHistoricalRecord	Boolean	Indicates if the company record is historical.
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.
updatedAt	DateTime	Indicates the last update timestamp for a company.
referenceType	String	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.

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.
systemDefaultDocumentReferenceFormat	Int	Default format for document references.
lastUpdateAuditId	Int	ID of the last update audit.
lastUpdatedDate	LocalDate	The date when the company options were last updated.

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.
isNotInCountryCodes	Boolean!	Indicates whether this company type is excluded from certain country codes.
countryCodes	[String!]!	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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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
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.
userRole	String	The role of the user within 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.
setTypes	String	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.

ErrorOfCompanyOptionsPayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the company options error payload.

ErrorOfCompanyPayload

Represents an error payload specific to company-related operations.

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the company error payload.

ErrorOfCompanyStatusPayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the company status error payload.

ErrorOfCompanyTypePayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the company type error payload.

ErrorOfEntityBatchPayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the entity batch error payload.

ErrorOfEntityPayload

Represents an error payload specific to entity-related operations.

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the entity error payload.

ErrorOfEntitySecurityGroupPayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the entity security group error payload.

ErrorOfEntitySetPayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the entity set error payload.

ErrorOfEntityTypePayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the entity type error payload.

ErrorOfIndividualPayload

Represents an error payload specific to individual-related operations.

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the individual error payload.

ErrorOfNationalityPayload

Represents an error payload specific to nationality-related operations.

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the nationality error payload.

ErrorOfOtherEntityPayload

Represents an error payload specific to other types of entities.

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the other entity error payload.

ErrorOfPartnerPayload

Represents an error payload specific to partner-related operations.

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the partner error payload.

ErrorOfPersonOptionsPayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the person options error payload.

ErrorOfSubCountryPayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the sub-country error payload.

ErrorOfUserGroupingPayload

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

Field	Type	Description
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the user grouping error payload.

Individual

Represents an individual person in the system.

Field	Type	Description
nationality	Nationality	The nationality of the individual.
country	Country	The country of the individual.
partner	Partner	The partner associated with 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.
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.
personOptions	PersonOptions	Configuration options related to the individual.
id	ID!	The unique identifier for the 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.
updatedAt	DateTime	Indicates the last update timestamp for an individual.
referenceType	String	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.

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.

KeyValuePairOfStringAndObject

Represents a key-value pair where the key is a string, and the value is an object.

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

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.

MissingEntity

Represents an entity that could not be found or is missing from the database.

Field	Type	Description
country	Country	The country associated with the missing entity.
entityBatches	[EntityBatch!]!	The batches in which the entity was previously grouped.
entitySecurityGroups	[EntitySecurityGroup!]!	The security groups associated with the missing entity.
entitySets	[EntitySet!]!	The sets in which the entity was previously included.
entityType	EntityType	The type or classification of the missing entity (e.g., Company, Individual).
partner	Partner	The partner associated with the missing entity.
personOptions	PersonOptions	Person-specific options or settings related to the missing entity.
subCountry	SubCountry	The sub-country (e.g., state or province) associated with the missing entity.
managedBy	User	The entity or person responsible for managing the missing entity.
id	ID!	The unique identifier of the missing entity.
isHistoricalRecord	Boolean	Indicates whether the missing entity was part of a historical record.
updatedAt	DateTime	Indicates the last update timestamp for a missing entity.
referenceType	String	A quick reference type that provides a shorthand description or category for the entity.
entityReference	String	The reference to the specific entity that is missing.
entityName	String	The name of the missing 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.

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
companyOptions	CompanyOptions	Company-specific options for the entity.
partner	Partner	The partner associated with the entity.
managedBy	User	The entity or person responsible for managing the entity.
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.
personOptions	PersonOptions	Person-specific options for the entity.
subCountry	SubCountry	The sub-country (e.g., state or province) associated with the entity.
id	ID!	The unique identifier of the entity.
isHistoricalRecord	Boolean	Indicates whether the entity is part of historical records.
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.
updatedAt	DateTime	Indicates the last update timestamp for another entity.
referenceType	String	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.

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.

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.

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.

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

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.

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.

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.

User

Represents a user in the system.

Field	Type	Description
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.
role	String	The role assigned to the user within the system.

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.

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
validationErrors	[KeyValuePairOfStringAndString__!]!	A list or collection of validation errors encountered.
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.
extensions	[KeyValuePairOfStringAndObject!]!	Additional context or metadata related to the validation error.

Inputs

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	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering company data.
entityName	QueryCommonStringOperationFilterInput	Filters based on the company's name or a partial match of the name.
entityBatches	EntityBatchBaseFilterPayloadFilterInput	Used to filter companies that belong to a specific batch or set of actions, such as bulk updates or processing.
entitySets	EntitySetBaseFilterPayloadFilterInput	Represents the collection of entity sets associated with the company, used for grouping entities based on custom or logical criteria.
entitySecurityGroups	EntitySecurityGroupBaseFilterPayloadFilterInput	Filters based on security groups associated with the company, which determine access controls and permissions.
entityReference	QueryCommonStringOperationFilterInput	Filters based on the unique reference code assigned to the company.
entityType	EntityTypeBaseFilterPayloadFilterInput	Filters based on the type of entity, whether it's a company, partnership, trust, or other forms of legal entities.
country	CountryBaseFilterPayloadFilterInput	Filters companies based on the country where they are registered or operate.
subCountry	SubCountryBaseFilterPayloadFilterInput	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	UserBaseFilterPayloadFilterInput	Filters companies based on the user or system managing their records, used for administrative purposes.
partner	PartnerBaseFilterPayloadFilterInput	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.
companyStatus	CompanyStatusBaseFilterPayloadFilterInput	Filters companies based on their operational status, such as 'Active', 'Dormant', or 'Dissolved'.
companyType	CompanyTypeBaseFilterPayloadFilterInput	Filters based on the legal structure of the company, such as 'Limited', 'Public Limited Company', or 'LLP'.
currency	CurrencyBaseFilterPayloadFilterInput	Filters based on the currency that the company primarily operates in, used in financial reporting and transactions.

CompanyStatusBaseFilterPayloadFilterInput

Base input for filtering companies based on their operational or financial status.

Field	Type	Description
and	[CompanyStatusBaseFilterPayloadFilterInput!]
or	[CompanyStatusBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering base company status data.
reference	QueryCommonStringOperationFilterInput	Filters based on a reference code or identifier used to track company statuses.
name	QueryCommonStringOperationFilterInput	Filters based on the name or label assigned to the company's status, such as 'Active' or 'Suspended'.

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	EntityTypeBaseFilterPayloadFilterInput	Filters by the entity type, such as 'Company' or 'Partnership'.

CompanyTypeBaseFilterPayloadFilterInput

Input for filtering companies based on their legal or operational type.

Field	Type	Description
and	[CompanyTypeBaseFilterPayloadFilterInput!]
or	[CompanyTypeBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering base company type data.
reference	QueryCommonStringOperationFilterInput	Filters based on a reference code for company types.
name	QueryCommonStringOperationFilterInput	Filters based on the name of the company type, such as 'Limited' or 'PLC'.

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.
countryCodes	QueryStringListOperationFilterInput	Filters based on the country codes where the company operates or is registered.
isHidden	QueryCommonBooleanOperationFilterInput	A boolean filter to exclude or include hidden companies from the results.
isNotInCountryCodes	QueryCommonBooleanOperationFilterInput	Filters companies that are not registered in the specified countries.
entityType	EntityTypeBaseFilterPayloadFilterInput	Filters companies by their entity type (e.g., company, trust, partnership).

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.

CountryBaseFilterPayloadFilterInput

Filters country records based on standard attributes like name and code.

Field	Type	Description
and	[CountryBaseFilterPayloadFilterInput!]
or	[CountryBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering country base payload data.
countryCode	QueryCommonStringOperationFilterInput	Filters by the country code (e.g., ISO 3166 format).
name	QueryCommonStringOperationFilterInput	Filters by the name of the country.

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.

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.

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.
isNotInCountryCodes	Boolean	Country codes excluded for the new company type.
countryCodes	[String!]	Country codes associated with the new company type.
isHidden	Boolean	Indicates if the new company type is hidden.

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.

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.
userRole	String	The user role for creating a new entity security group.
liveReference	String	The live reference for the new entity security group.
systemPredefined	Boolean	Indicates if the new entity security group is predefined.
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.
setTypes	String	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.

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.

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.

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.

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.

CurrencyBaseFilterPayloadFilterInput

Filters companies or transactions based on currency-related details.

Field	Type	Description
and	[CurrencyBaseFilterPayloadFilterInput!]
or	[CurrencyBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering base currency data.
reference	QueryCommonStringOperationFilterInput	Filters based on a reference code for the currency.
currencyCode	QueryCommonStringOperationFilterInput	Filters based on the standard code of the currency, such as 'USD', 'GBP', or 'EUR'.
name	QueryCommonStringOperationFilterInput	Filters based on the name of the currency, like 'Dollar' or 'Euro'.

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	CountryBaseFilterPayloadFilterInput	Filters currency data based on the associated country.

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.

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.

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.

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.

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.

EntityBaseFilterPayloadFilterInput

Provides a base filter for entities based on multiple attributes.

Field	Type	Description
and	[EntityBaseFilterPayloadFilterInput!]
or	[EntityBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering base entity data.
entityName	QueryCommonStringOperationFilterInput	Filters entities based on their name.
entityBatches	EntityBatchBaseFilterPayloadFilterInput	Filters entities based on batch assignments.
entitySets	EntitySetBaseFilterPayloadFilterInput	Filters entities by their assigned sets.
entitySecurityGroups	EntitySecurityGroupBaseFilterPayloadFilterInput	Filters entities based on their security groups.
entityReference	QueryCommonStringOperationFilterInput	Represents the entity reference associated with a filtered base entity.
entityType	EntityTypeBaseFilterPayloadFilterInput	Filters entities by their type (e.g., individual, company).
country	CountryBaseFilterPayloadFilterInput	Filters entities by the associated country.
subCountry	SubCountryBaseFilterPayloadFilterInput	Filters entities based on sub-country regions.
personOptions	PersonOptionsFilterPayloadFilterInput	Filters entities based on available person-related options.
managedBy	UserBaseFilterPayloadFilterInput	Filters entities by their managing user or group.
partner	PartnerBaseFilterPayloadFilterInput	Represents the partner associated with a filtered base entity.

EntityBatchBaseFilterPayloadFilterInput

Filters entity batches based on batch-specific attributes.

Field	Type	Description
and	[EntityBatchBaseFilterPayloadFilterInput!]
or	[EntityBatchBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering entity batch base payload data.
reference	QueryStringListOperationFilterInput	Filters by the reference identifier for the batch.
name	QueryStringListOperationFilterInput	Filters by the name of the batch.

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	UserBaseFilterPayloadFilterInput	Filters by the user associated with the batch.

EntitySecurityGroupBaseFilterPayloadFilterInput

Filters security groups based on predefined attributes.

Field	Type	Description
and	[EntitySecurityGroupBaseFilterPayloadFilterInput!]
or	[EntitySecurityGroupBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering entity security group base payload data.
reference	QueryStringListOperationFilterInput	Filters by the reference code for the security group.
name	QueryStringListOperationFilterInput	Filters by the name of the security group.

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.
userRole	QueryCommonStringOperationFilterInput	Filters by the user role assigned within 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.

EntitySetBaseFilterPayloadFilterInput

Filters entity sets based on standard attributes.

Field	Type	Description
and	[EntitySetBaseFilterPayloadFilterInput!]
or	[EntitySetBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering entity set base payload data.
reference	QueryStringListOperationFilterInput	Filters by the reference code for the entity set.
name	QueryStringListOperationFilterInput	Filters by the name of the entity set.

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.
setTypes	QueryCommonStringOperationFilterInput	Filters by the types of sets an entity belongs to.

EntityTypeBaseFilterPayloadFilterInput

Filters entity types based on standard attributes.

Field	Type	Description
and	[EntityTypeBaseFilterPayloadFilterInput!]
or	[EntityTypeBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering entity type base payload data.
reference	QueryCommonStringOperationFilterInput	Filters by the reference identifier for the entity type.
name	QueryCommonStringOperationFilterInput	Filters by the name of the entity type.

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').

IndividualFilterPayloadFilterInput

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

Field	Type	Description
and	[IndividualFilterPayloadFilterInput!]
or	[IndividualFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering individual data.
entityName	QueryCommonStringOperationFilterInput	Filters individuals based on the name of the entity they are associated with.
entityBatches	EntityBatchBaseFilterPayloadFilterInput	Filters individuals based on batches or groups of entity-related processes.
entitySets	EntitySetBaseFilterPayloadFilterInput	Filters individuals based on the sets of entities they are associated with.
entitySecurityGroups	EntitySecurityGroupBaseFilterPayloadFilterInput	Filters individuals by the security groups they belong to, determining access permissions.
entityReference	QueryCommonStringOperationFilterInput	Represents the entity reference associated with a filtered individual.
entityType	EntityTypeBaseFilterPayloadFilterInput	Filters individuals based on the type of entity they are associated with (e.g., company, partnership).
country	CountryBaseFilterPayloadFilterInput	Filters individuals based on their country of residence or operation.
subCountry	SubCountryBaseFilterPayloadFilterInput	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	UserBaseFilterPayloadFilterInput	Filters individuals by the user or group managing their records.
partner	PartnerBaseFilterPayloadFilterInput	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	NationalityBaseFilterPayloadFilterInput	Filters individuals by their nationality.

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.
country	CountryBaseFilterPayloadFilterInput	Represents the country associated with a filtered industrial classification.

NationalityBaseFilterPayloadFilterInput

Represents filtering input for nationality base entities.

Field	Type	Description
and	[NationalityBaseFilterPayloadFilterInput!]
or	[NationalityBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering nationality base payload data.
name	QueryCommonStringOperationFilterInput	Represents the name associated with a filtered nationality base entity.

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	CountryBaseFilterPayloadFilterInput	Represents the country associated with a filtered nationality.
subCountry	SubCountryBaseFilterPayloadFilterInput	Represents the sub-country associated with a filtered nationality.

OccupationFilterPayloadFilterInput

Provides a base filter for occupations based on criteria.

Field	Type	Description
and	[OccupationFilterPayloadFilterInput!]
or	[OccupationFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering occupation data.
reference	QueryCommonStringOperationFilterInput	Filters occupations by their reference ID.

OtherEntityFilterPayloadFilterInput

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

Field	Type	Description
and	[OtherEntityFilterPayloadFilterInput!]
or	[OtherEntityFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	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.
entityBatches	EntityBatchBaseFilterPayloadFilterInput	Used for filtering entities that are part of a specific batch or process group.
entitySets	EntitySetBaseFilterPayloadFilterInput	Represents collections of entities grouped together for administrative or logical reasons.
entitySecurityGroups	EntitySecurityGroupBaseFilterPayloadFilterInput	Filters based on the security groups assigned to the entity, determining access and permissions.
entityReference	QueryCommonStringOperationFilterInput	Represents the entity reference associated with a filtered other entity.
entityType	EntityTypeBaseFilterPayloadFilterInput	Filters based on the entity type, whether it is a company, trust, partnership, or other.
country	CountryBaseFilterPayloadFilterInput	Filters entities based on the country of operation or registration.
subCountry	SubCountryBaseFilterPayloadFilterInput	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	UserBaseFilterPayloadFilterInput	Filters based on the user or team managing the entity's records.
partner	PartnerBaseFilterPayloadFilterInput	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.

PartnerBaseFilterPayloadFilterInput

Represents filtering input for base partner entities.

Field	Type	Description
and	[PartnerBaseFilterPayloadFilterInput!]
or	[PartnerBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering partner base payload data.
name	QueryCommonStringOperationFilterInput	Represents the name associated with a filtered partner base entity.

PartnerFilterPayloadFilterInput

Represents filtering input for partner entities.

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

PersonOptionsFilterPayloadFilterInput

Filters person-related records based on options or preferences.

Field	Type	Description
and	[PersonOptionsFilterPayloadFilterInput!]
or	[PersonOptionsFilterPayloadFilterInput!]
noOtherDirectorships	QueryCommonBooleanOperationFilterInput	Filters based on whether the individual holds no other directorships.
noRegisterAddendums	QueryCommonBooleanOperationFilterInput	Filters based on whether there are no register addendums for the individual.
noShareCertificates	QueryCommonBooleanOperationFilterInput	Filters based on whether there are no share certificates associated with the individual.
noStockTransferForms	QueryCommonBooleanOperationFilterInput	Filters based on whether there are no stock transfer forms for the individual.

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
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.

QueryCommonIntegerOperationFilterInput

A filter for integer fields, supporting various comparison operations.

Field	Type	Description
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.

QueryCommonStringOperationFilterInput

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

Field	Type	Description
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.

QueryIdStringOperationFilterInput

Represents filtering operations based on string identifiers.

Field	Type	Description
and	[QueryIdStringOperationFilterInput!]
or	[QueryIdStringOperationFilterInput!]
eq	String	Represents an equality comparison for string identifiers.
neq	String	Represents a non-equality comparison for string identifiers.

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.

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.

SubCountryBaseFilterPayloadFilterInput

Filters sub-country records, such as states or regions, based on standard attributes.

Field	Type	Description
and	[SubCountryBaseFilterPayloadFilterInput!]
or	[SubCountryBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering sub-country base payload data.
subCountryCode	QueryCommonStringOperationFilterInput	Filters by the sub-country code (e.g., state or province code).
name	QueryCommonStringOperationFilterInput	Filters by the name of the sub-country (e.g., state or province).

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	CountryBaseFilterPayloadFilterInput	Filters sub-country data based on the associated country.

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.
nextAccountsDate	LocalDate	The next accounts 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.
annualReturnOverdueDate	LocalDate	The annual return overdue date for the company.
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.
annualMeetingOverdueDate	LocalDate	The annual meeting overdue date for the company.
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.
becameSingleMemberCompanyOnDate	LocalDate	The date the company became a single member company.
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.

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.
systemDefaultDocumentReferenceFormat	Int	System default document reference format for options.

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.
isNotInCountryCodes	Boolean	Country codes excluded for the company type to update.
countryCodes	[String!]	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.

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.

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.
userRole	String	The user role for the entity security group to update.
liveReference	String	The live reference for the entity security group.
systemPredefined	Boolean	Indicates if the entity security group is system-predefined.
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.
setTypes		String	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.

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.

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.

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.

UserBaseFilterPayloadFilterInput

Filters user records based on standard attributes.

Field	Type	Description
and	[UserBaseFilterPayloadFilterInput!]
or	[UserBaseFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering user base payload data.
reference	QueryCommonStringOperationFilterInput	Filters by the reference identifier for the user.
name	QueryCommonStringOperationFilterInput	Filters by the name of the user.

UserFilterPayloadFilterInput

Filters user records based on attributes like reference or name.

Field	Type	Description
and	[UserFilterPayloadFilterInput!]
or	[UserFilterPayloadFilterInput!]
id	QueryIdStringOperationFilterInput	Represents the unique identifier for filtering user data.
reference	QueryCommonStringOperationFilterInput	Filters users by their reference code or identifier.
name	QueryCommonStringOperationFilterInput	Filters users by their name.

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.
description	QueryCommonStringOperationFilterInput	Represents the description of the filtered user grouping.

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.

EntitySecurityGroupRollUp

Represents a roll-up configuration for entity security groups.

Value	Description
STOP_AND_PROCESS
ADD_RIGHTS_AND_CONTINUE
REMOVE_RIGHTS_AND_CONTINUE

IndividualNameFormat

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

Value	Description
FORENAMES_SURNAME
SURNAME_FORENAMES

Scalars

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.

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	Argument	Type	Description
country		Country
entityBatches		[EntityBatch!]!
entitySecurityGroups		[EntitySecurityGroup!]!
entitySets		[EntitySet!]!
entityType		EntityType
partner		Partner
personOptions		PersonOptions
subCountry		SubCountry
managedBy		User
id		ID!
updatedAt		DateTime
referenceType		String
entityReference		String
entityName		String

Possible Types: Company, Individual, MissingEntity, OtherEntity

Error

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

Field	Argument	Type	Description
type		String
title		String
status		Int
detail		String
instance		String
extensions		[KeyValuePairOfStringAndObject!]!

Possible Types: ErrorOfCompanyOptionsPayload, ErrorOfCompanyPayload, ErrorOfCompanyStatusPayload, ErrorOfCompanyTypePayload, ErrorOfEntityBatchPayload, ErrorOfEntityPayload, ErrorOfEntitySecurityGroupPayload, ErrorOfEntitySetPayload, ErrorOfEntityTypePayload, ErrorOfIndividualPayload, ErrorOfNationalityPayload, ErrorOfOtherEntityPayload, ErrorOfPartnerPayload, ErrorOfPersonOptionsPayload, ErrorOfSubCountryPayload, ErrorOfUserGroupingPayload, 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!

Possible Types: Company, CompanyStatus, CompanyType, Country, Currency, EntityBatch, EntitySecurityGroup, EntitySet, EntityType, Individual, IndustrialClassification, Nationality, Occupation, OtherEntity, Partner, SubCountry, User, UserGrouping

Unions

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.

CreateCompanyError

Represents an error encountered during the creation 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.

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.

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.

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.

CreateIndividualError

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

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

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
ErrorOfOtherEntityPayload	Represents an error payload specific to other types of entities.
ValidationError	Represents a validation error encountered during input or processing.

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.

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.

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.

DeleteCompanyError

Represents an error encountered during the deletion of a company.

Type	Description
ErrorOfCompanyPayload	Represents an error payload specific to company-related operations.

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.

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.

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.

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.

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.

DeleteIndividualError

Represents an error encountered during the deletion of an individual.

Type	Description
ErrorOfIndividualPayload	Represents an error payload specific to individual-related operations.

DeleteNationalityError

Represents an error encountered during the deletion of a nationality.

Type	Description
ErrorOfNationalityPayload	Represents an error payload specific to nationality-related operations.

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.

DeletePartnerError

Represents an error encountered during the deletion of a partner.

Type	Description
ErrorOfPartnerPayload	Represents an error payload specific to partner-related operations.

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.

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.

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.

UpdateCompanyError

Represents an error encountered during the updating 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.

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.

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.

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
ErrorOfIndividualPayload	Represents an error payload specific to individual-related operations.
ValidationError	Represents a validation error encountered during input or processing.

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
ErrorOfOtherEntityPayload	Represents an error payload specific to other types of entities.
ValidationError	Represents a validation error encountered during input or processing.

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.

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.

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​

CollectionSegmentInfo​

CompaniesCollectionSegment​

Company​

CompanyOptions​

CompanyStatus​

CompanyStatusesCollectionSegment​

CompanyType​

CompanyTypesCollectionSegment​

ConnectEntitiesToEntityBatchPayload​

ConnectEntitiesToEntitySecurityGroupPayload​

ConnectEntitiesToEntitySetPayload​

ConnectEntityBatchesToEntityPayload​

ConnectEntitySecurityGroupsToEntityPayload​

ConnectEntitySetsToEntityPayload​

CountriesCollectionSegment​

Country​

CreateCompanyPayload​

CreateCompanyStatusPayload​

CreateCompanyTypePayload​

CreateEntityBatchPayload​

CreateEntitySecurityGroupPayload​

CreateEntitySetPayload​

CreateEntityTypePayload​

CreateIndividualPayload​

CreateNationalityPayload​

CreateOtherEntityPayload​

CreatePartnerPayload​

CreateSubCountryPayload​

CreateUserGroupingPayload​

CurrenciesCollectionSegment​

Currency​

DeleteCompanyPayload​

DeleteCompanyStatusPayload​

DeleteCompanyTypePayload​

DeleteEntityBatchPayload​

DeleteEntitySecurityGroupPayload​

DeleteEntitySetPayload​

DeleteEntityTypePayload​

DeleteIndividualPayload​

DeleteNationalityPayload​

DeleteOtherEntityPayload​

DeletePartnerPayload​

DeleteSubCountryPayload​

DeleteUserGroupingPayload​

DisconnectEntitiesFromEntityBatchPayload​

DisconnectEntitiesFromEntitySecurityGroupPayload​

DisconnectEntitiesFromEntitySetPayload​

DisconnectEntityBatchesFromEntityPayload​

DisconnectEntitySecurityGroupsFromEntityPayload​

DisconnectEntitySetsFromEntityPayload​

EntitiesCollectionSegment​

EntityBatch​

EntityBatchesCollectionSegment​

EntitySecurityGroup​

EntitySecurityGroupsCollectionSegment​

EntitySet​

EntitySetsCollectionSegment​

EntityType​

EntityTypesCollectionSegment​

ErrorOfCompanyOptionsPayload​

ErrorOfCompanyPayload​

ErrorOfCompanyStatusPayload​

ErrorOfCompanyTypePayload​

ErrorOfEntityBatchPayload​

ErrorOfEntityPayload​

ErrorOfEntitySecurityGroupPayload​

ErrorOfEntitySetPayload​

ErrorOfEntityTypePayload​

ErrorOfIndividualPayload​

ErrorOfNationalityPayload​

ErrorOfOtherEntityPayload​

ErrorOfPartnerPayload​

ErrorOfPersonOptionsPayload​

ErrorOfSubCountryPayload​

ErrorOfUserGroupingPayload​

Individual​