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 Name	Data Type	Description
id	string	The primary identifier for the currency. Example: CUR-1234-4678
externalId	string	The identifier within the external system. Example: EXCH-1234
name	string	The currency name auto-generated using the ISO codes of both currencies. Example: USD > EUR
source	object	A reference to the source currency. Example: { "id": "CUR-1234-0000"}
destination	object	A reference to the currency currency. Example: { "id": "CUR-1456-0000"}
notes	string	The optional text that was provided when creating the rate. Example: "Represents the exchange rate between USD and EUR."
latestRate	rate	The rate of exchange from source to destination. Example: 0.8723
updatedAt	datetime	The date when the rate was last updated. Example: 2024-04-08T06:30:05.807Z
agreements	integer	The number of agreements currently using this pair. Example: 34
status	string	Indicates whether the item is active or deleted.
audit	object	A reference to the audit object. Example: { "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" } } } "id": "FXP-0000-0002", "name": "USD: EUR", "revision": 1, "latestRate": { "id": "FXR-1234-8909", "rate": "0.1", "revision": 1 } } }
primary	bool	Indicates if the pair is primary. Example: true
reverse	pair	Indicates reverse pair. Example: { "reverse": { "id": "FXP-0000-0002", "name": "USD:EUR", "revision": 1, "latestRate": { "id": "FXR-1234-8909", "rate": "0.1", "revision": 1 } } }
revision	integer	The entity revision number. Example: 3

Example response

{
  "$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"
    }
  ]
}