Skip to main content

Schema Types

Table of Contents

Query

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

FieldArgumentTypeDescription
nodeNode

Retrieves a single node by its ID from the system.

idID!

ID of the object.

nodes[Node]!

Retrieves multiple nodes based on specific filters or criteria.

ids[ID!]!

The list of node IDs.

addressAddress

Fetches a specific address by query.

idID!
addressesAddressesCollectionSegment

Fetches a collection of addresses by query.

skipInt
takeInt
whereAddressFilterPayloadFilterInput
addressTypeAddressType

Fetches a specific address type by query.

idID!
addressTypesAddressTypesCollectionSegment

Fetches a collection of address type by query.

skipInt
takeInt
whereAddressTypeFilterPayloadFilterInput
appointmentCategoriesAppointmentCategoriesCollectionSegment

Retrieves the list of appointment categories available in the system.

skipInt
takeInt
whereAppointmentCategoryFilterPayloadFilterInput
appointmentCategoryAppointmentCategory

Fetches a specific appointment category by query.

idID!
appointmentGroupAppointmentGroup

Fetches a specific appointment group by query.

idID!
appointmentGroupsAppointmentGroupsCollectionSegment

Fetches a collection of appointment groups by query.

skipInt
takeInt
whereAppointmentGroupFilterPayloadFilterInput
appointmentAppointment

Fetches a specific appointment by query.

idID!
appointmentsAppointmentsCollectionSegment

Fetches a collection of appointments by query.

skipInt
takeInt
whereAppointmentFilterPayloadFilterInput
appointmentStatusAppointmentStatus

Fetches a specific appointment status by query.

idID!
appointmentStatusesAppointmentStatusesCollectionSegment

Fetches a collection of appointment statuses by query.

skipInt
takeInt
whereAppointmentStatusFilterPayloadFilterInput
appointmentTypeAppointmentType

Fetches a specific appointment type by query.

idID!
appointmentTypesAppointmentTypesCollectionSegment

Fetches a collection of appointment types by query.

skipInt
takeInt
whereAppointmentTypeFilterPayloadFilterInput
companiesCompaniesCollectionSegment

Retrieves a list of companies based on the specified query filters.

skipInt
takeInt
whereCompanyFilterPayloadFilterInput
companyCompany

Retrieves a specific company by its ID.

idID!
companyStatusCompanyStatus

Retrieves the status of a specific company.

idID!
companyStatusesCompanyStatusesCollectionSegment

Retrieves a list of possible company statuses (e.g., active, dissolved).

skipInt
takeInt
whereCompanyStatusFilterPayloadFilterInput
companyTypeCompanyType

Retrieves a single company type based on its ID.

idID!
companyTypesCompanyTypesCollectionSegment

Retrieves a list of available company types.

skipInt
takeInt
whereCompanyTypeFilterPayloadFilterInput
countriesCountriesCollectionSegment

Retrieves a list of countries.

skipInt
takeInt
whereCountryFilterPayloadFilterInput
countryCountry

Retrieves a specific country by its ID.

idID!
currenciesCurrenciesCollectionSegment

Retrieves a list of currencies.

skipInt
takeInt
whereCurrencyFilterPayloadFilterInput
currencyCurrency

Retrieves a specific currency by its ID.

idID!
entitiesEntitiesCollectionSegment

Fetches a collection of entities by query.

skipInt
takeInt
whereEntityBaseFilterPayloadFilterInput
entityBatchEntityBatch

Retrieves a specific entity batch by its ID.

idID!
entityBatchesEntityBatchesCollectionSegment

Retrieves a list of entity batches.

skipInt
takeInt
whereEntityBatchFilterPayloadFilterInput
entityIdentificationEntityIdentification

Retrieves a specific entity identification by ID.

idID!
entitySecurityGroupEntitySecurityGroup

Retrieves a specific entity security group by its ID.

idID!
entitySecurityGroupsEntitySecurityGroupsCollectionSegment

Retrieves a list of entity security groups.

skipInt
takeInt
whereEntitySecurityGroupFilterPayloadFilterInput
entitySetEntitySet

Retrieves a specific entity set by its ID.

idID!
entitySetsEntitySetsCollectionSegment

Retrieves a list of entity sets.

skipInt
takeInt
whereEntitySetFilterPayloadFilterInput
entityTypeEntityType

Retrieves a single entity type based on its ID.

idID!
entityTypesEntityTypesCollectionSegment

Retrieves a list of entity types.

skipInt
takeInt
whereEntityTypeFilterPayloadFilterInput
eventGroupEventGroup

Retrieves a single event group by its identifier.

idID!
eventGroupsEventGroupsCollectionSegment

Retrieves a list of all event groups.

skipInt
takeInt
whereEventGroupFilterPayloadFilterInput
eventTypeEventType

Retrieves a single event type by its identifier.

idID!
eventTypesEventTypesCollectionSegment

Retrieves a list of all event types.

skipInt
takeInt
whereEventTypeFilterPayloadFilterInput
individualIndividual

Retrieves a specific individual entity by its ID.

idID!
individualsIndividualsCollectionSegment

Retrieves a list of individual entities.

skipInt
takeInt
whereIndividualFilterPayloadFilterInput
industrialClassificationIndustrialClassification

Retrieves a specific industrial classification by its ID.

idID!
industrialClassificationsIndustrialClassificationsCollectionSegment

Retrieves a list of industrial classifications.

skipInt
takeInt
whereIndustrialClassificationFilterPayloadFilterInput
nationalitiesNationalitiesCollectionSegment

Retrieves a list of nationalities.

skipInt
takeInt
whereNationalityFilterPayloadFilterInput
nationalityNationality

Retrieves a specific nationality by its ID.

idID!
occupationOccupation

Fetches a specific occupation by query.

idID!
occupationsOccupationsCollectionSegment

Fetches a collection of occupations by query.

skipInt
takeInt
whereOccupationFilterPayloadFilterInput
otherEntitiesOtherEntitiesCollectionSegment

Retrieves a list of other types of entities (e.g., individuals or organizations) based on query filters.

skipInt
takeInt
whereOtherEntityFilterPayloadFilterInput
otherEntityOtherEntity

Retrieves a specific other entity by its ID.

idID!
partnerPartner

Retrieves a specific partner entity by its ID.

idID!
partnersPartnersCollectionSegment

Retrieves a list of partner entities.

skipInt
takeInt
wherePartnerFilterPayloadFilterInput
subCountriesSubCountriesCollectionSegment

Retrieves a list of sub-countries (e.g., states or provinces).

skipInt
takeInt
whereSubCountryFilterPayloadFilterInput
subCountrySubCountry

Retrieves a specific sub-country by its ID.

idID!
userGroupingUserGrouping

Retrieves a specific user grouping by its ID.

idID!
userGroupingsUserGroupingsCollectionSegment

Retrieves a list of user groupings.

skipInt
takeInt
whereUserGroupingFilterPayloadFilterInput
userRoleUserRole

Retrieves a specific user role based on provided parameters.

idID!
userRolesUserRolesCollectionSegment

Retrieves a collection of user roles available in the system.

skipInt
takeInt
whereUserRoleFilterPayloadFilterInput
userUser

Retrieves a specific user by their ID.

idID!
usersUsersCollectionSegment

Retrieves a list of users.

skipInt
takeInt
whereUserFilterPayloadFilterInput

Mutation

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

FieldArgumentTypeDescription
createCompanyCreateCompanyPayload!

Mutation to create a new company in the system.

inputCreateCompanyInput!
deleteCompanyDeleteCompanyPayload!

Mutation to delete an existing company from the system.

inputDeleteCompanyInput!
updateCompanyUpdateCompanyPayload!

Mutation to update the details of an existing company.

idID!
inputUpdateCompanyInput!
updateCompanyOptionsUpdateCompanyOptionsPayload!

Mutation to update company-related options.

idID!
inputUpdateCompanyOptionsInput!
createCompanyStatusCreateCompanyStatusPayload!

Mutation to create a new company status (e.g., Active, Inactive).

inputCreateCompanyStatusInput!
deleteCompanyStatusDeleteCompanyStatusPayload!

Mutation to delete an existing company status.

inputDeleteCompanyStatusInput!
updateCompanyStatusUpdateCompanyStatusPayload!

Mutation to update an existing company status.

idID!
inputUpdateCompanyStatusInput!
createCompanyTypeCreateCompanyTypePayload!

Mutation to create a new company type in the system.

inputCreateCompanyTypeInput!
deleteCompanyTypeDeleteCompanyTypePayload!

Mutation to delete an existing company type from the system.

inputDeleteCompanyTypeInput!
updateCompanyTypeUpdateCompanyTypePayload!

Mutation to update an existing company type.

idID!
inputUpdateCompanyTypeInput!
connectEntitiesToEntityBatchConnectEntitiesToEntityBatchPayload!

Mutation to connect multiple entities to an entity batch.

idID!
inputConnectEntitiesToEntityBatchInput!
connectEntityBatchesToEntityConnectEntityBatchesToEntityPayload!

Mutation to connect multiple entity batches to an entity.

idID!
inputConnectEntityBatchesToEntityInput!
createEntityBatchCreateEntityBatchPayload!

Mutation to create a new entity batch in the system.

inputCreateEntityBatchInput!
deleteEntityBatchDeleteEntityBatchPayload!

Mutation to delete an existing entity batch.

inputDeleteEntityBatchInput!
disconnectEntitiesFromEntityBatchDisconnectEntitiesFromEntityBatchPayload!

Mutation to disconnect multiple entities from an entity batch.

idID!
inputDisconnectEntitiesFromEntityBatchInput!
disconnectEntityBatchesFromEntityDisconnectEntityBatchesFromEntityPayload!

Mutation to disconnect multiple entity batches from an entity.

idID!
inputDisconnectEntityBatchesFromEntityInput!
updateEntityBatchUpdateEntityBatchPayload!

Mutation to update an existing entity batch.

idID!
inputUpdateEntityBatchInput!
createEntityIdentificationCreateEntityIdentificationPayload!

Mutation used to create a new entity identification record.

inputCreateEntityIdentificationInput!
deleteEntityIdentificationDeleteEntityIdentificationPayload!

Mutation used to delete an existing entity identification record.

inputDeleteEntityIdentificationInput!
updateEntityIdentificationUpdateEntityIdentificationPayload!

Mutation used to update the value of an existing entity identification record.

idID!
inputUpdateEntityIdentificationInput!
connectEntitiesToEntitySecurityGroupConnectEntitiesToEntitySecurityGroupPayload!

Mutation to connect multiple entities to an entity security group.

idID!
inputConnectEntitiesToEntitySecurityGroupInput!
connectEntitySecurityGroupsToEntityConnectEntitySecurityGroupsToEntityPayload!

Mutation to connect multiple entity security groups to an entity.

idID!
inputConnectEntitySecurityGroupsToEntityInput!
createEntitySecurityGroupCreateEntitySecurityGroupPayload!

Mutation to create a new entity security group.

inputCreateEntitySecurityGroupInput!
deleteEntitySecurityGroupDeleteEntitySecurityGroupPayload!

Mutation to delete an existing entity security group.

inputDeleteEntitySecurityGroupInput!
disconnectEntitiesFromEntitySecurityGroupDisconnectEntitiesFromEntitySecurityGroupPayload!

Mutation to disconnect multiple entities from an entity security group.

idID!
inputDisconnectEntitiesFromEntitySecurityGroupInput!
disconnectEntitySecurityGroupsFromEntityDisconnectEntitySecurityGroupsFromEntityPayload!

Mutation to disconnect multiple entity security groups from an entity.

idID!
inputDisconnectEntitySecurityGroupsFromEntityInput!
updateEntitySecurityGroupUpdateEntitySecurityGroupPayload!

Mutation to update an existing entity security group.

idID!
inputUpdateEntitySecurityGroupInput!
connectEntitiesToEntitySetConnectEntitiesToEntitySetPayload!

Mutation to connect multiple entities to an entity set.

idID!
inputConnectEntitiesToEntitySetInput!
connectEntitySetsToEntityConnectEntitySetsToEntityPayload!

Mutation to connect multiple entity sets to an entity.

idID!
inputConnectEntitySetsToEntityInput!
createEntitySetCreateEntitySetPayload!

Mutation to create a new entity set in the system.

inputCreateEntitySetInput!
deleteEntitySetDeleteEntitySetPayload!

Mutation to delete an existing entity set.

inputDeleteEntitySetInput!
disconnectEntitiesFromEntitySetDisconnectEntitiesFromEntitySetPayload!

Mutation to disconnect multiple entities from an entity set.

idID!
inputDisconnectEntitiesFromEntitySetInput!
disconnectEntitySetsFromEntityDisconnectEntitySetsFromEntityPayload!

Mutation to disconnect multiple entity sets from an entity.

idID!
inputDisconnectEntitySetsFromEntityInput!
updateEntitySetUpdateEntitySetPayload!

Mutation to update an existing entity set.

idID!
inputUpdateEntitySetInput!
createEntityTypeCreateEntityTypePayload!

Mutation to create a new entity type in the system.

inputCreateEntityTypeInput!
deleteEntityTypeDeleteEntityTypePayload!

Mutation to delete an existing entity type.

inputDeleteEntityTypeInput!
updateEntityTypeUpdateEntityTypePayload!

