Skip to main content

TenantExchangeRate

One of the organization's own dated exchange rates. The rate is an exact decimal string meaning 1 unit of the foreign currency equals the rate in the base currency.

type TenantExchangeRate {
  createdAt: DateTime!
  effectiveFrom: DateTime!
  effectiveTo: DateTime
  fromCurrency: String!
  id: ID!
  note: String
  rate: String!
  status: String!
  toCurrency: String!
}

Fields​

TenantExchangeRate.createdAt ● DateTime! non-null scalar​

When the record was created.

TenantExchangeRate.effectiveFrom ● DateTime! non-null scalar​

When the rate starts to apply.

TenantExchangeRate.effectiveTo ● DateTime scalar​

Exclusive end; null = in force until replaced or ended

TenantExchangeRate.fromCurrency ● String! non-null scalar​

The currency being converted from.

TenantExchangeRate.id ● ID! non-null scalar​

The unique ID of this record.

TenantExchangeRate.note ● String scalar​

A note on why the rate was set.

TenantExchangeRate.rate ● String! non-null scalar​

Exact decimal, e.g. "20.12345"

TenantExchangeRate.status ● String! non-null scalar​

IN_FORCE (what new documents use now) | SUPERSEDED (in its window but a later-starting rate wins) | SCHEDULED | ENDED | WITHDRAWN (a scheduled rate removed before it applied; only ever returned by endTenantExchangeRate)

TenantExchangeRate.toCurrency ● String! non-null scalar​

The organization's base currency.

Returned By​

createTenantExchangeRate mutation ● endTenantExchangeRate mutation

Member Of​

TenantExchangeRatePair object ● TenantExchangeRateSettings object