> For the complete documentation index, see [llms.txt](https://apis.rightrev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apis.rightrev.com/rightrev-rest-api/policy-sets/company-profile/currencies.md).

# Currencies

## Get Currency Policy

> Retrieves the currency details associated with a specific RightRev tenant.<br>

```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/currency":{"get":{"description":"Retrieves the currency details associated with a specific RightRev tenant.\n","responses":{"200":{"description":"Get Currency Policy","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID to retrieve the currencies."},"compliance_name":{"type":"string","description":"Name of the policy fetched by the system."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","description":"A boolean field indicating whether the currency is active or not. If set to True, the currency is active; if False, the currency is inactive."},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the currency can be deleted or not. If set to True, the user is allowed to delete the currency; if False, deletion is not permitted."},"code":{"type":"string","description":"A unique currency code."},"created_at":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"created_by":{"type":"string","description":"ID of the user who created the policy."},"currency_name":{"type":"string","description":"Name of the currency."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the currency is defined or not by the system. User is not permitted to define the currency."},"precision":{"type":"integer","description":"A numeric value which is used while distributing revenue. The precision can be different for each currency. This field refers to the number of digits used after the decimal point in a currency. Example: 0-9. Precision for USD is 2."},"threshold":{"type":"number","description":"System uses this value for rounding off differences in the internal calculations. This field accepts only positive decimal values. Example: 1.0, 2.3, etc. Threshold value for USD is 0.5."},"updated_at":{"type":"integer","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"updated_by":{"type":"string","description":"ID of the user who updated the policy."}}},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"created_by":{"type":"string","description":"ID of the user who created the policy."},"created_on":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"last_modified_by":{"type":"string","description":"ID of the user last modified by."},"last_modified_on":{"type":"integer","description":"Timestamp of the policy last modified on. This is a unix Epoch timestamp format."},"policy_type":{"type":"string","description":"Represents the type of policy."},"status":{"type":"string","description":"Represents the status of the policy."},"unique_key":{"type":"string","description":"Unique currency code generated by the system."},"version_id":{"type":"string","description":"Represents the latest version of the policy."}}}}}}}},"tags":["Policy Sets"],"summary":"Get Currency Policy","operationId":"get_currency_policy_apis_policy_sets_v1_policy_currency_get"}}}}
```

## Patch Currency Policy

> Update multiple currency precision and threshold for currencies.<br>

```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/currency/{compliance_id}":{"patch":{"description":"Update multiple currency precision and threshold for currencies.\n","parameters":[{"name":"compliance_id","in":"path","required":true,"schema":{"type":"string","title":"Compliance Id"},"description":"User has to provide a compliance id to update currency precision / threshold or both. This compliance id can be fetched from the response of the **Currency Policy - GET** API.\n"}],"responses":{"200":{"description":"Update Currency Policy","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_details":{"type":"array","items":{"type":"object","properties":{"error":{"type":"array","description":"Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing."},"message":{"type":"string","description":"Displays the outcome of the action. It is commonly used to provide success confirmations, error details, or other informational responses from the API after the operation is executed."},"unique_key":{"type":"string","description":"Displays unique currency code."}}},"description":"A list of compliance-related entries, each providing detailed information about the outcome of a specific compliance check. This includes messages, associated errors, and a system-generated unique identifier for tracking."},"compliance_id":{"type":"string","description":"A system-generated compliance ID to update currencies."},"error":{"type":"array","description":"Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing."}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"compliance_name":{"type":"string","description":"Name of the policy."},"unique_key":{"type":"string","description":"Unique currency code."},"format_type":{"type":"string","description":"format of the payload. For e.g. JSON"},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Unique currency code generated by the system."},"currency_name":{"type":"string","description":"Name of the currency."},"precision":{"type":"number","description":"A numeric value which is used while distributing revenue. The precision can be different for each currency. This field refers to the number of digits used after the decimal point in a currency. Example: 0-9. Precision for USD is 2."},"threshold":{"type":"number","description":"System uses this value for rounding off differences in the internal calculations. This field accepts only positive decimal values. Example: 1.0, 2.3, etc. Threshold value for USD is 0.5."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the currency is defined or not by the system. User is not permitted to define the currency."},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the currency can be deleted or not. If set to True, the user is allowed to delete the currency; if False, deletion is not permitted."},"active":{"type":"boolean","description":"A boolean field indicating whether the currency is active or not. If set to True, the currency is active; if False, the currency is inactive."}},"required":["active","can_delete","code","currency_name","is_user_defined","precision","threshold"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."}},"required":["compliance_name","compliance_spec","format_type","unique_key"]}}},"required":true},"tags":["Policy Sets"],"summary":"Patch Currency Policy","operationId":"patch_currency_policy_apis_policy_sets_v1_policy_currency__compliance_id__patch"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apis.rightrev.com/rightrev-rest-api/policy-sets/company-profile/currencies.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
