GraphQL RepositoriescurrencyExchangeRatesList

`entities.currencyExchangeRatesList`

Read currency exchange rates list records with the currencyExchangeRatesList repository, and change them with the currency exchange rates list mutations. Same records as the REST CurrencyExchangeRatesLists entity.

Example: first three currency exchange rates list recordsGraphQLcURL

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

Queries

Fields of entities { currencyExchangeRatesList { … } }.

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.	CurrencyExchangeRatesListEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CurrencyExchangeRatesListEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CurrencyExchangeRatesListFilterInput, orderBy: [CurrencyExchangeRatesListOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CurrencyExchangeRatesListEntity!]!
QUERY	`getByCriteria`(filter: CurrencyExchangeRatesListFilterInput, orderBy: [CurrencyExchangeRatesListOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CurrencyExchangeRatesListEntityConnection
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	`createCurrencyExchangeRatesList`(input: CreateCurrencyExchangeRatesListInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCurrencyExchangeRatesListPayload
MUTATION	`updateCurrencyExchangeRatesList`(input: UpdateCurrencyExchangeRatesListInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String, updateCurrencyFields: Boolean)	Update fields	UpdateCurrencyExchangeRatesListPayload
MUTATION	`bulkUpdateCurrencyExchangeRatesList`(input: [CreateOrUpdateCurrencyExchangeRatesListInput!]!, deleteInput: [DeleteCurrencyExchangeRatesListInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCurrencyExchangeRatesListPayload
MUTATION	`deleteCurrencyExchangeRatesList`(input: DeleteCurrencyExchangeRatesListInput!)	Soft-delete	DeleteCurrencyExchangeRatesListPayload

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.

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

Set of exchange rates, one per currency, that applies from a given date until the next list takes effect.

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.
`validFrom`	DateTime!	Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set.
`revision`	Int	Revision when entity was lastly changed.
`currencyExchangeRates`	CurrencyExchangeRateEntityConnection (8 args)	Exchange rates configured in this list — one row per non-base currency in the space.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

CurrencyExchangeRatesListEntityConnection object pageInfo: PageInfo!, edges: [CurrencyExchangeRatesListEntityEdge]!, totalCount: Int

Paginated list of CurrencyExchangeRatesList records.

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

CurrencyExchangeRatesListEntityEdge object node: CurrencyExchangeRatesListEntity, cursor: String!

A Relay edge containing a CurrencyExchangeRatesListEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[CurrencyExchangeRatesListFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CurrencyExchangeRatesListFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CurrencyExchangeRatesListFilterInput	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.
`validFrom`	EntityFilterDateTimeField	Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`currencyExchangeRates`	CurrencyExchangeRateFilterInput	Exchange rates configured in this list — one row per non-base currency in the space. Matches records where a related record meets these conditions.

CurrencyExchangeRatesListOrderByInput input Asc or Desc per field

Sorting of CurrencyExchangeRatesList 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.
`validFrom`	OrderByEnum	Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateCurrencyExchangeRateNoCurrencyExchangeRateListBackrefInput input 5 fields: modified, created, currencyId, …

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

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

Field values of a new CurrencyExchangeRatesList 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.
`validFrom`	DateTime!	Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set.
`revision`	Int	Revision when entity was lastly changed.
`currencyExchangeRates`	[CreateCurrencyExchangeRateNoCurrencyExchangeRateListBackrefInput!]!	Exchange rates configured in this list — one row per non-base currency in the space.

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

Field values of a CurrencyExchangeRatesList 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.
`validFrom`	DateTime	Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set.
`revision`	Int	Revision when entity was lastly changed.
`currencyExchangeRates`	[CreateCurrencyExchangeRateNoCurrencyExchangeRateListBackrefInput!]	Exchange rates configured in this list — one row per non-base currency in the space.

DeleteCurrencyExchangeRatesListInput input clientMutationId: String, id: ID!

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

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

Id of a CurrencyExchangeRatesList 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.
`validFrom`	DateTime	Date the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set.
`revision`	Int	Revision when entity was lastly changed.
`currencyExchangeRates`	[CreateCurrencyExchangeRateNoCurrencyExchangeRateListBackrefInput!]	Exchange rates configured in this list — one row per non-base currency in the space.

BulkUpdateCurrencyExchangeRatesListPayload object result: BulkUpdateResults!

Result of the bulkUpdateCurrencyExchangeRatesList mutation.

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

CreateCurrencyExchangeRatesListPayload object currencyExchangeRatesList: CurrencyExchangeRatesListEntity, clientMutationId: String

Result of the createCurrencyExchangeRatesList mutation.

Field	Type	Description
`currencyExchangeRatesList`	CurrencyExchangeRatesListEntity	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).

DeleteCurrencyExchangeRatesListPayload object currencyExchangeRatesList: CurrencyExchangeRatesListEntity, clientMutationId: String

Result of the deleteCurrencyExchangeRatesList mutation.

Field	Type	Description
`currencyExchangeRatesList`	CurrencyExchangeRatesListEntity	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).

UpdateCurrencyExchangeRatesListPayload object currencyExchangeRatesList: CurrencyExchangeRatesListEntity, clientMutationId: String

Result of the updateCurrencyExchangeRatesList mutation.

Field	Type	Description
`currencyExchangeRatesList`	CurrencyExchangeRatesListEntity	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).