GraphQL RepositoriesparentAccountRelationType

`entities.parentAccountRelationType`

Read parent account relation type records with the parentAccountRelationType repository, and change them with the parent account relation type mutations. Same records as the REST ParentAccountRelationTypes entity.

Example: first three parent account relation type recordsGraphQLcURL

query FirstParentAccountRelationTypes {
  entities {
    parentAccountRelationType {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstParentAccountRelationTypes { entities { parentAccountRelationType { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { parentAccountRelationType { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	ParentAccountRelationTypeEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ParentAccountRelationTypeEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ParentAccountRelationTypeFilterInput, orderBy: [ParentAccountRelationTypeOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ParentAccountRelationTypeEntity!]!
QUERY	`getByCriteria`(filter: ParentAccountRelationTypeFilterInput, orderBy: [ParentAccountRelationTypeOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ParentAccountRelationTypeEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createParentAccountRelationType`(input: CreateParentAccountRelationTypeInput!, validationLevel: [ValidationLevel!])	Create one record	CreateParentAccountRelationTypePayload
MUTATION	`updateParentAccountRelationType`(input: UpdateParentAccountRelationTypeInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateParentAccountRelationTypePayload
MUTATION	`bulkUpdateParentAccountRelationType`(input: [CreateOrUpdateParentAccountRelationTypeInput!]!, deleteInput: [DeleteParentAccountRelationTypeInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateParentAccountRelationTypePayload
MUTATION	`deleteParentAccountRelationType`(input: DeleteParentAccountRelationTypeInput!)	Soft-delete	DeleteParentAccountRelationTypePayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

ParentAccountRelationTypeEntity object 9 fields: isDeleteProtected, id, isDeleted, …

Kind of parent-child relationship between accounts (e.g. parent company and subsidiary), with a label for each side.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`childLabel`	String!	Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company).
`parentLabel`	String!	Label shown for the parent side of the parent-child account relation (e.g. "Parent company").
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

ParentAccountRelationTypeEntityConnection object pageInfo: PageInfo!, edges: [ParentAccountRelationTypeEntityEdge]!, totalCount: Int

Paginated list of ParentAccountRelationType records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[ParentAccountRelationTypeEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

ParentAccountRelationTypeEntityEdge object node: ParentAccountRelationTypeEntity, cursor: String!

A Relay edge containing a ParentAccountRelationTypeEntity and its cursor.

Field	Type	Description
`node`	ParentAccountRelationTypeEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

ParentAccountRelationTypeFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for ParentAccountRelationType records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[ParentAccountRelationTypeFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ParentAccountRelationTypeFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ParentAccountRelationTypeFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`childLabel`	EntityFilterStringField	Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company).
`parentLabel`	EntityFilterStringField	Label shown for the parent side of the parent-child account relation (e.g. "Parent company").
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

ParentAccountRelationTypeOrderByInput input Asc or Desc per field

Sorting of ParentAccountRelationType records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`childLabel`	OrderByEnum	Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company).
`parentLabel`	OrderByEnum	Label shown for the parent side of the parent-child account relation (e.g. "Parent company").
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateOrUpdateParentAccountRelationTypeInput input 7 fields: clientMutationId, id, modified, …

Field values of a ParentAccountRelationType record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`childLabel`	String	Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company).
`parentLabel`	String	Label shown for the parent side of the parent-child account relation (e.g. "Parent company").
`revision`	Int	Revision when entity was lastly changed.

CreateParentAccountRelationTypeInput input 6 fields: clientMutationId, modified, created, …

Field values of a new ParentAccountRelationType record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`childLabel`	String!	Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company).
`parentLabel`	String!	Label shown for the parent side of the parent-child account relation (e.g. "Parent company").
`revision`	Int	Revision when entity was lastly changed.

DeleteParentAccountRelationTypeInput input clientMutationId: String, id: ID!

Id of the ParentAccountRelationType record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateParentAccountRelationTypeInput input 7 fields: clientMutationId, id, modified, …

Id of a ParentAccountRelationType record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`childLabel`	String	Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company).
`parentLabel`	String	Label shown for the parent side of the parent-child account relation (e.g. "Parent company").
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateParentAccountRelationTypePayload object result: BulkUpdateResults!

Result of the bulkUpdateParentAccountRelationType mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateParentAccountRelationTypePayload object parentAccountRelationType: ParentAccountRelationTypeEntity, clientMutationId: String

Result of the createParentAccountRelationType mutation.

Field	Type	Description
`parentAccountRelationType`	ParentAccountRelationTypeEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteParentAccountRelationTypePayload object parentAccountRelationType: ParentAccountRelationTypeEntity, clientMutationId: String

Result of the deleteParentAccountRelationType mutation.

Field	Type	Description
`parentAccountRelationType`	ParentAccountRelationTypeEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateParentAccountRelationTypePayload object parentAccountRelationType: ParentAccountRelationTypeEntity, clientMutationId: String

Result of the updateParentAccountRelationType mutation.

Field	Type	Description
`parentAccountRelationType`	ParentAccountRelationTypeEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).