Journal Transfer Hold - RC Level

Holds Get

get

/apis/holds/v1/{rc_id}

This API is used to retrieve the Journal Transfer Hold on Revenue Contracts.

Path parameters

rc_idstringRequired

This is Revenue Contract Number. For e.g. RC-225

statestringRequired

State is status of hold. Supported values are active or released.

Responses

200

Get Holds

application/json

additional_infoarrayRequired

This will display if any additional information is available.

request_idnullRequired

This is system generated alpha-numeric number.

get/apis/holds/v1/{rc_id}

GET /apis/holds/v1/{rc_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Get Holds

{
  "additional_info": [],
  "holds_list": [
    {
      "applied_by": "[e-mail]",
      "applied_comments": "Apply Hold",
      "applied_on": "2026-01-09 00:00:00.000",
      "applied_period": "Apr-2021",
      "file_id": "0b5a7c26-c7b9-49ce-9eae-2e4e0f9d59e7",
      "guid": "0b5a7c26-c7b9-49ce-9eae-2e4e0f9d59e7",
      "hold_name": "transfer_hold",
      "hold_type": "transfer",
      "rc_version_when_applied": "3",
      "rc_version_when_released": "3",
      "released_by": "[e-mail]",
      "released_comments": "Release Hold",
      "released_file_id": "db2997ad-0e59-4ddb-9eb4-89f3aeb9687c",
      "released_on": "2026-01-09 00:00:00.000",
      "released_period": "Apr-2021",
      "state": "released"
    }
  ],
  "request_id": null
}

Holds Sfdc

post

/apis/holds/v1/

This API is used to Apply or Release hold on Revenue contracts.

Body

Responses

200

Holds Sfdc

application/json

request_idstringRequired

A system generated alpha-numeric number.

post/apis/holds/v1/

POST /apis/holds/v1/ HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "holds_spec": [
    {
      "hold_type": "Transfer",
      "comments": "release hold",
      "hold_activity": "Apply",
      "revenue_contract_id": "RC-364",
      "hold_name": "Hold1"
    },
    {
      "hold_type": "Transfer",
      "comments": "release hold",
      "hold_activity": "Apply",
      "revenue_contract_id": "RC-365",
      "hold_name": "Hold1"
    }
  ]
}

200

Holds Sfdc

{
  "additional_info": [
    {
      "action": "Release hold Hold1 on revenue contract RC-365",
      "applied_period": "JAN",
      "status": "success"
    },
    {
      "action": "Release hold Hold1 on revenue contract RC-364",
      "applied_period": "JAN",
      "status": "success"
    }
  ],
  "request_id": "fd912183-fa89-4b24-9c1c-7a2684b55785"
}