---
updatedAt: 2026-06-04T15:17:01.000Z
agentTools:
  projectIndex: https://developer.crunchtime.com/llms.txt
---

# getCurrencyRatioByPage

getCurrencyRatioByPage

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger documentation supporting mobile development of Crunchtime.",
    "version": "3.05",
    "title": "Cruise Platform",
    "termsOfService": "http://springfox.io",
    "contact": {
      "name": "Crunchtime Development Team",
      "url": "http://www.crunchtime.com",
      "email": "apiquestions@crunchtime.com"
    },
    "license": {
      "name": "Apache License Version 2.0",
      "url": "https://github.com/springfox/springfox/blob/master/LICENSE"
    }
  },
  "tags": [
    {
      "name": "Currency Ratio Service",
      "description": "The Currency Ratios Service is used to enter the exchange rates that will to convert monetary values from one currency to another. The \"toCurrencyCode\" is equal to the base currency in Enterprise Manager, then enter the exchange rate to convert the \"fromCurrencyCode\" to that base currency. \n**Note**: A Currency Ratio cannot be established until that Currency has been configured as the base currency for a location, vendor, or market."
    }
  ],
  "paths": {
    "/cruise/currencyratio/v1/getCurrencyRatioByPage": {
      "get": {
        "tags": [
          "Currency Ratio Service"
        ],
        "summary": "getCurrencyRatioByPage",
        "description": "getCurrencyRatioByPage",
        "operationId": "getCurrencyRatioByPageV1UsingGET_1",
        "parameters": [
          {
            "name": "authenticationtoken",
            "in": "header",
            "description": "Secure token for API authentication.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromCurrencyCode",
            "in": "query",
            "description": "The alternate currency code.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeNull",
            "in": "query",
            "description": "Specify 'true' to output null data elements.",
            "required": false,
            "allowEmptyValue": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "pageNumber",
            "in": "query",
            "description": "Retrieve one or more records by `pageNumber`. \n Use to retrieve data in smaller chunks. \n If left blank, the default is `1`.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          },
          {
            "name": "password",
            "in": "header",
            "description": "Password for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sitename",
            "in": "header",
            "description": "Crunchtime site identifier. test or production",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "toCurrencyCode",
            "in": "query",
            "description": "The base currency code.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "userid",
            "in": "header",
            "description": "User ID for the Crunchtime Application User.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-B3-TraceId",
            "in": "header",
            "description": "Optional trace identifier for troubleshooting.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/CurrencyRatioBatchResponseDto"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurrencyRatioBatchResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Validation Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ObjectError"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authorization",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "currency Ratio not found",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "504": {
            "description": "Timeout",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "description": "Using CrunchTime APIs Documentation",
    "url": "https://links.crunchtime.com/SG-UsingCrunchtimeAPIs?pd01=api"
  },
  "servers": [
    {
      "url": "//webservices-test.net-chef.com"
    }
  ],
  "components": {
    "schemas": {
      "ObjectError": {
        "type": "object",
        "properties": {
          "arguments": {
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "code": {
            "type": "string"
          },
          "codes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "defaultMessage": {
            "type": "string"
          },
          "objectName": {
            "type": "string"
          }
        },
        "title": "ObjectError"
      },
      "CurrencyRatioBatchResponseDto": {
        "type": "object",
        "properties": {
          "currencyRatioDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CurrencyRatioDetails"
            }
          },
          "hasNext": {
            "type": "boolean"
          },
          "totalPages": {
            "type": "integer",
            "format": "int32"
          }
        },
        "title": "CurrencyRatioBatchResponseDto",
        "description": "CurrencyRatioBatchResponseDto description"
      },
      "CurrencyRatioDetails": {
        "type": "object",
        "properties": {
          "currencyRatioDetailDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CurrencyRatioDetailsDto"
            }
          }
        },
        "title": "CurrencyRatioDetails",
        "description": "CurrencyRatioDetails description"
      },
      "CurrencyRatioDetailsDto": {
        "type": "object",
        "required": [
          "fromCurrencyCode",
          "toCurrencyCode",
          "toFactor"
        ],
        "properties": {
          "exchangeRate": {
            "type": "number",
            "example": 32.9,
            "description": "\"Exchange Rate\" from Currency Ratio"
          },
          "fromCurrencyCode": {
            "type": "string",
            "example": "USD",
            "description": "\"From Currency\" Code from Currency Ratio"
          },
          "fromFactor": {
            "type": "integer",
            "format": "int64",
            "description": "\"From\" Factor from Currency Ratio"
          },
          "toCurrencyCode": {
            "type": "string",
            "example": "EUR",
            "description": "\"To Currency\" Code from Currency Ratio"
          },
          "toFactor": {
            "type": "integer",
            "format": "int64",
            "description": "\"To\" Factor from Currency Ratio"
          }
        },
        "title": "CurrencyRatioDetailsDto",
        "description": "CurrencyRatioDetailsDto description"
      }
    }
  }
}
```