Mutation to update an existing entity type.

idID!
inputUpdateEntityTypeInput!
createIndividualCreateIndividualPayload!

Mutation to create a new individual entity in the system.

inputCreateIndividualInput!
deleteIndividualDeleteIndividualPayload!

Mutation to delete an existing individual.

inputDeleteIndividualInput!
updateIndividualUpdateIndividualPayload!

Mutation to update an existing individual.

idID!
inputUpdateIndividualInput!
createNationalityCreateNationalityPayload!

Mutation to create a new nationality in the system.

inputCreateNationalityInput!
deleteNationalityDeleteNationalityPayload!

Mutation to delete an existing nationality.

inputDeleteNationalityInput!
updateNationalityUpdateNationalityPayload!

Mutation to update an existing nationality.

idID!
inputUpdateNationalityInput!
createOtherEntityCreateOtherEntityPayload!

Mutation to create a new entity other than a company (e.g., an individual).

inputCreateOtherEntityInput!
deleteOtherEntityDeleteOtherEntityPayload!

Mutation to delete an existing entity other than a company.

inputDeleteOtherEntityInput!
updateOtherEntityUpdateOtherEntityPayload!

Mutation to update the details of an existing entity other than a company.

inputUpdateOtherEntityInput!
idID!
createPartnerCreatePartnerPayload!

Mutation to create a new partner entity in the system.

inputCreatePartnerInput!
deletePartnerDeletePartnerPayload!

Mutation to delete an existing partner.

inputDeletePartnerInput!
updatePartnerUpdatePartnerPayload!

Mutation to update an existing partner.

idID!
inputUpdatePartnerInput!
updatePersonOptionsUpdatePersonOptionsPayload!

Mutation to update person-related options.

idID!
inputUpdatePersonOptionsInput!
createSubCountryCreateSubCountryPayload!

Mutation to create a new sub-country (e.g., state or province) in the system.

inputCreateSubCountryInput!
deleteSubCountryDeleteSubCountryPayload!

Mutation to delete an existing sub-country.

inputDeleteSubCountryInput!
updateSubCountryUpdateSubCountryPayload!

Mutation to update an existing sub-country.

idID!
inputUpdateSubCountryInput!
createUserGroupingCreateUserGroupingPayload!

Mutation to create a new user grouping.

inputCreateUserGroupingInput!
deleteUserGroupingDeleteUserGroupingPayload!

Mutation to delete an existing user grouping.

inputDeleteUserGroupingInput!
updateUserGroupingUpdateUserGroupingPayload!

Mutation to update an existing user grouping.

idID!
inputUpdateUserGroupingInput!

Objects

Address

Represents a specific address.

FieldArgumentTypeDescription
countryCountry

Country associated with the address.

subCountrySubCountry

Sub-country associated with the address.

idID!

The unique identifier for the address.

createdAtDateTime

Represents the timestamp indicating when the address record was created.

referenceString

Reference identifier for the address.

street1String

First line of the address.

street2String

Second line of the address.

street3String

Third line of the address.

postTownString

Post town of the address.

areaString

Represents the geographic area associated with the address.

postalCodeString

Postal code of the address.

compositeString

Composite key or identifier for the address.

formattedString

Formatted version of the address.

latitudeString

Latitude coordinate of the address.

longitudeString

Longitude coordinate of the address.

isSharedBoolean!

Indicates if the address is shared among multiple entities.

AddressEntry

Represents list of addresses.

FieldArgumentTypeDescription
addressAddress

Represents the actual address.

addressTypeAddressType

Represents the type of an address.

AddressType

Represents a type of address.

FieldArgumentTypeDescription
entityTypeEntityType

Represents the entity type associated with the address type.

idID!

Represents the unique identifier for the address type.

priorityInt!

Represents the priority level of the address type.

referenceString!

Represents the reference code for the address type.

nameString!

Represents the name of the address type.

systemPredefinedBoolean

Boolean flag indicating if the address type is predefined in the system.

isHeadingBoolean

Boolean flag indicating if the address type is a heading.

isRequiredBoolean

Boolean flag indicating if the address type is required.

headingString

Represents the heading associated with the address type.

noRecordHeldString

Boolean flag indicating if no record is held for the address type.

AddressTypesCollectionSegment

Represents a collection segment for address types.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Contains pagination information for the address types collection.

items[AddressType!]

Contains the list of address types within the segment.

totalCountInt!

Represents the total count of address types in the segment.

AddressesCollectionSegment

Represents a collection segment of addresses.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for addresses.

items[Address!]

Contains the items of the addresses collection segment.

totalCountInt!

Indicates the total count of addresses in the segment.

Appointment

Represents a specific appointment.

FieldArgumentTypeDescription
appointmentGroupAppointmentGroup

The group associated with the appointment.

appointmentStatusAppointmentStatus

The status of the appointment.

appointmentTypeAppointmentType

The quick reference for the appointment type.

occupationOccupation

Specifies the occupation associated with the appointment.

auditUserUser

The audit user for the appointment.

eventTypeEventType

The event type associated with the appointment.

otherEventAppointment

Represents a related or follow-up event linked to the current appointment.

appointedToEntity

The quick reference for the entity appointed to.

appointeeEntity

The quick reference for the appointee.

alternateAppointeeEntity

The quick reference for the alternate appointee.

idID!

The unique identifier for the appointment.

auditDateDateTime

The audit date for the appointment.

eventIdInt!

The event identifier associated with the appointment.

eventDateDateTime

The event date associated with the appointment.

otherEventDateDateTime

The date for another event related to the appointment.

levelInt

The level of the appointment.

isNotAttendeeBoolean!

Boolean flag indicating whether the individual is not an attendee of the appointment.

reminderDateTime

The reminder settings for the appointment.

isActiveBoolean!

Represents if an appointment is active or not.

isOnStatutoryRegistersBoolean

Boolean indicating whether the appointment appears on statutory registers.

notesString

Any additional notes or annotations related to the appointment.

AppointmentCategoriesCollectionSegment

Represents a collection segment for appointment categories.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Contains pagination information for the appointment categories collection.

items[AppointmentCategory!]

Contains the list of appointment categories within the segment.

totalCountInt!

Represents the total count of appointment categories in the segment.

AppointmentCategory

Represents a category associated with an appointment.

FieldArgumentTypeDescription
entityTypeEntityType

Defines the entity type associated with the appointment category.

idID!

The unique identifier for the appointment category.

referenceString!

The reference identifier for the appointment category.

priorityInt

The priority level of the appointment category.

nameString

The name of the appointment category.

AppointmentGroup

Represents a group of appointments with common attributes.

FieldArgumentTypeDescription
idID!

Filters appointment groups by their unique identifier.

priorityInt

Filters appointment groups by their assigned priority.

referenceString!

Filters appointment groups by their reference identifier.

nameString

Filters appointment groups by their name.

AppointmentGroupsCollectionSegment

Represents a collection segment of appointment groups.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for appointment groups.

items[AppointmentGroup!]

Contains the items of the appointment groups collection segment.

totalCountInt!

Indicates the total count of appointment groups in the segment.

AppointmentStatus

Represents the status of an appointment within the system.

FieldArgumentTypeDescription
entityTypeEntityType

Indicates the type of entity associated with the appointment status.

idID!

The unique identifier for an appointment status.

priorityInt

Defines the priority of the appointment status.

referenceString!

The reference identifier for the appointment status.

nameString

The name associated with the appointment status.

AppointmentStatusesCollectionSegment

Represents a collection segment of appointment statuses.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for appointment statuses.

items[AppointmentStatus!]

Contains the items of the appointment statuses collection segment.

totalCountInt!

Indicates the total count of appointment statuses in the segment.

AppointmentType

Represents the type of an appointment within the system.

FieldArgumentTypeDescription
appointmentCategoryAppointmentCategory

Represents the appointment category associated with an appointment type.

entityTypeEntityType

Defines the entity type associated with the appointment type.

idID!

The unique identifier for an appointment type.

priorityInt

Defines the priority of the appointment type.

referenceString!

The reference identifier for the appointment type.

nameString

The name associated with the appointment type.

isChairmanBoolean

Indicates if the appointment type is for a chairman role.

isDirectorBoolean

Indicates if the appointment type is for a director role.

isSecretaryBoolean

Indicates if the appointment type is for a secretary role.

isManagerBoolean

Indicates if the appointment type is for a manager role.

isNonStatutoryBoolean

Indicates if the appointment type is non-statutory.

isAlternateBoolean

Indicates if the appointment type is an alternate role.

isSignatoryOnlyBoolean

Indicates if the appointment type is signatory-only.

updateExternalAppointmentsBoolean

Determines if external appointments are updated for this type.

updateInterestsInSharesBoolean

Determines if share interests are updated for this type.

isOccupationTitleEnabledBoolean

Indicates if occupation titles are enabled for this type.

isNotInCountryCodesBoolean

Excludes appointment types for specific country codes.

countryCodes[String!]!

Specifies the country codes associated with the appointment type.

isNotInCompanyTypesBoolean

Excludes appointment types for specific company types.

companyTypes[String!]!

Specifies the company types associated with the appointment type.

electronicFilingUKDesignationInt

Designation used for UK electronic filing.

isHiddenBoolean

Indicates if the appointment type is hidden.

AppointmentTypesCollectionSegment

Represents a collection segment of appointment types.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for appointment types.

items[AppointmentType!]

Contains the items of the appointment types collection segment.

totalCountInt!

Indicates the total count of appointment types in the segment.

AppointmentsCollectionSegment

Represents a collection segment of appointments.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for appointments.

items[Appointment!]

Contains the items of the appointments collection segment.

totalCountInt!

Indicates the total count of appointments in the segment.

CollectionSegmentInfo

Represents segment information for collections.

FieldArgumentTypeDescription
hasNextPageBoolean!

Indicates if the collection segment has a next page.

hasPreviousPageBoolean!

Indicates if the collection segment has a previous page.

CompaniesCollectionSegment

Represents a collection segment of companies.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for companies.

items[Company]

Contains the items of the companies collection segment.

totalCountInt!

Indicates the total count of companies in the segment.

Company

Represents a company entity in the system.

FieldArgumentTypeDescription
companyOptionsCompanyOptions

Configuration and operational options for the company.

companyStatusCompanyStatus

The current status of the company (e.g., Active, Dissolved).

companyTypeCompanyType

The type or classification of the company.

currencyCurrency

The currency associated with the company.

industrialClassification1IndustrialClassification

The first industrial classification code for the company.

industrialClassification2IndustrialClassification

The second industrial classification code for the company.

industrialClassification3IndustrialClassification

The third industrial classification code for the company.

industrialClassification4IndustrialClassification

The fourth industrial classification code for the company.

partnerPartner

The partner associated with the company.

managedByUser

The user or entity that manages the company.

addresses[AddressEntry!]

The list of address containing address type and actual address.

countryCountry

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.

entityTypeEntityType

The type or classification of the company as an entity.

personOptionsPersonOptions

Person-related options for the company.

subCountrySubCountry

The sub-country (e.g., state or province) where the company is located.

isHistoricalRecordBoolean

Indicates if the company record is historical.

companyNumberString

The official registration number of the company.

incorporationDateLocalDate

The date when the company was incorporated.

dissolvedDateLocalDate

The date when the company was dissolved.

lastAccountingPeriodEndDateLocalDate

The end date of the company's last accounting period.

currentAccountingPeriodEndDateLocalDate

The end date of the company's current accounting period.

lastAccountingPeriodExtendedDateLocalDate

The extended end date of the last accounting period, if applicable.

industrialClassificationOtherString

Any additional industrial classifications applicable to the company.

lastAccountsDateLocalDate

The date of the last filed accounts.

accountsSignedDateLocalDate

The date when the accounts were signed.

accountsFiledDateLocalDate

The date when the accounts were filed.

isAccountsFiledOverriddenBoolean

Indicates if the accounts filing status was overridden.

accountsInReviewDateLocalDate

The date when the accounts were under review.

nextAccountsDateLocalDate

The date of the next scheduled accounts filing.

accountsOverdueDateLocalDate

The date when the accounts became overdue.

isAccountsOverdueOverriddenBoolean

Indicates if the accounts overdue status was overridden.

hasAccountsOverseasExtensionBoolean

Indicates if the company has an overseas extension for filing accounts.

lastMembersScheduleDateLocalDate

The date when the last members' schedule was filed.

lastAnnualReturnDateLocalDate

The date when the last annual return was filed.

annualReturnSignedDateLocalDate

The date when the annual return was signed.

annualReturnFiledDateLocalDate

The date when the annual return was filed.

nextAnnualReturnDateLocalDate

The date of the next scheduled annual return.

isNextAnnualReturnDateAutomaticBoolean

Indicates if the next annual return date is set automatically.

annualReturnOverdueDateLocalDate

The date when the annual return became overdue.

isMembersScheduleAsRequiredBoolean

Indicates if the members' schedule is filed as required by law.

isMembersScheduleNotOnPaperBoolean

Indicates if the members' schedule is filed electronically and not on paper.

lastAnnualMeetingDateLocalDate

The date when the last annual general meeting was held.

annualMeetingMinutesSignedDateLocalDate

The date when the minutes of the annual meeting were signed.

nextAnnualMeetingDateLocalDate

The date of the next scheduled annual general meeting.

isNextAnnualMeetingDateAutomaticBoolean

