---
title: entities.customEntitySharingSalesUnitRelation
description: Read custom entity sharing sales unit relation records with the customEntitySharingSalesUnitRelation repository, and change them with the custom entity sharing sales unit relation mutations.
canonical: https://developers.coevera.com/reference/graphql/custom-entity-sharing-sales-unit-relation/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.customEntitySharingSalesUnitRelation

Read custom entity sharing sales unit relation records with the customEntitySharingSalesUnitRelation repository, and change them with the custom entity sharing sales unit relation mutations.

## Queries

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

## Mutations

- `createCustomEntitySharingSalesUnitRelation(input: CreateCustomEntitySharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!]): CreateCustomEntitySharingSalesUnitRelationPayload` Create one record.
- `updateCustomEntitySharingSalesUnitRelation(input: UpdateCustomEntitySharingSalesUnitRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateCustomEntitySharingSalesUnitRelationPayload` Update fields.
- `bulkUpdateCustomEntitySharingSalesUnitRelation(input: [CreateOrUpdateCustomEntitySharingSalesUnitRelationInput!]!, deleteInput: [DeleteCustomEntitySharingSalesUnitRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateCustomEntitySharingSalesUnitRelationPayload` Create or update many; per-item results.
- `deleteCustomEntitySharingSalesUnitRelation(input: DeleteCustomEntitySharingSalesUnitRelationInput!): DeleteCustomEntitySharingSalesUnitRelationPayload` Soft-delete.

## Types

### CustomEntitySharingSalesUnitRelationEntity (object)

Sharing of a custom entity record with a sales unit, as a watcher or an editor.

- `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.
- `customEntity: CustomEntityEntity` Custom entity record being shared.
- `unit: SalesUnitEntity` Sales unit the custom entity record is shared with.
- `customEntityId: ID!` Id of the shared custom entity record.
- `role: SharingRoleEnum` Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
- `unitId: ID!` Id of the sales unit.
- `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.

### CustomEntitySharingSalesUnitRelationEntityConnection (object)

Paginated list of CustomEntitySharingSalesUnitRelation records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [CustomEntitySharingSalesUnitRelationEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### CustomEntitySharingSalesUnitRelationEntityEdge (object)

A Relay edge containing a `CustomEntitySharingSalesUnitRelationEntity` and its cursor.

- `node: CustomEntitySharingSalesUnitRelationEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### CustomEntitySharingSalesUnitRelationFilterInput (input)

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

- `OR: [CustomEntitySharingSalesUnitRelationFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [CustomEntitySharingSalesUnitRelationFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: CustomEntitySharingSalesUnitRelationFilterInput` 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.
- `customEntityId: EntityFilterStringField` Id of the shared custom entity record.
- `role: SharingRoleEnumFilterInput` Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
- `unitId: EntityFilterStringField` Id of the sales unit.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `customEntity: CustomEntityFilterInput` Custom entity record being shared. Matches records where a related record meets these conditions.
- `unit: SalesUnitFilterInput` Sales unit the custom entity record is shared with. Matches records where a related record meets these conditions.

### CustomEntitySharingSalesUnitRelationOrderByInput (input)

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

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `customEntity: [CustomEntityOrderByNestedInput!]` Custom entity record being shared. Sorts by fields of the related record, listed in order of priority.
- `unit: [SalesUnitOrderByNestedInput!]` Sales unit the custom entity record is shared with. Sorts by fields of the related record, listed in order of priority.
- `customEntityId: OrderByEnum` Id of the shared custom entity record.
- `role: OrderByEnum` Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
- `unitId: OrderByEnum` Id of the sales unit.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateCustomEntitySharingSalesUnitRelationInput (input)

Field values of a new CustomEntitySharingSalesUnitRelation 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).
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `customEntityId: ID!` Id of the shared custom entity record.
- `role: SharingRoleEnum` Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
- `unitId: ID!` Id of the sales unit.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateCustomEntitySharingSalesUnitRelationInput (input)

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

- `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.
- `customEntityId: ID` Id of the shared custom entity record.
- `role: SharingRoleEnum` Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
- `unitId: ID` Id of the sales unit.
- `revision: Int` Revision when entity was lastly changed.

### DeleteCustomEntitySharingSalesUnitRelationInput (input)

Id of the CustomEntitySharingSalesUnitRelation record to delete.

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

### UpdateCustomEntitySharingSalesUnitRelationInput (input)

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

- `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.
- `customEntityId: ID` Id of the shared custom entity record.
- `role: SharingRoleEnum` Access the sharing gives the sales unit on the custom entity record: Watcher can view it, Editor can view and edit it.
- `unitId: ID` Id of the sales unit.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateCustomEntitySharingSalesUnitRelationPayload (object)

Result of the bulkUpdateCustomEntitySharingSalesUnitRelation mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateCustomEntitySharingSalesUnitRelationPayload (object)

Result of the createCustomEntitySharingSalesUnitRelation mutation.

- `customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationEntity` 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).

### DeleteCustomEntitySharingSalesUnitRelationPayload (object)

Result of the deleteCustomEntitySharingSalesUnitRelation mutation.

- `customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationEntity` 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).

### UpdateCustomEntitySharingSalesUnitRelationPayload (object)

Result of the updateCustomEntitySharingSalesUnitRelation mutation.

- `customEntitySharingSalesUnitRelation: CustomEntitySharingSalesUnitRelationEntity` 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).

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstCustomEntitySharingSalesUnitRelations {
  entities {
    customEntitySharingSalesUnitRelation {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}
```

```bash
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 FirstCustomEntitySharingSalesUnitRelations { entities { customEntitySharingSalesUnitRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'
```
