GraphQL RepositoriescurrencyExchangeRate

`entities.currencyExchangeRate`

Read currency exchange rate records with the currencyExchangeRate repository, and change them with the currency exchange rate mutations. Same records as the REST CurrencyExchangeRates entity.

Example: first three currency exchange rate recordsGraphQLcURL

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

Queries

Fields of entities { currencyExchangeRate { … } }.

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.	CurrencyExchangeRateEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CurrencyExchangeRateEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CurrencyExchangeRateFilterInput, orderBy: [CurrencyExchangeRateOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CurrencyExchangeRateEntity!]!
QUERY	`getByCriteria`(filter: CurrencyExchangeRateFilterInput, orderBy: [CurrencyExchangeRateOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CurrencyExchangeRateEntityConnection
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	`createCurrencyExchangeRate`(input: CreateCurrencyExchangeRateInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCurrencyExchangeRatePayload
MUTATION	`updateCurrencyExchangeRate`(input: UpdateCurrencyExchangeRateInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCurrencyExchangeRatePayload
MUTATION	`bulkUpdateCurrencyExchangeRate`(input: [CreateOrUpdateCurrencyExchangeRateInput!]!, deleteInput: [DeleteCurrencyExchangeRateInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCurrencyExchangeRatePayload
MUTATION	`deleteCurrencyExchangeRate`(input: DeleteCurrencyExchangeRateInput!)	Soft-delete	DeleteCurrencyExchangeRatePayload

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.

CurrencyExchangeRateEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Exchange rate of a currency against the base currency within an exchange rate list.

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.
`currencyExchangeRateList`	CurrencyExchangeRatesListEntity	Effective period (exchange rate list) this rate belongs to.
`currency`	CurrencyEntity	Currency the exchange rate applies to. Cannot be the base currency.
`currencyExchangeRateListId`	ID!	Id of the exchange rate list (effective period) this rate belongs to.
`currencyId`	ID!	Id of the currency the exchange rate applies to. Cannot be the base currency.
`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.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

CurrencyExchangeRateEntityConnection object pageInfo: PageInfo!, edges: [CurrencyExchangeRateEntityEdge]!, totalCount: Int

Paginated list of CurrencyExchangeRate records.

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

CurrencyExchangeRateEntityEdge object node: CurrencyExchangeRateEntity, cursor: String!

A Relay edge containing a CurrencyExchangeRateEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[CurrencyExchangeRateFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CurrencyExchangeRateFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CurrencyExchangeRateFilterInput	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.
`currencyExchangeRateListId`	EntityFilterStringField	Id of the exchange rate list (effective period) this rate belongs to.
`currencyId`	EntityFilterStringField	Id of the currency the exchange rate applies to. Cannot be the base currency.
`exchangeRate`	EntityFilterNumberField	Multiplier for converting an amount in the base currency into this currency. Must be greater than zero.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`currencyExchangeRateList`	CurrencyExchangeRatesListFilterInput	Effective period (exchange rate list) this rate belongs to. Matches records where a related record meets these conditions.
`currency`	CurrencyFilterInput	Currency the exchange rate applies to. Cannot be the base currency. Matches records where a related record meets these conditions.

CurrencyExchangeRateOrderByInput input Asc or Desc per field

Sorting of CurrencyExchangeRate 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.
`currencyExchangeRateList`	[CurrencyExchangeRatesListOrderByNestedInput!]	Effective period (exchange rate list) this rate belongs to. Sorts by fields of the related record, listed in order of priority.
`currency`	[CurrencyOrderByNestedInput!]	Currency the exchange rate applies to. Cannot be the base currency. Sorts by fields of the related record, listed in order of priority.
`currencyExchangeRateListId`	OrderByEnum	Id of the exchange rate list (effective period) this rate belongs to.
`currencyId`	OrderByEnum	Id of the currency the exchange rate applies to. Cannot be the base currency.
`exchangeRate`	OrderByEnum	Multiplier for converting an amount in the base currency into this currency. Must be greater than zero.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new CurrencyExchangeRate 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.
`currencyExchangeRateListId`	ID!	Id of the exchange rate list (effective period) this rate belongs to.
`currencyId`	ID!	Id of the currency the exchange rate applies to. Cannot be the base currency.
`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.

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

Field values of a CurrencyExchangeRate 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.
`currencyExchangeRateListId`	ID	Id of the exchange rate list (effective period) this rate belongs to.
`currencyId`	ID	Id of the currency the exchange rate applies to. Cannot be the base currency.
`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.

DeleteCurrencyExchangeRateInput input clientMutationId: String, id: ID!

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

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

Id of a CurrencyExchangeRate 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.
`currencyExchangeRateListId`	ID	Id of the exchange rate list (effective period) this rate belongs to.
`currencyId`	ID	Id of the currency the exchange rate applies to. Cannot be the base currency.
`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.

BulkUpdateCurrencyExchangeRatePayload object result: BulkUpdateResults!

Result of the bulkUpdateCurrencyExchangeRate mutation.

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

CreateCurrencyExchangeRatePayload object currencyExchangeRate: CurrencyExchangeRateEntity, clientMutationId: String

Result of the createCurrencyExchangeRate mutation.

Field	Type	Description
`currencyExchangeRate`	CurrencyExchangeRateEntity	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).

DeleteCurrencyExchangeRatePayload object currencyExchangeRate: CurrencyExchangeRateEntity, clientMutationId: String

Result of the deleteCurrencyExchangeRate mutation.

Field	Type	Description
`currencyExchangeRate`	CurrencyExchangeRateEntity	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).

UpdateCurrencyExchangeRatePayload object currencyExchangeRate: CurrencyExchangeRateEntity, clientMutationId: String

Result of the updateCurrencyExchangeRate mutation.

Field	Type	Description
`currencyExchangeRate`	CurrencyExchangeRateEntity	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).