Indicates if the next annual meeting date is set automatically.

annualMeetingOverdueDateLocalDate

The date when the annual meeting became overdue.

lastMeetingApproveAccountsDateLocalDate

The date of the last meeting to approve the accounts.

meetingApproveAccountsMinutesSignedDateLocalDate

The date when the minutes of the meeting to approve accounts were signed.

financialPeriodFromDateLocalDate

The start date of the company's financial period.

financialPeriodToDateLocalDate

The end date of the company's financial period.

isFinancialPeriodAutomaticBoolean

Indicates if the financial period is set automatically.

becameSingleMemberCompanyOnDateLocalDate

The date when the company became a single-member company.

registeredEmailAddressString

The registered email address of the company.

documentReferenceString

A reference to documents associated with the company.

isLiveBoolean

Indicates if the company is currently active or live.

idID!

The unique identifier for the company.

updatedAtDateTime

Indicates the last update timestamp for a company.

referenceTypeEntityTypeCategory!

A quick reference type associated with the company.

entityReferenceString

A reference code or identifier for the company entity.

entityNameString

The name of the company entity.

CompanyOptions

Configuration options for a company in the system.

FieldArgumentTypeDescription
systemDefaultRegisterSettingsBoolean!

Default register settings applied by the system.

separateRegistersForDirectorsSecretariesBoolean!

Indicates if there are separate registers for directors and secretaries.

registersListByNameBoolean!

Lists registers by name.

provideSpaceOnRegisterForManualEntriesBoolean!

Provides space for manual entries on registers.

lastUpdateAuditIdInt

ID of the last update audit.

lastUpdatedDateLocalDate

The date when the company options were last updated.

globalDocumentReferenceFormatBoolean!

Represents the global format used to construct document references across the company.

defaultDocumentReferenceFormatBoolean!

Represents the default document reference format used if no global format is defined.

documentFormatSeparatorDocumentReferenceSeparator

Defines the character or symbol used to separate document reference segments.

documentFormatSegment1DocumentReferenceSegment

Represents the first configurable segment of the document reference format.

documentFormatSegment2DocumentReferenceSegment

Represents the second configurable segment of the document reference format.

documentFormatSegment3DocumentReferenceSegment

Represents the third configurable segment of the document reference format.

CompanyStatus

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

FieldArgumentTypeDescription
entityTypeEntityType

The entity type associated with the company status.

idID!

The unique identifier of the company status.

priorityInt!

The priority assigned to the company status.

referenceString!

A reference field for categorizing or linking the company status.

nameString

The name of the company status.

CompanyStatusesCollectionSegment

Represents a collection segment of company statuses.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for company statuses.

items[CompanyStatus!]

Contains the items of the company statuses collection segment.

totalCountInt!

Indicates the total count of company statuses in the segment.

CompanyType

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

FieldArgumentTypeDescription
entityTypeEntityType

The type of entity associated with the company type.

idID!

The unique identifier of the company type.

priorityInt!

The priority level assigned to the company type.

referenceString!

A reference field used for internal linking or categorization.

nameString!

The name of the company type.

isNotInCountriesBoolean

Indicates whether this company type is excluded from certain country codes.

countryIds[ID!]

The list of country codes where this company type is applicable.

isHiddenBoolean

A flag indicating whether this company type is hidden from users.

CompanyTypesCollectionSegment

Represents a collection segment of company types.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for company types.

items[CompanyType!]

Contains the items of the company types collection segment.

totalCountInt!

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.

FieldArgumentTypeDescription
entityBatchEntityBatch

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.

FieldArgumentTypeDescription
entitySecurityGroupEntitySecurityGroup

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.

FieldArgumentTypeDescription
entitySetEntitySet

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.

FieldArgumentTypeDescription
entityEntity

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.

FieldArgumentTypeDescription
entityEntity

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.

FieldArgumentTypeDescription
entityEntity

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.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for countries.

items[Country!]

Contains the items of the countries collection segment.

totalCountInt!

Indicates the total count of countries in the segment.

Country

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

FieldArgumentTypeDescription
currencyCurrency

Specifies the currency associated with a country.

idID!

The unique identifier of the country.

countryCodeString

The two-letter ISO code for the country.

nameString

The full name of the country.

countryCode3String

The three-letter ISO code for the country.

documentCountryString

Indicates whether this country is considered a document country.

iso3166DescriptionString

A description of the country's ISO 3166 status.

isEEABoolean!

Indicates whether the country is part of the European Economic Area.

isUSABoolean!

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.

FieldArgumentTypeDescription
companyCompany

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.

FieldArgumentTypeDescription
companyStatusCompanyStatus

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.

FieldArgumentTypeDescription
companyTypeCompanyType

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.

FieldArgumentTypeDescription
entityBatchEntityBatch

The entity batch object that was created.

errors[CreateEntityBatchError!]

Any errors encountered during the creation of the entity batch.

CreateEntityIdentificationPayload

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

FieldArgumentTypeDescription
entityIdentificationEntityIdentification

Contains the newly created entity identification details.

errors[CreateEntityIdentificationError!]

Any errors returned while creating the entity identification.

CreateEntitySecurityGroupPayload

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

FieldArgumentTypeDescription
entitySecurityGroupEntitySecurityGroup

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.

FieldArgumentTypeDescription
entitySetEntitySet

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.

FieldArgumentTypeDescription
entityTypeEntityType

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.

FieldArgumentTypeDescription
individualIndividual

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.

FieldArgumentTypeDescription
nationalityNationality

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.

FieldArgumentTypeDescription
otherEntityOtherEntity

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.

FieldArgumentTypeDescription
partnerPartner

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.

FieldArgumentTypeDescription
subCountrySubCountry

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.

FieldArgumentTypeDescription
userGroupingUserGrouping

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.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for currencies.

items[Currency!]

Contains the items of the currencies collection segment.

totalCountInt!

Indicates the total count of currencies in the segment.

Currency

Represents a currency used by a country or entity.

FieldArgumentTypeDescription
countryCountry

Defines the country associated with a currency.

idID!

The unique identifier for the currency.

referenceString!

A reference code or value for the currency.

currencyCodeString

The official three-letter currency code (e.g., USD, EUR).

nameString

The full name of the currency (e.g., US Dollar).

prefixString

The symbol or prefix used for the currency (e.g., $).

suffixString

A suffix used for the currency, if applicable.

thousandSeparatorString

The symbol used to separate thousands in currency formatting.

decimalSeparatorString

The symbol used to separate decimals in currency formatting.

numberOfDecimalPointsInt!

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.

FieldArgumentTypeDescription
companyCompany

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.

FieldArgumentTypeDescription
companyStatusCompanyStatus

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.

FieldArgumentTypeDescription
companyTypeCompanyType

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.

FieldArgumentTypeDescription
entityBatchEntityBatch

The entity batch object that was deleted.

errors[DeleteEntityBatchError!]

Any errors encountered during the deletion of the entity batch.

DeleteEntityIdentificationPayload

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

FieldArgumentTypeDescription
entityIdentificationEntityIdentification

Contains the deleted identification data, if successful.

errors[DeleteEntityIdentificationError!]

Any errors encountered during the delete operation.

DeleteEntitySecurityGroupPayload

The type name of the security group creation payload.

FieldArgumentTypeDescription
entitySecurityGroupEntitySecurityGroup

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.

FieldArgumentTypeDescription
entitySetEntitySet

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.

FieldArgumentTypeDescription
entityTypeEntityType

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.

FieldArgumentTypeDescription
individualIndividual

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.

FieldArgumentTypeDescription
nationalityNationality

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.

FieldArgumentTypeDescription
otherEntityOtherEntity

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.

FieldArgumentTypeDescription
partnerPartner

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.

FieldArgumentTypeDescription
subCountrySubCountry

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.

FieldArgumentTypeDescription
userGroupingUserGrouping

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.

FieldArgumentTypeDescription
entityBatchEntityBatch

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.

FieldArgumentTypeDescription
entitySecurityGroupEntitySecurityGroup

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.

FieldArgumentTypeDescription
entitySetEntitySet

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.

FieldArgumentTypeDescription
entityEntity

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.

FieldArgumentTypeDescription
entityEntity

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.

FieldArgumentTypeDescription
entityEntity

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.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for entities.

items[Entity]

Contains the items of the entities collection segment.

totalCountInt!

Indicates the total count of entities in the segment.

EntityBatch

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

FieldArgumentTypeDescription
entitiesEntitiesCollectionSegment

The entities included in this batch.

skipInt
takeInt
batchUserUser

The user associated with the batch.

idID!

The unique identifier for the entity batch.

priorityInt!

The priority level assigned to the entity batch.

referenceString!

A reference code or value for the entity batch.

nameString!

The name of the entity batch.

EntityBatchesCollectionSegment

Represents a collection segment of entity batches.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for entity batches.

items[EntityBatch!]

Contains the items of the entity batches collection segment.

totalCountInt!

Indicates the total count of entity batches in the segment.

EntityIdentification

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

FieldArgumentTypeDescription
idID!

Unique identifier of the entity identification record.

entityIdentificationTypeEntityIdentificationType!

The type/category of identification assigned to the entity.

identificationString!

The actual identification value assigned (e.g., the registration number).

EntitySecurityGroup

Represents a security group that controls access to entities.

FieldArgumentTypeDescription
entitiesEntitiesCollectionSegment

The entities governed by this security group.

skipInt
takeInt
userRoleUserRole

The role of the user within the security group.

idID!

The unique identifier for the security group.

priorityInt!

The priority level assigned to the security group.

referenceString!

A reference code or value for the security group.

nameString

The name of the security group.

liveReferenceString

A live reference for tracking the security group.

systemPredefinedBoolean

Indicates whether the security group is predefined by the system.

entitySecurityGroupAutoString

Automatic settings for the security group.

entitySecurityGroupRollUpEntitySecurityGroupRollUp

Specifies the roll-up configuration for an entity security group.

entitySecurityGroupAppliesString

Applies specific rules to the security group.

EntitySecurityGroupsCollectionSegment

Represents a collection segment of entity security groups.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for entity security groups.

items[EntitySecurityGroup!]

Contains the items of the entity security groups collection segment.

totalCountInt!

Indicates the total count of entity security groups in the segment.

EntitySet

Represents a set of entities grouped together for organizational purposes.

FieldArgumentTypeDescription
entitiesEntitiesCollectionSegment

The entities included in the set.

skipInt
takeInt
idID!

The unique identifier for the entity set.

priorityInt!

The priority level assigned to the entity set.

referenceString!

A reference code or value for the entity set.

nameString

The name of the entity set.

appliesTo[EntityTypeCategory!]!

The types of entities included in the set.

EntitySetsCollectionSegment

Represents a collection segment of entity sets.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for entity sets.

items[EntitySet!]

Contains the items of the entity sets collection segment.

totalCountInt!

Indicates the total count of entity sets in the segment.

EntityType

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

FieldArgumentTypeDescription
idID!

The unique identifier for the entity type.

priorityInt!

The priority level assigned to the entity type.

referenceString!

A reference code or identifier for the entity type.

nameString

The name of the entity type.

systemDefinedBoolean!

Indicates whether the entity type is system-defined (as opposed to user-defined).

EntityTypesCollectionSegment

Represents a collection segment of entity types.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for entity types.

items[EntityType!]

Contains the items of the entity types collection segment.

totalCountInt!

Indicates the total count of entity types in the segment.

ErrorOfCompanyOptionsPayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the company options error payload.

typeString

The type of error encountered in the company options payload.

titleString

The title or brief summary of the error encountered in the company options payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the company options payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfCompanyPayload

Represents an error payload specific to company-related operations.

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the company error payload.

typeString

The type of error encountered in the company payload.

titleString

The title or brief summary of the error encountered in the company payload.

statusInt

The status code or state associated with the error (e.g., 404, 500).

detailString

A detailed description of the error encountered in the company payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfCompanyStatusPayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the company status error payload.

typeString

The type of error encountered in the company status payload.

titleString

The title or brief summary of the error encountered in the company status payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the company status payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfCompanyTypePayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the company type error payload.

typeString

The type of error encountered in the company type payload.

titleString

The title or brief summary of the error encountered in the company type payload.

statusInt

The status code or state associated with the company type error.

detailString

A detailed description of the error encountered in the company type payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfEntityBatchPayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the entity batch error payload.

typeString

The type of error encountered in the entity batch payload.

titleString

The title or brief summary of the error encountered in the entity batch payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the entity batch payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfEntityIdentificationPayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional metadata or details related to the error.

typeString

A URI reference that identifies the type of error encountered.

titleString

short, human-readable summary of the error.

statusInt

The HTTP status code generated by the server for this error.

detailString

A detailed, human-readable explanation specific to this occurrence of the error.

instanceString

A URI reference that identifies the specific occurrence of the error.

ErrorOfEntityPayload

Represents an error payload specific to entity-related operations.

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the entity error payload.

typeString

The type of error encountered in the entity payload.

titleString

The title or brief summary of the error encountered in the entity payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the entity payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfEntitySecurityGroupPayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the entity security group error payload.

typeString

The type of error encountered in the entity security group payload.

titleString

The title or brief summary of the error encountered in the entity security group payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the entity security group payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfEntitySetPayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the entity set error payload.

typeString

