GraphQL Repositoriescurrency

`entities.currency`

Read currency records with the currency repository, and change them with the currency mutations. Same records as the REST Currencies entity.

Example: first three currency recordsGraphQLcURL

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

Queries

Fields of entities { currency { … } }.

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.	CurrencyEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CurrencyEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CurrencyFilterInput, orderBy: [CurrencyOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CurrencyEntity!]!
QUERY	`getByCriteria`(filter: CurrencyFilterInput, orderBy: [CurrencyOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CurrencyEntityConnection
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!]!
QUERY	`getBase` Returns the base currency of the space, in which amounts are converted and reported.	CurrencyEntity!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createCurrency`(input: CreateCurrencyInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCurrencyPayload
MUTATION	`updateCurrency`(input: UpdateCurrencyInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCurrencyPayload
MUTATION	`bulkUpdateCurrency`(input: [CreateOrUpdateCurrencyInput!]!, deleteInput: [DeleteCurrencyInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCurrencyPayload
MUTATION	`deleteCurrency`(input: DeleteCurrencyInput!)	Soft-delete	DeleteCurrencyPayload

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.

CurrencyEntity object 11 fields: isDeleteProtected, id, isDeleted, …

Currency used for monetary values in the space, converted from the base currency by exchange rates.

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.
`code`	String!	Name of the entity and its default text representation.
`isBase`	Boolean	True for the space's base currency. There is exactly one base currency per space and it cannot be deleted.
`symbol`	String	Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI.
`revision`	Int	Revision when entity was lastly changed.
`currencyExchangeRates`	CurrencyExchangeRateEntityConnection (8 args)	Exchange rates configured for this currency, one per exchange rate list (effective period).
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

CurrencyEntityConnection object pageInfo: PageInfo!, edges: [CurrencyEntityEdge]!, totalCount: Int

Paginated list of Currency records.

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

CurrencyEntityEdge object node: CurrencyEntity, cursor: String!

A Relay edge containing a CurrencyEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[CurrencyFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CurrencyFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CurrencyFilterInput	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.
`code`	EntityFilterStringField	Name of the entity and its default text representation.
`isBase`	Boolean	True for the space's base currency. There is exactly one base currency per space and it cannot be deleted.
`symbol`	EntityFilterStringField	Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`currencyExchangeRates`	CurrencyExchangeRateFilterInput	Exchange rates configured for this currency, one per exchange rate list (effective period). Matches records where a related record meets these conditions.

CurrencyOrderByInput input Asc or Desc per field

Sorting of Currency 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.
`code`	OrderByEnum	Name of the entity and its default text representation.
`isBase`	OrderByEnum	True for the space's base currency. There is exactly one base currency per space and it cannot be deleted.
`symbol`	OrderByEnum	Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateCurrencyExchangeRateNoCurrencyBackrefInput input 5 fields: modified, created, currencyExchangeRateListId, …

Field values of a new CurrencyExchangeRate record, created together with the record it belongs to.

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`currencyExchangeRateListId`	ID!	Id of the exchange rate list (effective period) this rate belongs to.
`exchangeRate`	Float	Multiplier for converting an amount in the base currency into this currency. Must be greater than zero.
`revision`	Int	Revision when entity was lastly changed.

CreateCurrencyInput input 7 fields: clientMutationId, modified, created, …

Field values of a new Currency 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.
`code`	String!	Name of the entity and its default text representation.
`symbol`	String	Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI.
`revision`	Int	Revision when entity was lastly changed.
`currencyExchangeRates`	[CreateCurrencyExchangeRateNoCurrencyBackrefInput!]!	Exchange rates configured for this currency, one per exchange rate list (effective period).

CreateOrUpdateCurrencyInput input 8 fields: clientMutationId, id, modified, …

Field values of a Currency 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.
`code`	String	Name of the entity and its default text representation.
`symbol`	String	Display symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI.
`revision`	Int	Revision when entity was lastly changed.
`currencyExchangeRates`	[CreateCurrencyExchangeRateNoCurrencyBackrefInput!]	Exchange rates configured for this currency, one per exchange rate list (effective period).

DeleteCurrencyInput input clientMutationId: String, id: ID!

Id of the Currency 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.

UpdateCurrencyInput input 6 fields: clientMutationId, id, modified, …

Id of a Currency 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.
`revision`	Int	Revision when entity was lastly changed.
`currencyExchangeRates`	[CreateCurrencyExchangeRateNoCurrencyBackrefInput!]	Exchange rates configured for this currency, one per exchange rate list (effective period).

BulkUpdateCurrencyPayload object result: BulkUpdateResults!

Result of the bulkUpdateCurrency mutation.

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

CreateCurrencyPayload object currency: CurrencyEntity, clientMutationId: String

Result of the createCurrency mutation.

Field	Type	Description
`currency`	CurrencyEntity	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).

DeleteCurrencyPayload object currency: CurrencyEntity, clientMutationId: String

Result of the deleteCurrency mutation.

Field	Type	Description
`currency`	CurrencyEntity	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).

UpdateCurrencyPayload object currency: CurrencyEntity, clientMutationId: String

Result of the updateCurrency mutation.

Field	Type	Description
`currency`	CurrencyEntity	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).