Holds
Define Holds which can be applied to revenue contracts to prevent revenue release or revenue recognition when data discrepancies occur. System holds are pre-defined and triggers automatically.
Retrieves hold policies created by the user and the system to prevent revenue release / recognition for the revenue contract. Also retrieves the inactive holds.
Get Holds Policy
Provide compliance id to retrieve holds pertaining to that compliance id.
Name of the policy fetched by the system.
ID of the user who created the policy.
Timestamp of the policy created by the user. This is a unix Epoch timestamp format.
ID of the user last modified by.
Timestamp of the policy last modified on. This is a unix Epoch timestamp format.
Represents the type of policy.
Represents the status of the policy.
Unique identifier generated by the system.
Represents the latest version of the policy.
GET /apis/policy-sets/v1/policy/holds HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Holds Policy
[
{
"compliance_id": "d771fa5b-b627-42c5-bc0e-aa83fde87666",
"compliance_name": "holds",
"compliance_spec": [
{
"active": true,
"can_delete": true,
"created_at": 1758630296,
"created_by": "username@rightrev.com",
"guid": "4cd98a4b-0d42-4108-8411-dddc93f387e0",
"hold_type": "transfer",
"is_user_defined": true,
"name": "test hold",
"updated_at": 1758630296,
"updated_by": "username@rightrev.com",
"when": []
}
],
"created_by": "RIGHTREV",
"created_on": 1758717619,
"last_modified_by": "RIGHTREV",
"last_modified_on": 1758717619,
"policy_type": "holds-definition",
"status": "Active",
"unique_key": "guid",
"version_id": "ae6be271-7109-4823-a18c-88074cb48543"
}
]Create a new hold policy in the system to temporarily stop revenue release / recognition.
Provide compliance id to define hold pertaining to that compliance id.
Name of the policy.
It's GUID. Globally unique identifier generated by the system.
Format of the payload. For e.g. JSON
Create a New Hold Policy
Provide compliance id to delete an accounting calendar pertaining to that compliance id.
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/holds/{compliance_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 228
{
"compliance_name": "Holds Policy",
"unique_key": "guid",
"format_type": "json",
"compliance_spec": [
{
"can_delete": false,
"name": "rrapi-hold",
"guid": "rrapi-hold",
"hold_type": "transfer",
"active": false,
"is_user_defined": false,
"when": []
}
]
}Create a New Hold Policy
{
"compliance_details": [
{
"error": [],
"message": "created successfully",
"unique_key": ""
}
],
"compliance_id": "99841657-3868-4644-b6a0-004a90175cd3",
"error": []
}Delete the existing hold policies in the RightRev system.
Provide compliance id to delete hold pertaining to that compliance. id.
Unique object identifier generated by the system.
Delete Holds Policy
Displays the details of specific rules and standards processed by the system.
Provide compliance id to delete hold pertaining to that compliance id.
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.
DELETE /apis/policy-sets/v1/policy/holds/{compliance_id}/{object_unique_value} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Delete Holds Policy
{
"compliance_details": [],
"compliance_id": "e1daa1a3-7582-4533-8535-06d765788d11",
"error": []
}Last updated
Was this helpful?