The type of error encountered in the entity set payload.

titleString

The title or brief summary of the error encountered in the entity set payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the entity set payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfEntityTypePayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the entity type error payload.

typeString

The type of error encountered in the entity type payload.

titleString

The title or brief summary of the error encountered in the entity type payload.

statusInt

The status code or state associated with the error (e.g., 404, 500).

detailString

A detailed description of the error encountered in the entity type payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfIndividualPayload

Represents an error payload specific to individual-related operations.

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the individual error payload.

typeString

The type of error encountered in the individual payload.

titleString

The title or brief summary of the error encountered in the individual payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the individual payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfNationalityPayload

Represents an error payload specific to nationality-related operations.

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the nationality error payload.

typeString

The type of error encountered in the nationality payload.

titleString

The title or brief summary of the error encountered in the nationality payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the nationality payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfOtherEntityPayload

Represents an error payload specific to other types of entities.

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the other entity error payload.

typeString

The type of error encountered in the other entity payload.

titleString

The title or brief summary of the error encountered in the other entity payload.

statusInt

The status code or state associated with the error encountered.

detailString

A detailed description of the error encountered in the other entity payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfPartnerPayload

Represents an error payload specific to partner-related operations.

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the partner error payload.

typeString

The type of error encountered in the partner payload.

titleString

The title or brief summary of the error encountered in the partner payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the partner payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfPersonOptionsPayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the person options error payload.

typeString

The type of error encountered in the person options payload.

titleString

The title or brief summary of the error encountered in the person options payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the person options payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfSubCountryPayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the sub-country error payload.

typeString

The type of error encountered in the sub-country payload.

titleString

The title or brief summary of the error encountered in the sub-country payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the sub-country payload.

instanceString

A reference to the specific instance where the error occurred.

ErrorOfUserGroupingPayload

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the user grouping error payload.

typeString

The type of error encountered in the user grouping payload.

titleString

The title or brief summary of the error encountered in the user grouping payload.

statusInt

The status code or state associated with the error.

detailString

A detailed description of the error encountered in the user grouping payload.

instanceString

A reference to the specific instance where the error occurred.

EventGroup

Represents a group or category that classifies event types.

FieldArgumentTypeDescription
idID!

The unique identifier of the event group.

referenceString!

A reference code for the event group.

nameString

The display name of the event group.

EventGroupsCollectionSegment

Represents a paginated collection of event groups.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Contains pagination details for the event groups.

items[EventGroup!]

List of event group entries on the current page.

totalCountInt!

Total number of event groups available.

EventType

Represents a defined event type in the system.

FieldArgumentTypeDescription
eventGroupEventGroup

The event group that the event type belongs to.

idID!

The unique identifier of the event type.

referenceString!

A reference code assigned to the event type.

nameString

The display name of the event type.

descriptionString!

A textual description of the event type.

EventTypesCollectionSegment

Represents a paginated collection of event types.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Contains pagination information (e.g., cursor, hasNextPage).

items[EventType!]

List of event type entries returned for the current page.

totalCountInt!

Total number of event type entries available.

Individual

Represents an individual person in the system.

FieldArgumentTypeDescription
nationalityNationality

The nationality of the individual.

countryCountry

The country of the individual.

partnerPartner

The partner associated with the individual.

subCountrySubCountry

The sub-country (e.g., state or province) of the individual.

managedByUser

The user or entity that manages the individual.

addresses[AddressEntry!]

The list of address containing address type and actual address.

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.

entityTypeEntityType

The type or classification of the individual as an entity.

personOptionsPersonOptions

Configuration options related to the individual.

forenamesString

The forenames (first and middle names) of the individual.

surnameString

The surname (last name) of the individual.

displayAsIndividualNameFormat!

How the individual is displayed in the system.

sortNameString

The name of the individual used for sorting purposes.

isHistoricalRecordBoolean

Indicates if the individual record is historical.

titleString

The title of the individual (e.g., Mr., Mrs., Dr.).

honoursString

Any honors or distinctions the individual holds.

salutationString

The formal greeting or salutation for the individual.

previousNameString

Any previous names the individual may have had.

occupationString

The occupation or profession of the individual.

dateOfBirthLocalDate

The date of birth of the individual.

dateOfDeathLocalDate

The date of death of the individual, if applicable.

nationalIdentificationNumberString

The national identification number for the individual.

firstForenameString

The first forename (given name) of the individual.

middleNamesString

The middle names of the individual.

initialsString

The initials of the individual.

previousForenamesString

Any previous forenames the individual may have had.

previousSurnameString

Any previous surnames the individual may have had.

previousFirstForenameString

Any previous first names the individual may have had.

passportNumberString

The passport number of the individual.

idID!

The unique identifier for the individual.

updatedAtDateTime

Indicates the last update timestamp for an individual.

referenceTypeEntityTypeCategory!

A quick reference type associated with the individual.

entityReferenceString

A reference code or identifier for the individual entity.

entityNameString

The name of the individual entity.

IndividualsCollectionSegment

Represents a collection segment of individuals.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for individuals.

items[Individual]

Contains the items of the individuals collection segment.

totalCountInt!

Indicates the total count of individuals in the segment.

IndustrialClassification

Represents a specific industrial classification for entities.

FieldArgumentTypeDescription
countryCountry

Defines the country associated with an industrial classification.

idID!

The unique identifier for the industrial classification.

referenceString!

A reference code or value for the classification.

nameString

The name of the industrial classification.

codeString

The specific code for the industrial classification.

IndustrialClassificationsCollectionSegment

Represents a collection segment of industrial classifications.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for industrial classifications.

items[IndustrialClassification!]

Contains the items of the industrial classifications collection segment.

totalCountInt!

Indicates the total count of industrial classifications in the segment.

KeyValuePairOfStringAndJsonElement

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

FieldArgumentTypeDescription
keyString!

The key part of the key-value pair, represented as a string.

valueJSON!

The value part of the key-value pair, represented as a JSON element.

KeyValuePairOfStringAndString__

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

FieldArgumentTypeDescription
keyString!

The key in the string key-value pair.

value[String!]!

The value in the string key-value pair.

MinimalEntityPayload

A lightweight representation of an entity with essential fields only.

FieldArgumentTypeDescription
countryCountry

The country associated with the entity.

entityBatches[EntityBatch!]!

The batches this entity is grouped under.

entitySecurityGroups[EntitySecurityGroup!]!

The security groups that govern access to the entity.

entitySets[EntitySet!]

The sets the entity is a member of.

entityTypeEntityType

The type/category of the entity (e.g., company, individual).

partnerPartner

The partner associated with the entity.

personOptionsPersonOptions

Configuration options specific to individual entities.

subCountrySubCountry

Sub-national jurisdiction (e.g., state, province) associated with the entity.

managedByUser

The user or group responsible for managing the entity.

idID!

Unique identifier of the entity.

updatedAtDateTime

Timestamp for when the entity was last updated.

referenceTypeEntityTypeCategory!

Defines the type of reference used for identifying the entity.

entityReferenceString

External or internal reference string identifying the entity.

entityNameString

The official or display name of the entity.

NationalitiesCollectionSegment

Represents a collection segment of nationalities.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for nationalities.

items[Nationality!]

Contains the items of the nationalities collection segment.

totalCountInt!

Indicates the total count of nationalities in the segment.

Nationality

Represents a nationality, including its associated metadata like codes.

FieldArgumentTypeDescription
countryCountry

Defines the country associated with a nationality.

subCountrySubCountry

Defines the sub-country associated with a nationality.

idID!

The unique identifier of the nationality.

priorityInt!

The priority assigned to the nationality.

nameString!

The name of the nationality.

Occupation

Represents a specific occupation.

FieldArgumentTypeDescription
idID!

The unique identifier for the occupation.

priorityInt!

Defines the priority of the occupation.

referenceString!

The reference identifier for the occupation.

OccupationsCollectionSegment

Represents a collection segment of occupations.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for occupations.

items[Occupation!]

Contains the items of the occupations collection segment.

totalCountInt!

Indicates the total count of occupations in the segment.

OtherEntitiesCollectionSegment

Represents a collection segment of other entities.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for other entities.

items[OtherEntity]

Contains the items of the other entities collection segment.

totalCountInt!

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

FieldArgumentTypeDescription
companyOptionsCompanyOptions

Company-specific options for the entity.

partnerPartner

The partner associated with the entity.

managedByUser

The entity or person responsible for managing the entity.

addresses[AddressEntry!]

The list of address containing address type and actual address.

countryCountry

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.

entityTypeEntityType

The type or classification of the entity.

personOptionsPersonOptions

Person-specific options for the entity.

subCountrySubCountry

The sub-country (e.g., state or province) associated with the entity.

isHistoricalRecordBoolean

Indicates whether the entity is part of historical records.

companyNumberString

The registration number of the entity if applicable.

incorporationDateLocalDate

The date the entity was incorporated or registered.

dissolvedDateLocalDate

The date the entity was dissolved, if applicable.

occupationString

The occupation of the entity if it represents an individual.

idID!

The unique identifier of the entity.

updatedAtDateTime

Indicates the last update timestamp for another entity.

referenceTypeEntityTypeCategory!

A quick reference type for categorizing the entity.

entityReferenceString

A reference field for linking the entity to related records.

entityNameString

The name of the entity.

Partner

Represents a partner entity within the system.

FieldArgumentTypeDescription
idID!

The unique identifier for the partner.

priorityInt!

The priority level assigned to the partner.

referenceString!

A reference code for the partner.

nameString

The name of the partner entity.

initialsString

The initials of the partner, if applicable.

PartnersCollectionSegment

Represents a collection segment of partners.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for partners.

items[Partner!]

Contains the items of the partners collection segment.

totalCountInt!

Indicates the total count of partners in the segment.

PersonOptions

Options specific to a person entity in the system.

FieldArgumentTypeDescription
hasShareCertificatesBoolean!

Indicates if the person has share certificates.

hasStockTransferFormsBoolean!

Indicates if the person has stock transfer forms.

hasRegisterAddendumsBoolean!

Indicates if the person has register addendums.

hasOtherDirectorshipsBoolean!

Indicates if the person has other directorships.

SubCountriesCollectionSegment

Represents a collection segment of sub-countries.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for sub-countries.

items[SubCountry!]

Contains the items of the sub-countries collection segment.

totalCountInt!

Indicates the total count of sub-countries in the segment.

SubCountry

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

FieldArgumentTypeDescription
countryCountry

Defines the country associated with a sub-country.

idID!

The unique identifier of the sub-country.

subCountryCodeString

The code for the sub-country (e.g., state code).

nameString

The name of the sub-country.

UpdateCompanyOptionsPayload

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

FieldArgumentTypeDescription
companyOptionsCompanyOptions

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.

FieldArgumentTypeDescription
companyCompany

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.

FieldArgumentTypeDescription
companyStatusCompanyStatus

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.

FieldArgumentTypeDescription
companyTypeCompanyType

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.

FieldArgumentTypeDescription
entityBatchEntityBatch

The entity batch that was updated.

errors[UpdateEntityBatchError!]

Any errors encountered during the update of the entity batch.

UpdateEntityIdentificationPayload

Payload returned after updating an entity identification.

FieldArgumentTypeDescription
entityIdentificationEntityIdentification

The updated identification information.

errors[UpdateEntityIdentificationError!]

Errors returned if the update fails.

UpdateEntitySecurityGroupPayload

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

FieldArgumentTypeDescription
entitySecurityGroupEntitySecurityGroup

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.

FieldArgumentTypeDescription
entitySetEntitySet

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.

FieldArgumentTypeDescription
entityTypeEntityType

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.

FieldArgumentTypeDescription
individualIndividual

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.

FieldArgumentTypeDescription
nationalityNationality

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.

FieldArgumentTypeDescription
otherEntityOtherEntity

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.

FieldArgumentTypeDescription
partnerPartner

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.

FieldArgumentTypeDescription
personOptionsPersonOptions

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.

FieldArgumentTypeDescription
subCountrySubCountry

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.

FieldArgumentTypeDescription
userGroupingUserGrouping

The updated user grouping object.

errors[UpdateUserGroupingError!]

Any errors encountered during the update of the user grouping.

User

Represents a user in the system.

FieldArgumentTypeDescription
idID!

The unique identifier for the user.

referenceString

A reference code or value for the user.

nameString

The full name of the user in the system.

initialsString

The initials of the user.

roleString

The role assigned to the user within the system.

UserGrouping

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

FieldArgumentTypeDescription
idID!

The unique identifier for the user grouping.

priorityInt!

Represents the priority level assigned to a user grouping.

referenceString!

A reference code or value for the user grouping.

descriptionString

A description of the user grouping.

UserGroupingsCollectionSegment

Represents a collection segment of user groupings.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for user groupings.

items[UserGrouping!]

Contains the items of the user groupings collection segment.

totalCountInt!

Indicates the total count of user groupings in the segment.

UserRole

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

FieldArgumentTypeDescription
idID!

Represents the unique identifier of the user role.

referenceString

Represents the reference string for the user role.

nameString

Represents the display name of the user role.

UserRolesCollectionSegment

Represents a paginated collection of user roles.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Contains pagination details such as page size and cursor information for the user roles collection.

items[UserRole!]

The list of user role items in the current page of the collection.

totalCountInt!

