For the complete documentation index, see llms.txt. This page is also available as Markdown.

Rate

The Rate object represents an exchange rate between two currencies.

This object contains the following attributes:

Field
Type
Description

id

string, core

(Read-only) The primary identifier for the rate.

pair

object, core

Represents the currency pair that this rate applies to.

externalId

string

The ID of the external system from where the rate is fetched.

recordDate

datetime

The date and time when this rate was fetched.

rate

number, core

The exchange rate from currency A to B.

status

string

Indicates whether the item is active or deleted.

audit

object

(Read-only) Represents the audit object.

revision

integer, core

The entity's revision number.

Example

RATE OBJECT
{
  "id": "FXR-1671-0642-0000",
  "pair": {
    "id": "FXP-1671-0642",
    "name": "EUR: GBP",
    "latestRate": {
      "rate": 0.88
    },
    "revision": 1
  },
  "externalId": "RATE-1234",
  "recordDate": "2024-05-09T14:40:28.958Z",
  "value": 1.1456,
  "status": "Active",
  "audit":{
    "created": {
      "at": "2024-04-08T06:30:05.807Z",
      "by": {
        "id": "USR-2172-2499",
        "revision": 1,
        "name": "John User"
      }
    },
    "updated": {
      "at": "2024-05-16T09:17:36.406Z",
      "by": {
        "id": "TKN-3836-7769",
        "revision": 1,
        "name": "My token"
      }
    },
    "deleted": {
      "at": "2024-05-17T09:17:36.406Z",
      "by": {
        "id": "TKN-3836-7769",
        "revision": 1,
        "name": "My token"
      }
    }
  },
  "revision": 1
}

Last updated

Was this helpful?