Tenant Configuration

Users can manage various functionalities which are to be active and inactive in specific RightRev tenants based on their business requirements.

Get Tenant Config Policy

get

/apis/policy-sets/v1/policy/tenant-configurations

Retrieves the tenant configuration details associated with a specific RightRev tenant.

Responses

200

Get Tenant Configuration Policy

application/json

compliance_idstringOptional

A system-generated compliance ID to retrieve the tenant configuration policy.

compliance_namestringOptional

Displays the policy name.

created_bystringOptional

ID of the user who created the policy.

created_onintegerOptional

Timestamp of the policy created by the user. This is a unix Epoch timestamp format.

last_modified_bystringOptional

ID of the user last modified by.

last_modified_onintegerOptional

Timestamp of the policy last modified on. This is a unix Epoch timestamp format.

policy_typestringOptional

Represents the type of policy.

statusstringOptional

Represents the status of the policy.

unique_keystringOptional

Unique key is GUID, which is a global unique identifier generated by the system.

version_idstringOptional

Represents the latest version of the policy.

get/apis/policy-sets/v1/policy/tenant-configurations

GET /apis/policy-sets/v1/policy/tenant-configurations HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Get Tenant Configuration Policy

[
  {
    "compliance_id": "06b209d3-9003-4198-81cc-d9a1641777b5",
    "compliance_name": "Tenant Configuration",
    "compliance_spec": [
      {
        "account_segment_delimiter": "-",
        "ar_accounting": false,
        "augment_currency_rates": false,
        "bundle_functionality": true,
        "can_delete": false,
        "carves_allocation": true,
        "contract_asset_journal_method": "disabled",
        "contract_asset_segment": "CA001",
        "cost_enabled": true,
        "cost_practical_expedient": 12,
        "create_revenue_schedules": false,
        "created_at": 1707375144,
        "created_by": "RIGHTREV",
        "distribution_method": "PRORATE",
        "egress_hold": false,
        "fx_adjustment_method": "adjust_revenue",
        "fx_adjustments": false,
        "guid": "a336e00000BRMkxAAH",
        "ingest_hold": false,
        "is_user_defined": true,
        "journal_details_egress": true,
        "journal_transfer_by_ofid": false,
        "journals_run_currency": "functional",
        "lt_st_accounting": false,
        "manual_journal": false,
        "manual_journal_contra_account": "MJETEST",
        "multi_currency_revenue_contracts": false,
        "prorate_method": "NOOFDAYS",
        "rc_activities_egress": true,
        "rc_distributions_egress": true,
        "reprocess_existing_ofid": false,
        "sfdc_multicurrorg_enabled": false,
        "snowman_enabled": true,
        "ui_mode": "sfdc_revenue_app_ui",
        "updated_at": 1729682765,
        "updated_by": "[e-mail]"
      }
    ],
    "created_by": "RIGHTREV",
    "created_on": 1707375144,
    "last_modified_by": "[e-mail]",
    "last_modified_on": 1729682765,
    "policy_type": "tenant-configurations",
    "status": "Active",
    "unique_key": "a336e00000BRMkxAAH",
    "version_id": "45872639-fb95-4735-a6a5-62e6ff665be6"
  }
]

Patch Tenant Config Policy

patch

/apis/policy-sets/v1/policy/tenant-configurations/{compliance_id}

Update the Tenant Configuration policy.

Path parameters

compliance_idstringRequired

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.

Body

user_namestringRequired

ID of the user.

current_timestampstringRequired

Timestamp of the policy updated by the user. This is a unix Epoch timestamp format.

format_typestringRequired

Format of the payload. For e.g. JSON

compliance_namestringRequired

Provide compliance name to retrieve an accounting calendar pertaining to that compliance name

unique_keystringRequired

Unique key is GUID, which is a global unique identifier generated by the system.

Responses

200

Update Tenant Configuration Policy

application/json

compliance_idstringOptional

A system-generated compliance ID to update a tenant configuration.

errorarrayOptional

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.

patch/apis/policy-sets/v1/policy/tenant-configurations/{compliance_id}

PATCH /apis/policy-sets/v1/policy/tenant-configurations/{compliance_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 573

{
  "user_name": "test",
  "current_timestamp": "2023-05-08",
  "format_type": "json",
  "compliance_name": "Sample tenant configuration",
  "unique_key": "guid",
  "compliance_spec": [
    {
      "ar_accounting": false,
      "carves_allocation": true,
      "create_revenue_schedules": false,
      "distribution_method": "PRORATE",
      "lt_st_accounting": false,
      "manual_journal": false,
      "manual_journal_contra_account": "MJETEST",
      "prorate_method": "NOOFDAYS",
      "multi_currency_revenue_contracts": false,
      "guid": "a336e00000BRMkxAAH",
      "journals_run_currency": "functional",
      "ui_mode": "sfdc_revenue_app_ui",
      "is_user_defined": true,
      "can_delete": true
    }
  ]
}

200

Update Tenant Configuration Policy

{
  "compliance_details": [
    {
      "error": [],
      "message": "updated successfully",
      "unique_key": "20a09ee4-6d42-4530-8cd2-3bc7dd414b5e"
    }
  ],
  "compliance_id": "f22b2327-4a05-4d4f-8998-3a2ef19b328b",
  "error": []
}