The total number of user roles in the entire collection.

UsersCollectionSegment

Represents a collection segment of users.

FieldArgumentTypeDescription
pageInfoCollectionSegmentInfo!

Provides pagination information for users.

items[User!]

Contains the items of the users collection segment.

totalCountInt!

Indicates the total count of users in the segment.

ValidationError

Represents a validation error encountered during input or processing.

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!

Additional context or metadata related to the validation error.

validationErrors[KeyValuePairOfStringAndString__!]!

A list or collection of validation errors encountered.

typeString

The type of validation error encountered.

titleString

The title or brief summary of the validation error.

statusInt

The status code or state associated with the validation error.

detailString

A detailed description of the validation error encountered.

instanceString

A reference to the specific instance where the validation error occurred.

Inputs

AddressFilterPayloadFilterInput

Filters address-related data based on multiple criteria.

FieldTypeDescription
and[AddressFilterPayloadFilterInput!]
or[AddressFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering address data.

referenceQueryCommonStringOperationFilterInput

Filters addresses by their reference identifier.

postalCodeQueryCommonStringOperationFilterInput

Filters addresses by postal code.

compositeQueryCommonStringOperationFilterInput

Filters addresses using composite keys or identifiers.

isSharedQueryCommonBooleanOperationFilterInput

Filters addresses based on whether they are shared.

areaQueryCommonStringOperationFilterInput

Represents the area or region associated with a filtered address.

countryCountryBaseFilterPayloadFilterInput

Filters addresses based on the associated country.

subCountrySubCountryBaseFilterPayloadFilterInput

Filters addresses based on sub-country.

AddressTypeFilterPayloadFilterInput

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

FieldTypeDescription
and[AddressTypeFilterPayloadFilterInput!]
or[AddressTypeFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering address type data.

referenceQueryCommonStringOperationFilterInput

Filters address types by a unique reference identifier.

nameQueryCommonStringOperationFilterInput

Filters address types by their name.

entityTypeEntityTypeBaseFilterPayloadFilterInput

Filters address types based on the type of entity they are associated with (e.g., individual or company).

AppointmentCategoryBaseFilterPayloadFilterInput

Represents filtering input for appointment category base entities.

FieldTypeDescription
and[AppointmentCategoryBaseFilterPayloadFilterInput!]
or[AppointmentCategoryBaseFilterPayloadFilterInput!]
referenceQueryCommonStringOperationFilterInput

Represents the reference associated with a filtered appointment category base entity.

nameQueryCommonStringOperationFilterInput

Represents the name associated with a filtered appointment category base entity.

AppointmentCategoryFilterPayloadFilterInput

Represents filtering options for appointment categories.

FieldTypeDescription
and[AppointmentCategoryFilterPayloadFilterInput!]
or[AppointmentCategoryFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering appointment category data.

referenceQueryCommonStringOperationFilterInput

Represents the reference associated with a filtered appointment category.

nameQueryCommonStringOperationFilterInput

Represents the name associated with a filtered appointment category.

entityTypeEntityTypeBaseFilterPayloadFilterInput

Represents the entity type associated with a filtered appointment category.

AppointmentFilterPayloadFilterInput

A filter used to narrow down appointments based on specific criteria such as appointee reference, event type, or if they are active.

FieldTypeDescription
and[AppointmentFilterPayloadFilterInput!]
or[AppointmentFilterPayloadFilterInput!]
appointmentTypeQueryCommonStringOperationFilterInput

Filters appointments based on their types.

eventTypeQueryCommonStringOperationFilterInput

Filters appointments based on their event types.

isActiveQueryCommonBooleanOperationFilterInput

Filters appointments if they are active or not.

isOnStatutoryRegistersQueryCommonBooleanOperationFilterInput

Filters appointments based on whether they appear on statutory registers.

notesQueryCommonStringOperationFilterInput

Filters based on notes associated with the appointment.

auditDateQueryCommonDateOperationFilterInput

Filters based on the audit date of the appointment.

eventDateQueryCommonDateOperationFilterInput

Filters based on the event date of the appointment.

reminderQueryCommonDateOperationFilterInput

Filters based on whether the appointment has reminders set.

appointeeConnectedEntityFilterPayloadFilterInput

Filters appointments based on their appointees.

appointedToConnectedEntityFilterPayloadFilterInput

Filters appointments by the entities they are appointed to.

alternateAppointeeConnectedEntityFilterPayloadFilterInput

Filters appointments based on their alternate appointees.

AppointmentGroupFilterPayloadFilterInput

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

FieldTypeDescription
and[AppointmentGroupFilterPayloadFilterInput!]
or[AppointmentGroupFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering appointment group data.

referenceQueryCommonStringOperationFilterInput

Filters appointment groups by a unique reference identifier.

nameQueryCommonStringOperationFilterInput

Filters appointment groups by their name.

AppointmentStatusFilterPayloadFilterInput

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

FieldTypeDescription
and[AppointmentStatusFilterPayloadFilterInput!]
or[AppointmentStatusFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering appointment status data.

referenceQueryCommonStringOperationFilterInput

Filters appointment statuses by a unique reference identifier.

nameQueryCommonStringOperationFilterInput

Filters appointment statuses by their name.

entityTypeEntityTypeBaseFilterPayloadFilterInput

Filters appointment statuses based on the type of entity they are associated with (e.g., individual or company).

AppointmentTypeFilterPayloadFilterInput

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

FieldTypeDescription
and[AppointmentTypeFilterPayloadFilterInput!]
or[AppointmentTypeFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering appointment type data.

referenceQueryCommonStringOperationFilterInput

Filters appointment types by a unique reference identifier.

nameQueryCommonStringOperationFilterInput

Filters appointment types by their name.

isHiddenQueryCommonBooleanOperationFilterInput

Filters appointment types based on whether they are hidden from the user interface or active for selection.

isNotInCompanyTypesQueryCommonBooleanOperationFilterInput

Filters appointment types not belonging to the specified company types.

appointmentCategoryAppointmentCategoryBaseFilterPayloadFilterInput

Represents the appointment category associated with a filtered appointment type.

entityTypeEntityTypeBaseFilterPayloadFilterInput

Filters appointment types based on their entity type.

CompanyFilterPayloadFilterInput

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

FieldTypeDescription
and[CompanyFilterPayloadFilterInput!]
or[CompanyFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering company data.

entityNameQueryCommonStringOperationFilterInput

Filters based on the company's name or a partial match of the name.

entityReferenceQueryCommonStringOperationFilterInput

Filters based on the unique reference code assigned to the company.

entityTypeEntityTypeBaseFilterPayloadFilterInput

Filters based on the type of entity, whether it's a company, partnership, trust, or other forms of legal entities.

countryCountryBaseFilterPayloadFilterInput

Filters companies based on the country where they are registered or operate.

subCountrySubCountryBaseFilterPayloadFilterInput

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

personOptionsPersonOptionsFilterPayloadFilterInput

Filters based on the options or preferences associated with individuals related to the company, such as directors or officers.

managedByUserBaseFilterPayloadFilterInput

Filters companies based on the user or system managing their records, used for administrative purposes.

partnerPartnerBaseFilterPayloadFilterInput

Represents the partner associated with a filtered company.

incorporationDateQueryCommonDateOperationFilterInput

Filters companies based on their incorporation date, often used to query entities that were established within a certain time frame.

currentAccountingPeriodEndDateQueryCommonDateOperationFilterInput

Filters companies by their current accounting period end date, which is key for financial reporting and compliance.

isHistoricalRecordQueryCommonBooleanOperationFilterInput

A boolean filter used to include or exclude entities that are no longer active, such as dissolved or merged companies.

isLiveQueryCommonBooleanOperationFilterInput

Filters companies based on their live or active status, returning only those that are currently operating.

companyStatusCompanyStatusBaseFilterPayloadFilterInput

Filters companies based on their operational status, such as 'Active', 'Dormant', or 'Dissolved'.

companyTypeCompanyTypeBaseFilterPayloadFilterInput

Filters based on the legal structure of the company, such as 'Limited', 'Public Limited Company', or 'LLP'.

currencyCurrencyBaseFilterPayloadFilterInput

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.

FieldTypeDescription
and[CompanyStatusBaseFilterPayloadFilterInput!]
or[CompanyStatusBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering base company status data.

referenceQueryCommonStringOperationFilterInput

Filters based on a reference code or identifier used to track company statuses.

nameQueryCommonStringOperationFilterInput

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.

FieldTypeDescription
and[CompanyStatusFilterPayloadFilterInput!]
or[CompanyStatusFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering company status data.

referenceQueryCommonStringOperationFilterInput

Filters by the reference code assigned to a companyΓÇÖs status.

nameQueryCommonStringOperationFilterInput

Filters by the name of the company status (e.g., 'Active', 'Dissolved').

entityTypeEntityTypeBaseFilterPayloadFilterInput

Filters by the entity type, such as 'Company' or 'Partnership'.

CompanyTypeBaseFilterPayloadFilterInput

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

FieldTypeDescription
and[CompanyTypeBaseFilterPayloadFilterInput!]
or[CompanyTypeBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering base company type data.

referenceQueryCommonStringOperationFilterInput

Filters based on a reference code for company types.

nameQueryCommonStringOperationFilterInput

Filters based on the name of the company type, such as 'Limited' or 'PLC'.

CompanyTypeFilterPayloadFilterInput

Filters companies based on their specific type.

FieldTypeDescription
and[CompanyTypeFilterPayloadFilterInput!]
or[CompanyTypeFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering company type data.

referenceQueryCommonStringOperationFilterInput

Filters based on a reference identifier for the company type.

nameQueryCommonStringOperationFilterInput

Filters based on the company type's name.

isHiddenQueryCommonBooleanOperationFilterInput

A boolean filter to exclude or include hidden companies from the results.

entityTypeEntityTypeBaseFilterPayloadFilterInput

Filters companies by their entity type (e.g., company, trust, partnership).

ConnectEntitiesToEntityBatchInput

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

FieldTypeDescription
entityIds[ID!]!

Entity ids to connect to the entity batch.

ConnectEntitiesToEntitySecurityGroupInput

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

FieldTypeDescription
entityIds[ID!]!

Entity ids to connect to the entity security group.

entitySecurityGroupsAppliesToSecurityGroupAppliesToInput

Security group applies-to settings to connect.

ConnectEntitiesToEntitySetInput

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

FieldTypeDescription
entityIds[ID!]!

The entity ids to connect to an entity set.

ConnectEntityBatchesToEntityInput

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

FieldTypeDescription
entityBatches[ID!]!

Entity batches to connect to another entity.

ConnectEntitySecurityGroupsToEntityInput

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

FieldTypeDescription
entitySecurityGroups[ID!]!

Entity security groups to connect to another entity.

entitySecurityGroupsAppliesToSecurityGroupAppliesToInput

Applies-to settings for the entity security groups to connect.

ConnectEntitySetsToEntityInput

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

FieldTypeDescription
entitySets[ID!]!

The entity sets to connect to another entity.

ConnectedEntityFilterPayloadFilterInput

Filter input for querying connected entities.

FieldTypeDescription
and[ConnectedEntityFilterPayloadFilterInput!]
or[ConnectedEntityFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Filters based on the ID of the connected entity.

entityReferenceQueryCommonStringOperationFilterInput

Filters based on the unique reference string of the connected entity.

entityNameQueryCommonStringOperationFilterInput

Filters based on the name of the connected entity.

CountryBaseFilterPayloadFilterInput

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

FieldTypeDescription
and[CountryBaseFilterPayloadFilterInput!]
or[CountryBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering country base payload data.

countryCodeQueryCommonStringOperationFilterInput

Filters by the country code (e.g., ISO 3166 format).

nameQueryCommonStringOperationFilterInput

Filters by the name of the country.

CountryFilterPayloadFilterInput

Filters entities based on country-specific details.

FieldTypeDescription
and[CountryFilterPayloadFilterInput!]
or[CountryFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering country data.

nameQueryCommonStringOperationFilterInput

Filters based on the name of the country.

countryCodeQueryCommonStringOperationFilterInput

Filters based on the two-letter or three-letter ISO country code.

countryCode3QueryCommonStringOperationFilterInput

Filters based on the three-letter ISO country code (e.g., 'USA', 'GBR').

iso3166DescriptionQueryCommonStringOperationFilterInput

Filters by the ISO 3166 description, which is the international standard for country codes and codes of their subdivisions.

isEEAQueryCommonBooleanOperationFilterInput

Filters by whether the country is part of the European Economic Area (EEA).

isUSAQueryCommonBooleanOperationFilterInput

Filters by whether the country is the United States.

CreateCompanyInput

Input type used for creating a new company.

FieldTypeDescription
eventDateLocalDate

The event date for creating a company.

entityNameString!

The name of the entity for the company creation.

companyTypeIdID!

The company type ID for the company creation.

entityReferenceString

The entity reference for the company creation.

companyNumberString

The company number for the company creation.

incorporationDateLocalDate

The incorporation date for the company creation.

companyStatusIdID

The company status ID for the company creation.

countryIdID!

The country ID for the company creation.

subCountryIdID

The sub-country ID for the company creation.

CreateCompanyStatusInput

Input type used for creating a new company status.

FieldTypeDescription
referenceString!

The reference for creating a new company status.

nameString!

The name for creating a new company status.

entityTypeIdID!

The entity type ID for creating a new company status.

CreateCompanyTypeInput

Input type used for creating a new company type.

FieldTypeDescription
referenceString!

The reference for creating a new company type.

nameString!

The name for creating a new company type.

entityTypeIdID!

The entity type ID for creating a new company type.

isNotInCountriesBoolean

Country codes excluded for the new company type.

countryIds[ID!]

Country codes associated with the new company type.

isHiddenBoolean

Indicates if the new company type is hidden.

CreateEntityBatchInput

Input type used for creating a new entity batch.

FieldTypeDescription
referenceString!

The reference for creating a new entity batch.

nameString!

The name for creating a new entity batch.

batchUserIdID

The user ID for creating a new entity batch.

CreateEntityIdentificationInput

Input used to create a new entity identification.

FieldTypeDescription
entityIdID!

The entity ID the identification will be associated with.

entityIdentificationTypeEntityIdentificationType!

The type of identification being created.

identificationString!

The actual identification value.

CreateEntitySecurityGroupInput

Input type used for creating a new entity security group.

FieldTypeDescription
referenceString!

The reference for creating a new entity security group.

nameString!

The name for creating a new entity security group.

userRoleIdID

Represents the user role identifier to associate when creating an entity security group.

liveReferenceString

The live reference for the new entity security group.

entitySecurityGroupAutoString

Indicates if the new entity security group is automatic.

entitySecurityGroupRollUpEntitySecurityGroupRollUp

The roll-up setting for the new entity security group.

entitySecurityGroupAppliesString

The applies-to settings for the new entity security group.

CreateEntitySetInput

Input type used for creating a new entity set.

FieldTypeDescription
referenceString!

The reference for creating a new entity set.

nameString!

The name for creating a new entity set.

appliesTo[EntityTypeCategory!]

The set types for creating a new entity set.

CreateEntityTypeInput

Input type used for creating a new entity type.

FieldTypeDescription
referenceString!

The reference for creating a new entity type.

nameString!

The name for creating a new entity type.

CreateIndividualInput

Input type used for creating a new individual record.

FieldTypeDescription
eventDateLocalDate

Specifies the event date for creating an individual input.

forenamesString!

Specifies the forenames for creating an individual input.

surnameString!

The surname of the individual being created.

displayAsIndividualNameFormat!

The display name of the individual being created.

entityReferenceString

A reference entity for the individual being created.

titleString

The title of the individual being created.

occupationString

The occupation of the individual being created.

nationalityIdID

The nationality ID for the individual being created.

dateOfBirthLocalDate

The date of birth for the individual being created.

nationalIdentificationNumberString

The national identification number of the individual.

passportNumberString

The passport number of the individual.

countryIdID

The country ID associated with the individual.

subCountryIdID

The sub-country ID associated with the individual.

CreateNationalityInput

Input type used for creating a new nationality.

FieldTypeDescription
nameString!

Specifies the name for creating a nationality input.

countryIdID!

Specifies the country ID for creating a nationality input.

subCountryIdID

Specifies the sub-country ID for creating a nationality input.

CreateOtherEntityInput

Input type used for creating a new type of entity.

FieldTypeDescription
eventDateLocalDate

Specifies the event date for creating another entity input.

entityNameString!

Specifies the entity name for creating another entity input.

entityTypeIdID

Specifies the entity type ID for creating another entity input.

companyNumberString

Specifies the company number for creating another entity input.

incorporationDateLocalDate

Specifies the incorporation date for creating another entity input.

countryIdID

Specifies the country ID for creating another entity input.

subCountryIdID

Specifies the sub-country ID for creating another entity input.

entityReferenceString

Specifies the entity reference for creating another entity input.

CreatePartnerInput

Input type used for creating a new partner.

FieldTypeDescription
referenceString!

Specifies the reference for creating a partner input.

nameString!

Specifies the name for creating a partner input.

initialsString

Specifies the initials for creating a partner input.

CreateSubCountryInput

Input type used for creating a new sub-country.

FieldTypeDescription
subCountryCodeString!

Specifies the sub-country code for creating a sub-country input.

nameString!

Specifies the name for creating a sub-country input.

countryIdID!

Specifies the country ID for creating a sub-country input.

CreateUserGroupingInput

Input type used for creating a new user grouping.

FieldTypeDescription
referenceString!

Specifies the reference for creating a user grouping input.

descriptionString!

Specifies the description for creating a user grouping input.

CurrencyBaseFilterPayloadFilterInput

Filters companies or transactions based on currency-related details.

FieldTypeDescription
and[CurrencyBaseFilterPayloadFilterInput!]
or[CurrencyBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering base currency data.

referenceQueryCommonStringOperationFilterInput

Filters based on a reference code for the currency.

currencyCodeQueryCommonStringOperationFilterInput

Filters based on the standard code of the currency, such as 'USD', 'GBP', or 'EUR'.

nameQueryCommonStringOperationFilterInput

Filters based on the name of the currency, like 'Dollar' or 'Euro'.

CurrencyFilterPayloadFilterInput

Filters based on currency attributes.

FieldTypeDescription
and[CurrencyFilterPayloadFilterInput!]
or[CurrencyFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering currency data.

referenceQueryCommonStringOperationFilterInput

Filters by the reference code for a currency.

nameQueryCommonStringOperationFilterInput

Filters by the name of the currency (e.g., 'Dollar', 'Euro').

currencyCodeQueryCommonStringOperationFilterInput

Filters by the official currency code (e.g., 'USD', 'EUR').

prefixQueryCommonStringOperationFilterInput

Filters by the prefix symbol used before a currency (e.g., '$').

suffixQueryCommonStringOperationFilterInput

Filters by the suffix symbol used after a currency (e.g., 'Γé¼').

countryCountryBaseFilterPayloadFilterInput

Filters currency data based on the associated country.

DeleteCompanyInput

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

FieldTypeDescription
idID!

The ID of the company to delete.

DeleteCompanyStatusInput

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

FieldTypeDescription
idID!

The ID of the company status to delete.

DeleteCompanyTypeInput

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

FieldTypeDescription
idID!

The ID of the company type to delete.

DeleteEntityBatchInput

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

FieldTypeDescription
idID!

The ID of the entity batch to delete.

DeleteEntityIdentificationInput

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

FieldTypeDescription
idID!

The unique identifier of the entity identification to delete.

DeleteEntitySecurityGroupInput

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

FieldTypeDescription
idID!

The ID of the entity security group to delete.

DeleteEntitySetInput

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

FieldTypeDescription
idID!

The ID of the entity set to delete.

DeleteEntityTypeInput

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

FieldTypeDescription
idID!

The ID of the entity type to delete.

DeleteIndividualInput

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

FieldTypeDescription
idID!

The ID of the individual to delete.

DeleteNationalityInput

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

FieldTypeDescription
idID!

The ID of the nationality to delete.

DeleteOtherEntityInput

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

FieldTypeDescription
idID!

The ID of the other entity to delete.

DeletePartnerInput

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

FieldTypeDescription
idID!

The ID of the partner to delete.

DeleteSubCountryInput

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

FieldTypeDescription
idID!

The ID of the sub-country to delete.

DeleteUserGroupingInput

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

FieldTypeDescription
idID!

The ID of the user grouping to delete.

DisconnectEntitiesFromEntityBatchInput

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

FieldTypeDescription
entityIds[ID!]!

Entity ids to disconnect from the entity batch.

DisconnectEntitiesFromEntitySecurityGroupInput

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

FieldTypeDescription
entityIds[ID!]!

Entity ids to disconnect from the security group.

entitySecurityGroupsAppliesToSecurityGroupAppliesToInput

Security group applies-to settings to disconnect.

DisconnectEntitiesFromEntitySetInput

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

FieldTypeDescription
entityIds[ID!]!

The entity ids to disconnect from an entity set.

DisconnectEntityBatchesFromEntityInput

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

FieldTypeDescription
entityBatches[ID!]!

Entity batches to disconnect from another entity.

DisconnectEntitySecurityGroupsFromEntityInput

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

FieldTypeDescription
entitySecurityGroups[ID!]!

Entity security groups to disconnect from another entity.

entitySecurityGroupsAppliesToSecurityGroupAppliesToInput

Applies-to settings for the security groups to disconnect.

DisconnectEntitySetsFromEntityInput

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

FieldTypeDescription
entitySets[ID!]!

The entity sets to disconnect from another entity.

EntityBaseFilterPayloadFilterInput

Provides a base filter for entities based on multiple attributes.

FieldTypeDescription
and[EntityBaseFilterPayloadFilterInput!]
or[EntityBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering base entity data.

entityNameQueryCommonStringOperationFilterInput

Filters entities based on their name.

entityReferenceQueryCommonStringOperationFilterInput

Represents the entity reference associated with a filtered base entity.

entityTypeEntityTypeBaseFilterPayloadFilterInput

Filters entities by their type (e.g., individual, company).

countryCountryBaseFilterPayloadFilterInput

Filters entities by the associated country.

subCountrySubCountryBaseFilterPayloadFilterInput

Filters entities based on sub-country regions.

personOptionsPersonOptionsFilterPayloadFilterInput

Filters entities based on available person-related options.

managedByUserBaseFilterPayloadFilterInput

Filters entities by their managing user or group.

partnerPartnerBaseFilterPayloadFilterInput

Represents the partner associated with a filtered base entity.

EntityBatchFilterPayloadFilterInput

Filters entities based on batch attributes.

FieldTypeDescription
and[EntityBatchFilterPayloadFilterInput!]
or[EntityBatchFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering entity batch payload data.

referenceQueryCommonStringOperationFilterInput

Filters by the reference code for a batch of entities.

nameQueryCommonStringOperationFilterInput

Filters by the name of the batch.

batchUserUserBaseFilterPayloadFilterInput

Filters by the user associated with the batch.

EntitySecurityGroupFilterPayloadFilterInput

Filters entities based on security group attributes.

FieldTypeDescription
and[EntitySecurityGroupFilterPayloadFilterInput!]
or[EntitySecurityGroupFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering entity security group data.

referenceQueryCommonStringOperationFilterInput

Filters by the reference code for the security group.

nameQueryCommonStringOperationFilterInput

Filters by the name of the security group.

liveReferenceQueryCommonStringOperationFilterInput

Filters by the live reference used in security group-related operations.

systemPredefinedQueryCommonBooleanOperationFilterInput

Filters based on whether the security group is predefined by the system.

entitySecurityGroupAutoQueryCommonStringOperationFilterInput

Filters entities based on whether security groups are automatically assigned.

entitySecurityGroupRollUpQueryCommonIntegerOperationFilterInput

Filters entity security groups by their roll-up settings.

entitySecurityGroupAppliesQueryCommonStringOperationFilterInput

Filters based on whether a specific security group applies to the entity.

userRoleUserRoleBaseFilterPayloadFilterInput

Filters by the user role assigned within the security group.

EntitySetFilterPayloadFilterInput

Filters entities based on sets they belong to.

FieldTypeDescription
and[EntitySetFilterPayloadFilterInput!]
or[EntitySetFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering entity set data.

referenceQueryCommonStringOperationFilterInput

Filters by the reference code for the entity set.

nameQueryCommonStringOperationFilterInput

Filters by the name of the entity set.

EntityTypeBaseFilterPayloadFilterInput

Filters entity types based on standard attributes.

FieldTypeDescription
and[EntityTypeBaseFilterPayloadFilterInput!]
or[EntityTypeBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering entity type base payload data.

referenceQueryCommonStringOperationFilterInput

Filters by the reference identifier for the entity type.

nameQueryCommonStringOperationFilterInput

Filters by the name of the entity type.

EntityTypeFilterPayloadFilterInput

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

FieldTypeDescription
and[EntityTypeFilterPayloadFilterInput!]
or[EntityTypeFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering entity type data.

referenceQueryCommonStringOperationFilterInput

Filters by the reference code for an entity type.

nameQueryCommonStringOperationFilterInput

Filters by the name of the entity type (e.g., 'Company', 'Trust').

EventGroupBaseFilterPayloadFilterInput

Filter input used to retrieve event groups based on criteria.

FieldTypeDescription
and[EventGroupBaseFilterPayloadFilterInput!]
or[EventGroupBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Filter based on the unique identifier of the event group.

referenceQueryCommonStringOperationFilterInput

Filter based on a reference string assigned to the event group.

nameQueryCommonStringOperationFilterInput

Filter based on the name of the event group.

EventGroupFilterPayloadFilterInput

Filter input used to query event groups based on various attributes.

FieldTypeDescription
and[EventGroupFilterPayloadFilterInput!]
or[EventGroupFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Filters event groups by their unique identifier.

referenceQueryCommonStringOperationFilterInput

Filters event groups by their reference code.

nameQueryCommonStringOperationFilterInput

Filters event groups by their name.

EventTypeFilterPayloadFilterInput

Filter input used to query event types based on various attributes.

FieldTypeDescription
and[EventTypeFilterPayloadFilterInput!]
or[EventTypeFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Filters event types by their unique identifier.

referenceQueryCommonStringOperationFilterInput

Filters event types by their reference code.

nameQueryCommonStringOperationFilterInput

Filters event types by their name.

eventGroupEventGroupBaseFilterPayloadFilterInput

Filters event types based on their associated event group.

IndividualFilterPayloadFilterInput

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

FieldTypeDescription
and[IndividualFilterPayloadFilterInput!]
or[IndividualFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering individual data.

entityNameQueryCommonStringOperationFilterInput

Filters individuals based on the name of the entity they are associated with.

entityReferenceQueryCommonStringOperationFilterInput

Represents the entity reference associated with a filtered individual.

entityTypeEntityTypeBaseFilterPayloadFilterInput

Filters individuals based on the type of entity they are associated with (e.g., company, partnership).

countryCountryBaseFilterPayloadFilterInput

Filters individuals based on their country of residence or operation.

subCountrySubCountryBaseFilterPayloadFilterInput

Filters individuals based on subdivisions within a country, such as states or provinces.

personOptionsPersonOptionsFilterPayloadFilterInput

Filters based on various person-related options, such as additional roles or responsibilities.

managedByUserBaseFilterPayloadFilterInput

Filters individuals by the user or group managing their records.

partnerPartnerBaseFilterPayloadFilterInput

Represents the partner associated with a filtered individual.

occupationQueryCommonStringOperationFilterInput

Filters individuals by their occupation or profession.

dateOfBirthQueryCommonDateOperationFilterInput

Filters individuals by their date of birth.

dateOfDeathQueryCommonDateOperationFilterInput

Filters individuals by their date of death, often for historical records.

isHistoricalRecordQueryCommonBooleanOperationFilterInput

A boolean filter that includes or excludes historical records of individuals.

nationalityNationalityBaseFilterPayloadFilterInput

Filters individuals by their nationality.

IndustrialClassificationFilterPayloadFilterInput

Represents filtering input for industrial classification data.

FieldTypeDescription
and[IndustrialClassificationFilterPayloadFilterInput!]
or[IndustrialClassificationFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering industrial classification data.

nameQueryCommonStringOperationFilterInput

Represents the name associated with a filtered industrial classification.

countryCountryBaseFilterPayloadFilterInput

Represents the country associated with a filtered industrial classification.

NationalityBaseFilterPayloadFilterInput

Represents filtering input for nationality base entities.

FieldTypeDescription
and[NationalityBaseFilterPayloadFilterInput!]
or[NationalityBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering nationality base payload data.

nameQueryCommonStringOperationFilterInput

Represents the name associated with a filtered nationality base entity.

NationalityFilterPayloadFilterInput

Filters nationality records based on standard attributes.

FieldTypeDescription
and[NationalityFilterPayloadFilterInput!]
or[NationalityFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering nationality data.

nameQueryCommonStringOperationFilterInput

Filters by the name of the nationality.

countryCountryBaseFilterPayloadFilterInput

Represents the country associated with a filtered nationality.

subCountrySubCountryBaseFilterPayloadFilterInput

Represents the sub-country associated with a filtered nationality.

OccupationFilterPayloadFilterInput

Provides a base filter for occupations based on criteria.

FieldTypeDescription
and[OccupationFilterPayloadFilterInput!]
or[OccupationFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering occupation data.

referenceQueryCommonStringOperationFilterInput

Filters occupations by their reference ID.

OtherEntityFilterPayloadFilterInput

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

FieldTypeDescription
and[OtherEntityFilterPayloadFilterInput!]
or[OtherEntityFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering other entity data.

entityNameQueryCommonStringOperationFilterInput

Filters based on the entity's name or a partial match of the name.

entityReferenceQueryCommonStringOperationFilterInput

Represents the entity reference associated with a filtered other entity.

entityTypeEntityTypeBaseFilterPayloadFilterInput

Filters based on the entity type, whether it is a company, trust, partnership, or other.

countryCountryBaseFilterPayloadFilterInput

Filters entities based on the country of operation or registration.

subCountrySubCountryBaseFilterPayloadFilterInput

Filters based on a specific region or subdivision within a country.

personOptionsPersonOptionsFilterPayloadFilterInput

Filters based on options or attributes related to individuals associated with the entity.

managedByUserBaseFilterPayloadFilterInput

Filters based on the user or team managing the entity's records.

partnerPartnerBaseFilterPayloadFilterInput

Represents the partner associated with a filtered other entity.

companyNumberQueryCommonStringOperationFilterInput

Filters entities based on their assigned registration or company number.

dissolvedDateQueryCommonDateOperationFilterInput

Filters entities based on their dissolution date, useful for querying entities that are no longer operational.

occupationQueryCommonStringOperationFilterInput

Filters based on the occupation or business type of the entity.

incorporationDateQueryCommonDateOperationFilterInput

Filters based on the incorporation or registration date of the entity.

isHistoricalRecordQueryCommonBooleanOperationFilterInput

A boolean filter to include or exclude historical or inactive records from the results.

PartnerBaseFilterPayloadFilterInput

Represents filtering input for base partner entities.

FieldTypeDescription
and[PartnerBaseFilterPayloadFilterInput!]
or[PartnerBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering partner base payload data.

nameQueryCommonStringOperationFilterInput

Represents the name associated with a filtered partner base entity.

PartnerFilterPayloadFilterInput

Represents filtering input for partner entities.

FieldTypeDescription
and[PartnerFilterPayloadFilterInput!]
or[PartnerFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering partner data.

nameQueryCommonStringOperationFilterInput

Represents the name associated with a filtered partner.

initialsQueryCommonStringOperationFilterInput

Represents the initials associated with a filtered partner.

PersonOptionsFilterPayloadFilterInput

Filters person-related records based on options or preferences.

FieldTypeDescription
and[PersonOptionsFilterPayloadFilterInput!]
or[PersonOptionsFilterPayloadFilterInput!]
noOtherDirectorshipsQueryCommonBooleanOperationFilterInput

Filters based on whether the individual holds no other directorships.

noRegisterAddendumsQueryCommonBooleanOperationFilterInput

Filters based on whether there are no register addendums for the individual.

noShareCertificatesQueryCommonBooleanOperationFilterInput

Filters based on whether there are no share certificates associated with the individual.

noStockTransferFormsQueryCommonBooleanOperationFilterInput

Filters based on whether there are no stock transfer forms for the individual.

QueryCommonBooleanOperationFilterInput

Represents filtering operations based on boolean values.

FieldTypeDescription
eqBoolean

Represents an equality comparison for boolean values.

neqBoolean

Represents a non-equality comparison for boolean values.

QueryCommonDateOperationFilterInput

A filter for date fields, supporting various comparison operations.

FieldTypeDescription
or[QueryCommonDateOperationFilterInput!]
eqDate

Filters records where the date equals the provided value.

neqDate

Filters records where the date does not equal the provided value.

gtDate

Filters records where the date is greater than the provided value.

gteDate

Filters records where the date is greater than or equal to the provided value.

ltDate

Filters records where the date is less than the provided value.

lteDate

Filters records where the date is less than or equal to the provided value.

QueryCommonIntegerOperationFilterInput

A filter for integer fields, supporting various comparison operations.

FieldTypeDescription
or[QueryCommonIntegerOperationFilterInput!]
eqInt

Filters records where the integer equals the provided value.

neqInt

Filters records where the integer does not equal the provided value.

gtInt

Filters records where the integer is greater than the provided value.

gteInt

Filters records where the integer is greater than or equal to the provided value.

ltInt

Filters records where the integer is less than the provided value.

lteInt

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.

FieldTypeDescription
or[QueryCommonStringOperationFilterInput!]
eqString

Filters records where the string equals the provided value.

neqString

Filters records where the string does not equal the provided value.

containsString

Filters records where the string contains the provided substring.

ncontainsString

Represents a filter condition where the string does not contain a specific value.

startsWithString

Filters records where the string starts with the provided substring.

nstartsWithString

Filters records where the string does not start with the provided substring.

endsWithString

Filters records where the string ends with the provided substring.

nendsWithString

Filters records where the string does not end with the provided substring.

QueryIdStringOperationFilterInput

Represents filtering operations based on string identifiers.

FieldTypeDescription
and[QueryIdStringOperationFilterInput!]
or[QueryIdStringOperationFilterInput!]
eqString

Represents an equality comparison for string identifiers.

neqString

Represents a non-equality comparison for string identifiers.

SecurityGroupAppliesToInput

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

FieldTypeDescription
autoAddRemoveSecurityGroupsBoolean

Indicates whether security groups are automatically added or removed.

naCorporateAppointeesOrShareholdersBoolean

Applies to non-corporate appointees or shareholders.

companyBoolean

Specifies the company to which the security group applies.

appointmentsBoolean

Specifies the appointments to which the security group applies.

shareHoldersBoolean

Specifies the shareholders to which the security group applies.

guarantorsBoolean

Specifies the guarantors to which the security group applies.

committeesBoolean

Specifies the committees to which the security group applies.

committeeAppointmentsBoolean

Specifies the committee appointments to which the security group applies.

registrationsBoolean

Specifies the registrations to which the security group applies.

branchesBoolean

Specifies the branches to which the security group applies.

SubCountryBaseFilterPayloadFilterInput

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

FieldTypeDescription
and[SubCountryBaseFilterPayloadFilterInput!]
or[SubCountryBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering sub-country base payload data.

subCountryCodeQueryCommonStringOperationFilterInput

Filters by the sub-country code (e.g., state or province code).

nameQueryCommonStringOperationFilterInput

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.

FieldTypeDescription
and[SubCountryFilterPayloadFilterInput!]
or[SubCountryFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering sub-country payload data.

subCountryCodeQueryCommonStringOperationFilterInput

Filters by the code assigned to a subdivision within a country.

nameQueryCommonStringOperationFilterInput

Filters by the name of the subdivision within a country (e.g., state or province).

countryCountryBaseFilterPayloadFilterInput

Filters sub-country data based on the associated country.

UpdateCompanyInput

Input type used for updating details of a company.

FieldTypeDescription
eventDateLocalDate

The event date for updating a company.

entityNameString

The name of the entity associated with the company update.

companyTypeIdID

The company type ID for updating the company.

partnerIdID

The partner ID associated with the company update.

isHistoricalRecordBoolean

Indicates if the company is a historical record.

companyNumberString

The company number for the company update.

incorporationDateLocalDate

The incorporation date for the company update.

dissolvedDateLocalDate

The dissolution date for the company update.

lastAccountingPeriodEndDateLocalDate

The last accounting period end date for the company.

currentAccountingPeriodEndDateLocalDate

The current accounting period end date for the company.

lastAccountingPeriodExtendedDateLocalDate

The last extended accounting period end date for the company.

companyStatusIdID

The company status ID for the company update.

industrialClassification1IdID

The first industrial classification ID for the company.

industrialClassification2IdID

The second industrial classification ID for the company.

industrialClassification3IdID

The third industrial classification ID for the company.

industrialClassification4IdID

The fourth industrial classification ID for the company.

industrialClassificationOtherString

The other industrial classification details for the company.

lastAccountsDateLocalDate

The last accounts date for the company.

accountsSignedDateLocalDate

The accounts signed date for the company.

accountsFiledDateLocalDate

The accounts filed date for the company.

isAccountsFiledOverriddenBoolean

Indicates if the accounts filed date is overridden.

accountsInReviewDateLocalDate

The accounts in review date for the company.

accountsOverdueDateLocalDate

The accounts overdue date for the company.

isAccountsOverdueOverriddenBoolean

Indicates if the accounts overdue date is overridden.

hasAccountsOverseasExtensionBoolean

Indicates if the accounts have an overseas extension.

lastMembersScheduleDateLocalDate

The last members schedule date for the company.

lastAnnualReturnDateLocalDate

The last annual return date for the company.

annualReturnSignedDateLocalDate

The annual return signed date for the company.

annualReturnFiledDateLocalDate

The annual return filed date for the company.

nextAnnualReturnDateLocalDate

The next annual return date for the company.

isNextAnnualReturnDateAutomaticBoolean

Indicates if the next annual return date is automatic.

isMembersScheduleAsRequiredBoolean

Indicates if the members schedule is as required.

isMembersScheduleNotOnPaperBoolean

Indicates if the members schedule is not on paper.

lastAnnualMeetingDateLocalDate

The last annual meeting date for the company.

annualMeetingMinutesSignedDateLocalDate

The annual meeting minutes signed date for the company.

nextAnnualMeetingDateLocalDate

The next annual meeting date for the company.

isNextAnnualMeetingDateAutomaticBoolean

Indicates if the next annual meeting date is automatic.

lastMeetingApproveAccountsDateLocalDate

The last meeting approve accounts date for the company.

meetingApproveAccountsMinutesSignedDateLocalDate

The minutes signed date for the meeting approving accounts.

financialPeriodFromDateLocalDate

The financial period start date for the company.

financialPeriodToDateLocalDate

The financial period end date for the company.

isFinancialPeriodAutomaticBoolean

Indicates if the financial period is automatic.

countryIdID

The country ID associated with the company update.

subCountryIdID

The sub-country ID associated with the company update.

isLiveBoolean

Indicates if the company is live.

registeredEmailAddressString

The registered email address for the company.

UpdateCompanyOptionsInput

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

FieldTypeDescription
systemDefaultRegisterSettingsBoolean

System default register settings for company options.

separateRegistersForDirectorsSecretariesBoolean

Separate registers for directors and secretaries in options.

registersListByNameBoolean

Registers listed by name for company options.

provideSpaceOnRegisterForManualEntriesBoolean

Provides space on register for manual entries in options.

globalDocumentReferenceFormatBoolean

Represents the global format used to generate document references across the system.

defaultDocumentReferenceFormatBoolean

Specifies the default document reference format when no global format is defined.

documentFormatSeparatorDocumentReferenceSeparator

Defines the character or symbol used to separate segments in a document reference.

documentFormatSegment1DocumentReferenceSegment

Represents the first segment in the document reference format structure.

documentFormatSegment2DocumentReferenceSegment

Represents the second segment in the document reference format structure.

documentFormatSegment3DocumentReferenceSegment

Represents the third segment in the document reference format structure

UpdateCompanyStatusInput

Input type used for updating details of a company status.

FieldTypeDescription
nameString

The name of the company status to update.

entityTypeIdID

The entity type ID for the company status to update.

UpdateCompanyTypeInput

Input type used for updating details of a company type.

FieldTypeDescription
nameString

The name of the company type to update.

isNotInCountriesBoolean

Country codes excluded for the company type to update.

countryIds[ID!]

Country codes associated with the company type to update.

entityTypeIdID

The entity type ID for the company type to update.

isHiddenBoolean

Indicates if the company type is hidden.

UpdateEntityBatchInput

Input type used for updating details of an entity batch.

FieldTypeDescription
nameString

The name of the entity batch to update.

batchUserIdID

The user ID associated with the entity batch to update.

UpdateEntityIdentificationInput

Input used to update an existing entity identification.

FieldTypeDescription
identificationString!

The updated identification value.

UpdateEntitySecurityGroupInput

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

FieldTypeDescription
nameString

The name of the entity security group to update.

userRoleIdID

Represents the user role identifier to associate when updating an entity security group.

liveReferenceString

The live reference for the entity security group.

entitySecurityGroupAutoString

Indicates if the entity security group is automatic.

entitySecurityGroupRollUpEntitySecurityGroupRollUp

The roll-up setting for the entity security group.

entitySecurityGroupAppliesString

Specifies the applies-to settings for the entity security group.

UpdateEntitySetInput

Input type used for updating details of an entity set.

FieldTypeDescription
nameString

The name of the entity set to update.

appliesTo[EntityTypeCategory!]

The set types to update for the entity set.

UpdateEntityTypeInput

Input type used for updating details of an entity type.

FieldTypeDescription
nameString

The name of the entity type to update.

UpdateIndividualInput

Input type used for updating details of an individual.

FieldTypeDescription
eventDateLocalDate

Specifies the event date for updating an individual input.

forenamesString

Specifies the forenames for updating an individual input.

surnameString

Specifies the surname for updating an individual input.

displayAsIndividualNameFormat

Specifies the display name for updating an individual input.

partnerIdID

Specifies the partner ID for updating an individual input.

isHistoricalRecordBoolean

Indicates if the individual is a historical record in updates.

titleString

Specifies the title for updating an individual input.

honoursString

Specifies the honors for updating an individual input.

salutationString

Specifies the salutation for updating an individual input.

previousNameString

Specifies the previous name for updating an individual input.

occupationString

Specifies the occupation for updating an individual input.

nationalityIdID

Specifies the nationality ID for updating an individual input.

dateOfBirthLocalDate

Specifies the date of birth for updating an individual input.

dateOfDeathLocalDate

Specifies the date of death for updating an individual input.

nationalIdentificationNumberString

Specifies the national identification number for updating an individual input.

passportNumberString

Specifies the passport number for updating an individual input.

countryIdID

Specifies the country ID for updating an individual input.

subCountryIdID

Specifies the sub-country ID for updating an individual input.

UpdateNationalityInput

Input type used for updating details of a nationality.

FieldTypeDescription
nameString

Specifies the name for updating a nationality input.

countryIdID

Specifies the country ID for updating a nationality input.

subCountryIdID

Specifies the sub-country ID for updating a nationality input.

UpdateOtherEntityInput

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

FieldTypeDescription
eventDateLocalDate

Specifies the event date for updating another entity input.

entityNameString

Specifies the entity name for updating another entity input.

partnerIdID

Specifies the partner ID for updating another entity input.

isHistoricalRecordBoolean

Indicates if the entity is a historical record in updates.

entityTypeIdID

Specifies the entity type ID for updating another entity input.

companyNumberString

Specifies the company number for updating another entity input.

incorporationDateLocalDate

Specifies the incorporation date for updating another entity input.

dissolvedDateLocalDate

Specifies the dissolved date for updating another entity input.

occupationString

Specifies the occupation for updating another entity input.

countryIdID

Specifies the country ID for updating another entity input.

subCountryIdID

Specifies the sub-country ID for updating another entity input.

UpdatePartnerInput

Input type used for updating details of a partner.

FieldTypeDescription
nameString

Specifies the name for updating a partner input.

initialsString

Specifies the initials for updating a partner input.

UpdatePersonOptionsInput

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

FieldTypeDescription
hasShareCertificatesBoolean

Indicates if share certificates are updated in person options.

hasStockTransferFormsBoolean

Indicates if stock transfer forms are updated in person options.

hasRegisterAddendumsBoolean

Indicates if register addendums are updated in person options.

hasOtherDirectorshipsBoolean

Indicates if other directorships are updated in person options.

UpdateSubCountryInput

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

FieldTypeDescription
nameString

Specifies the name for updating a sub-country input.

UpdateUserGroupingInput

Input type used for updating details of a user grouping.

FieldTypeDescription
descriptionString

Describes an update for a user grouping input.

UserBaseFilterPayloadFilterInput

Filters user records based on standard attributes.

FieldTypeDescription
and[UserBaseFilterPayloadFilterInput!]
or[UserBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering user base payload data.

referenceQueryCommonStringOperationFilterInput

Filters by the reference identifier for the user.

nameQueryCommonStringOperationFilterInput

Filters by the name of the user.

UserFilterPayloadFilterInput

Filters user records based on attributes like reference or name.

FieldTypeDescription
and[UserFilterPayloadFilterInput!]
or[UserFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering user data.

referenceQueryCommonStringOperationFilterInput

Filters users by their reference code or identifier.

nameQueryCommonStringOperationFilterInput

Filters users by their name.

UserGroupingFilterPayloadFilterInput

Represents filtering options for user groupings.

FieldTypeDescription
and[UserGroupingFilterPayloadFilterInput!]
or[UserGroupingFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier for filtering user grouping data.

descriptionQueryCommonStringOperationFilterInput

Represents the description of the filtered user grouping.

UserRoleBaseFilterPayloadFilterInput

Represents filtering input for user role base entities.

FieldTypeDescription
and[UserRoleBaseFilterPayloadFilterInput!]
or[UserRoleBaseFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier used to filter user role base entities.

referenceQueryCommonStringOperationFilterInput

Represents the reference string used for filtering user role base entries.

nameQueryCommonStringOperationFilterInput

Represents the name field used to filter user role base entities.

UserRoleFilterPayloadFilterInput

Represents filtering options for user role payloads.

FieldTypeDescription
and[UserRoleFilterPayloadFilterInput!]
or[UserRoleFilterPayloadFilterInput!]
idQueryIdStringOperationFilterInput

Represents the unique identifier used to filter user roles.

referenceQueryCommonStringOperationFilterInput

Represents the reference string used in user role filtering.

nameQueryCommonStringOperationFilterInput

Represents the name used to filter user role entries.

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.

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

DocumentReferenceSegment

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

ValueDescription
NONE
QUICK_REFERENCE
USER_GROUPING
FILE_REFERENCE
MANAGED_BY
MANAGE_BY_INITIALS
PARTNER
PARTNER_INITIALS
REGISTRATION_NUMBER
COUNTRY_CODE
DOCUMENT_REFERENCE

DocumentReferenceSeparator

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

ValueDescription
NONE
SPACE
SLASH
DOT
DASH
COLON
PLUS_SIGN
ASTERISK

EntityIdentificationType

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

ValueDescription
UNKNOWN
IDV_CODE

EntitySecurityGroupRollUp

Represents a roll-up configuration for entity security groups.

ValueDescription
STOP_AND_PROCESS
ADD_RIGHTS_AND_CONTINUE
REMOVE_RIGHTS_AND_CONTINUE

EntityTypeCategory

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

ValueDescription
COMPANY
INDIVIDUAL
INCORPORATION
PARTNERSHIP
OTHER_ENTITY

IndividualNameFormat

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

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

JSON

Represents a raw JSON structure that can hold arbitrary data

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.

FieldArgumentTypeDescription
countryCountry
entityBatches[EntityBatch!]!
entitySecurityGroups[EntitySecurityGroup!]!
entitySets[EntitySet!]
entityTypeEntityType
partnerPartner
personOptionsPersonOptions
subCountrySubCountry
managedByUser
idID!
updatedAtDateTime
referenceTypeEntityTypeCategory!
entityReferenceString
entityNameString

Possible Types: Company, Individual, MinimalEntityPayload, OtherEntity

Error

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

FieldArgumentTypeDescription
extensions[KeyValuePairOfStringAndJsonElement!]!
typeString
titleString
statusInt
detailString
instanceString

Possible Types: ErrorOfCompanyOptionsPayload, ErrorOfCompanyPayload, ErrorOfCompanyStatusPayload, ErrorOfCompanyTypePayload, ErrorOfEntityBatchPayload, ErrorOfEntityIdentificationPayload, 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.

FieldArgumentTypeDescription
idID!

Possible Types: Address, AddressType, Appointment, AppointmentCategory, AppointmentGroup, AppointmentStatus, AppointmentType, Company, CompanyStatus, CompanyType, Country, Currency, EntityBatch, EntityIdentification, EntitySecurityGroup, EntitySet, EntityType, EventGroup, EventType, Individual, IndustrialClassification, Nationality, Occupation, OtherEntity, Partner, SubCountry, User, UserGrouping, UserRole

Unions

ConnectEntitiesToEntityBatchError

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

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

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

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

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

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

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

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

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

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

TypeDescription
ErrorOfEntityBatchPayload

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

ValidationError

Represents a validation error encountered during input or processing.

CreateEntityIdentificationError

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

TypeDescription
ErrorOfEntityIdentificationPayload

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

ValidationError

Represents a validation error encountered during input or processing.

CreateEntitySecurityGroupError

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

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

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

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

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

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

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

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

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

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

TypeDescription
ErrorOfCompanyPayload

Represents an error payload specific to company-related operations.

ValidationError

Represents a validation error encountered during input or processing.

DeleteCompanyStatusError

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

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

TypeDescription
ErrorOfCompanyTypePayload

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

ValidationError

Represents a validation error encountered during input or processing.

DeleteEntityBatchError

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

TypeDescription
ErrorOfEntityBatchPayload

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

ValidationError

Represents a validation error encountered during input or processing.

DeleteEntityIdentificationError

Error object returned if deletion of an entity identification fails.

TypeDescription
ErrorOfEntityIdentificationPayload

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

ValidationError

Represents a validation error encountered during input or processing.

DeleteEntitySecurityGroupError

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

TypeDescription
ErrorOfEntitySecurityGroupPayload

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

ValidationError

Represents a validation error encountered during input or processing.

DeleteEntitySetError

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

TypeDescription
ErrorOfEntitySetPayload

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

ValidationError

Represents a validation error encountered during input or processing.

DeleteEntityTypeError

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

TypeDescription
ErrorOfEntityTypePayload

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

ValidationError

Represents a validation error encountered during input or processing.

DeleteIndividualError

Represents an error encountered during the deletion of an individual.

TypeDescription
ErrorOfIndividualPayload

Represents an error payload specific to individual-related operations.

ValidationError

Represents a validation error encountered during input or processing.

DeleteNationalityError

Represents an error encountered during the deletion of a nationality.

TypeDescription
ErrorOfNationalityPayload

Represents an error payload specific to nationality-related operations.

ValidationError

Represents a validation error encountered during input or processing.

DeleteOtherEntityError

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

TypeDescription
ErrorOfOtherEntityPayload

Represents an error payload specific to other types of entities.

ValidationError

Represents a validation error encountered during input or processing.

DeletePartnerError

Represents an error encountered during the deletion of a partner.

TypeDescription
ErrorOfPartnerPayload

Represents an error payload specific to partner-related operations.

ValidationError

Represents a validation error encountered during input or processing.

DeleteSubCountryError

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

TypeDescription
ErrorOfSubCountryPayload

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

ValidationError

Represents a validation error encountered during input or processing.

DeleteUserGroupingError

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

TypeDescription
ErrorOfUserGroupingPayload

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

ValidationError

Represents a validation error encountered during input or processing.

DisconnectEntitiesFromEntityBatchError

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

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

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

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

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

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

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

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

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

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

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

TypeDescription
ErrorOfEntityBatchPayload

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

ValidationError

Represents a validation error encountered during input or processing.

UpdateEntityIdentificationError

Error object returned if an update to entity identification fails.

TypeDescription
ErrorOfEntityIdentificationPayload

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

ValidationError

Represents a validation error encountered during input or processing.

UpdateEntitySecurityGroupError

Represents an error encountered while disconnecting security groups from an entity.

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

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

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

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

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

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

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

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

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

TypeDescription
ErrorOfUserGroupingPayload

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

ValidationError

Represents a validation error encountered during input or processing.