---
updatedAt: 2026-06-12T14:08:37.000Z
agentTools:
  projectIndex: https://developer.crunchtime.com/llms.txt
---

# getAllCurrencyRatio

Retrieve a single currency exchange rate.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger documentation supporting mobile development of Crunchtime.",
    "version": "2.99",
    "title": "Inventory & Labor",
    "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": {
    "/currencyratio/v1/getAllCurrencyRatio": {
      "get": {
        "tags": [
          "Currency Ratio Service"
        ],
        "summary": "getAllCurrencyRatio",
        "description": "Retrieve a single currency exchange rate.",
        "operationId": "getAllCurrencyRatioV1UsingGET",
        "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": "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"
            }
          },
          {
            "name": "includeNull",
            "in": "query",
            "description": "Specify 'true' to output null data elements.",
            "required": false,
            "allowEmptyValue": true,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "*/*": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CurrencyRatioDetails"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CurrencyRatioDetails"
                  }
                }
              }
            }
          },
          "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"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "500": {
            "description": "Unexpected Error",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "503": {
            "description": "System under maintenance",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "504": {
            "description": "Timeout",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "description": "Crunchtime Developer Hub",
    "url": "https://developer.crunchtime.com/"
  },
  "servers": [
    {
      "url": "//webservices-test.net-chef.com"
    }
  ],
  "components": {
    "schemas": {
      "CurrencyRatioDetails": {
        "type": "object",
        "properties": {
          "currencyRatioDetailDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CurrencyRatioDetailsDto"
            }
          }
        },
        "title": "CurrencyRatioDetails",
        "description": "CurrencyRatioDetails description"
      },
      "CurrencyRatioDetailsDto": {
        "type": "object",
        "required": [
          "exchangeRate",
          "fromCurrencyCode",
          "toCurrencyCode"
        ],
        "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"
      },
      "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"
      }
    }
  }
}
```