Pair

The Pair object represents an exchange rate between two currencies, used by one or more sellers in our system to invoice their products.

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) The primary identifier for the currency.
externalId	string	(Optional) The identifier within the external system.
name	string, core	(Read-only) User‑friendly name. Auto‑generated from the ISO codes of both currencies.
source	object	Represents the source currency object.
destination	object	Represents the destination currency object.
notes	string	The optional text that was provided when creating the rate.
latestRate	rate, core	The rate of exchange from source to destination.
updatedAt	datetime	The date when the rate was last updated.
agreements	integer	(Read-only) Number of agreements currently using this pair.
status	string	Indicates whether the item is active or deleted.
audit	object	(Read-only) Represents the audit object.
primary	bool	(Read-only) Indicates if the pair is primary.
reverse	pair	(Read-only) Indicates reverse pair.
revision	integer, core	The entity's revision number.

Example

PAIR OBJECT

{
  "$meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 261
    },
    "omitted": [
      "audit"
    ]
  },
  "data": [
    {
      "id": "FXP-0000-0001",
      "name": "EUR: USD",
      "revision": 1,
      "externalId": "EXT-1234",
      "notes": "notes",
      "source": {
        "id": "CUR-1234",
        "name": "Euro",
        "code": "EUR",
        "revision": 1
      },
      "destination": {
        "id": "CUR-2345",
        "name": "Dollar",
        "code": "USD",
        "revision": 1
      },
      "latestRate": {
        "id": "FXR-1234-8907",
        "rate": "4.23658350000",
        "revision": 1
      },
      "primary": "true",
      "reverse": {
        "id": "FXP-0000-0002",
        "name": "USD: EUR",
        "revision": 1,
        "latestRate": {
          "id": "FXR-1234-8909",
          "rate": "0.1",
          "revision": 1
        }
      },
      "agreements": 0,
      "status": "Active"
    }
  ]
}