> 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/configuration/tenant-configuration.md).
# Tenant Configuration
## Get Tenant Config Policy
> Retrieves the tenant configuration details associated with a specific RightRev tenant.
```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/tenant-configurations":{"get":{"description":"Retrieves the tenant configuration details associated with a specific RightRev tenant.\n","responses":{"200":{"description":"Get Tenant Configuration Policy","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID to retrieve the tenant configuration policy."},"compliance_name":{"type":"string","description":"Displays the policy name."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"account_segment_delimiter":{"type":"null","description":"Displays the symbol (- , | , ~ , # , : , . , $) that separates the account segments."},"ar_accounting":{"type":"boolean","description":"A boolean field indicating whether AR accounting entries exist or not. If set to True, the accounting entries are generated; if False, the accounting entries are not generated."},"augment_currency_rates":{"type":"boolean","description":"A boolean field indicating whether the system applies additional or enhanced currency exchange rate logic or not. If set to True, an enhanced currency exchange rate logic is applied; if False, an enhanced currency exchange rate logic is not applied."},"bundle_functionality":{"type":"boolean","description":"A boolean field indicating whether bundling feature is enabled or not. If set to True, the bundling feature is enabled; if False, the bundling feature is not enabled."},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the tenant configuration policy can be deleted or not. If set to True, the user is allowed to delete the tenant configuration policy; if False, deletion is not permitted."},"carves_allocation":{"type":"boolean","description":"A boolean field indicating whether carves allocation is enabled or not. If set to True, the carves allocation is enabled; if False, the carves allocation is not enabled."},"contract_asset_journal_method":{"type":"null","description":"Displays the method to generate the journal entries for contract assets."},"contract_asset_segment":{"type":"null","description":"An accounting segment where the contract asset transactions are maintained."},"cost_enabled":{"type":"boolean","description":"A boolean field indicating whether the system should calculate the cost for the transactions. If set to True, the system calculates the cost for the transactions; if False, the cost for the transactions will not be calculated by the system."},"cost_practical_expedient":{"type":"null","description":"Displays the value in # of months. Default Value is 12."},"create_revenue_schedules":{"type":"boolean","description":"A boolean field indicating whether the system creates a revenue schedules for the revenue contracts to recognize revenue or not. If set to True, the system creates a revenue schedule for the revenue contracts to recognize revenue; if False, the system will not create a revenue schedule for the revenue contracts to recognize revenue."},"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."},"distribution_method":{"type":"string","description":"Displays the method to perform revenue distribution on the transaction lines. The methods are Days in Calendar Period & Prorate."},"egress_hold":{"type":"boolean","description":"A boolean field indicating whether the system can transfer the journals or not when it is on hold. If set to True, the system cannot transfer the journals on hold; if False, the system can transfer the journals."},"fx_adjustment_method":{"type":"null","description":"Using the Foreign Exchange Adjustment method, the Foreign Exchange Adjustment entries are created in the system."},"fx_adjustments":{"type":"boolean","description":"Displays whether the system creates the Foreign Exchange Adjustments entries for all eligible transactions or not. If set to True, the system creates the Foreign Exchange Adjustments entries for all eligible transactions; if False, the system will not create the Foreign Exchange Adjustments entries for all eligible transactions."},"guid":{"type":"string","description":"Globally unique identifier generated by the system."},"ingest_hold":{"type":"boolean","description":"A boolean field indicating whether the transaction lines are put on hold or not. If set to True, then the transaction lines are put on hold; if False, the transaction lines are not put on hold."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the tenant configuration policy is defined by the user or not. If set to True, the user is allowed to define the tenant configuration policy; if False, defining the tenant configuration policy is not permitted."},"journal_details_egress":{"type":"boolean","description":"A boolean field indicating whether the Journal details for the journal batch will not be displayed in the journal run or not. If set to True, the Journal details for the journal batch will be displayed in the journal run; if False, the Journal details for the journal batch will not be displayed in the journal run."},"journal_transfer_by_ofid":{"type":"boolean","description":"A boolean field indicating whether the journal entries are transferred based on the order financial id or not. If set to True, the journal entries are transferred based on the order financial id; if False, the journal entries are not transferred based on the order financial id."},"journals_run_currency":{"type":"string","description":"Displays the currency in which the journal run is processed."},"lt_st_accounting":{"type":"boolean","description":"A boolean field indicating whether the system separates the accounts for long-term and short-term portions of contractual revenue / liabilities or not. If set to True, the system separates the accounts for long-term and short-term portions; if False, the system will not separate the accounts for long-term and short-term."},"manual_journal":{"type":"boolean","description":"A boolean field indicating whether the manual journal functionality can be used or not. If set to True, the manual journal functionality can be used; if False, the manual journal functionality cannot be used."},"manual_journal_contra_account":{"type":"string","description":"An alphanumeric value provided by the user which will get recorded when Manual Journal Entries are created."},"multi_currency_revenue_contracts":{"type":"boolean","description":"A boolean field that allows revenue contracts to have multiple transaction currencies. If set to True, carves allocations will be performed only in functional currency; if False, system will group revenue contracts based on transaction currency and perform carve allocations in transaction currency."},"prorate_method":{"type":"string","description":"System performs revenue distribution evenly across the number of periods except the first and last which is based on the Partial Revenue Start and End date."},"rc_activities_egress":{"type":"boolean","description":"A boolean field indicating whether the Revenue Contract Activities details for the Revenue Contract will be displayed in the Revenue Contract Line or not. If set to True, the Revenue Contract Activities details for the Revenue Contract will be displayed in the Revenue Contract Line; if False, the Revenue Contract Activities details for the Revenue Contract will not be displayed in the Revenue Contract Line."},"rc_distributions_egress":{"type":"boolean","description":"A boolean field indicating whether the Revenue Contract Distribution details for the Revenue Contract will be displayed in the Revenue Contract or not. If set to True, the Revenue Contract Distribution details for the Revenue Contract will be displayed in the Revenue Contract; if False, the Revenue Contract Distribution details for the Revenue Contract will not be displayed in the Revenue Contract."},"reprocess_existing_ofid":{"type":"boolean","description":"A boolean field indicating whether the system reprocess the transactions for existing order financial id or not. If set to True, the system reprocess the transactions for existing order financial id; if False, the system will not reprocess the transactions for existing order financial id."},"sfdc_multicurrorg_enabled":{"type":"boolean","description":"A boolean field indicating whether the Salesforce multi currency org is enabled for the tenant or not. If set to True, the Salesforce multi currency org is enabled for the tenant; if False, the Salesforce multi currency org is not enabled for the tenant."},"snowman_enabled":{"type":"boolean","description":"A boolean field indicating whether the tenant is snowman enabled or not. If set to True, the tenant is snowman enabled; if False, the tenant is not snowman enabled."},"ui_mode":{"type":"string","description":"Displays which user interface is active for the tenant."},"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 key is GUID, which is a global unique identifier generated by the system."},"version_id":{"type":"string","description":"Represents the latest version of the policy."}}}}}}}},"tags":["Policy Sets"],"summary":"Get Tenant Config Policy","operationId":"get_tenant_config_policy_apis_policy_sets_v1_policy_tenant_configurations_get"}}}}
```
## Patch Tenant Config Policy
> Update the \*\*Tenant Configuration\*\* policy.
```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/tenant-configurations/{compliance_id}":{"patch":{"description":"Update the **Tenant Configuration** policy.\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 a tenant configuration. This compliance id can be fetched from the response of the **Tenant Configuration Policy - GET** API.\n"}],"responses":{"200":{"description":"Update Tenant Configuration 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":"A system-generated guid to update a tenant configuration."}}},"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 a tenant configuration."},"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":{"user_name":{"type":"string","description":"ID of the user."},"current_timestamp":{"type":"string","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"format_type":{"type":"string","description":"Format of the payload. For e.g. JSON"},"compliance_name":{"type":"string","description":"Provide compliance name to retrieve an accounting calendar pertaining to that compliance name"},"unique_key":{"type":"string","description":"Unique key is GUID, which is a global unique identifier generated by the system."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"ar_accounting":{"type":"boolean","description":"A boolean field indicating whether AR accounting entries exist or not. If set to True, the accounting entries are generated; if False, the accounting entries are not generated."},"carves_allocation":{"type":"boolean","description":"A boolean field indicating whether carves allocation is enabled or not. If set to True, the carves allocation is enabled; if False, the carves allocation is not enabled."},"create_revenue_schedules":{"type":"boolean","description":"A boolean field indicating whether the system creates a revenue schedules for the revenue contracts to recognize revenue or not. If set to True, the system creates a revenue schedule for the revenue contracts to recognize revenue; if False, the system will not create a revenue schedule for the revenue contracts to recognize revenue."},"distribution_method":{"type":"string","description":"Displays the method to perform revenue distribution on the transaction lines. The methods are Days in Calendar Period & Prorate."},"lt_st_accounting":{"type":"boolean","description":"A boolean field indicating whether the system separates the accounts for long-term and short-term portions of contractual revenue / liabilities or not. If set to True, the system separates the accounts for long-term and short-term portions; if False, the system will not separate the accounts for long-term and short-term."},"manual_journal":{"type":"boolean","description":"A boolean field indicating whether the manual journal functionality can be used or not. If set to True, the manual journal functionality can be used; if False, the manual journal functionality cannot be used."},"manual_journal_contra_account":{"type":"string","description":"An alphanumeric value provided by the user which will get recorded when Manual Journal Entries are created."},"prorate_method":{"type":"string","description":"System performs revenue distribution evenly across the number of periods except the first and last which is based on the Partial Revenue Start and End date."},"multi_currency_revenue_contracts":{"type":"boolean","description":"A boolean field that allows revenue contracts to have multiple transaction currencies. If set to True, carves allocations will be performed only in functional currency; if False, system will group revenue contracts based on transaction currency and perform carve allocations in transaction currency."},"guid":{"type":"string","description":"Globally unique identifier generated by the system."},"journals_run_currency":{"type":"string","description":"Displays the currency in which the journal run is processed."},"ui_mode":{"type":"string","description":"Displays which user interface is active for the tenant."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the policy can be deleted or not. If set to True, the user is allowed to delete the policy; if False, deletion is not permitted."}},"required":["ar_accounting","can_delete","carves_allocation","create_revenue_schedules","distribution_method","guid","is_user_defined","journals_run_currency","lt_st_accounting","manual_journal","manual_journal_contra_account","multi_currency_revenue_contracts","prorate_method","ui_mode"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."}},"required":["compliance_name","compliance_spec","current_timestamp","format_type","unique_key","user_name"]}}},"required":true},"tags":["Policy Sets"],"summary":"Patch Tenant Config Policy","operationId":"patch_tenant_config_policy_apis_policy_sets_v1_policy_tenant_configurations__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/configuration/tenant-configuration.md?ask=&goal=
```
`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.