Journal Transfer Hold & Event Release Hold - Line Level

Pending Events Hold - GET /apis/line-holds/v1/pending-events Not able to find in OPENAPI - Check with Thiyagu

Line Holds Get

get

/apis/line-holds/v1/{document_type}/{revenue_contract_id}

This API is used to retrieve the Journal Transfer Hold and Event Release hold on transaction lines.

Path parameters

document_typestringRequired

To fetch Journal Transfer Hold & Event Release Hold details. Supported value in document type is journal and for events holds it is event.

revenue_contract_idstringRequired

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

Responses

200

Get Line or Event Holds

application/json

appliedstring[]Required

This will display a message as applied and in brackets it will display Order Financial IDs from the Revenue Contract on which Event Or Line hold is applied otherwise it will show null.

get/apis/line-holds/v1/{document_type}/{revenue_contract_id}

GET /apis/line-holds/v1/{document_type}/{revenue_contract_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Get Line or Event Holds

{
  "applied": [
    "ord-001-rc3-02"
  ]
}

Line Holds

post

/apis/line-holds/v1/{document_type}/{revenue_contract_id}

This API is used to Apply or Release the Journal Transfer Hold and Event Release hold on transaction lines.

Path parameters

document_typestringRequired

To Apply or Release Journal Transfer Hold or Event Release Hold. Supported value in document type is journal and for events holds it is event.

revenue_contract_idstringRequired

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

Body

applystring[]Required

In this field user need to mention Order Financial IDs on transaction lines on which want to apply Journal Transfer Hold or Event Release Hold. Users can Apply or Release hold in same Payload on different Order financial IDs but not on same.

releasestring[]Required

In this field user need to mention Order Financial IDs on transaction lines on which want to release Journal Transfer Hold or Event Release Hold. Users can Apply or Release hold in same Payload on different Order financial IDs but not on same.

commentsstringRequired

User can put comment relevant to action they are performing.

Responses

200

Line Holds

application/json

post/apis/line-holds/v1/{document_type}/{revenue_contract_id}

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

{
  "apply": [
    "ord-001-rc3-02"
  ],
  "release": [
    "ord-001-rc3-03"
  ],
  "comments": "Apply line hold on ord-001-rc3-02 and Release line hold on ord-001-rc3-03"
}

200

Line Holds

{
  "holds_list": [
    {
      "file_id": "aac41fa3-fe11-4756-b7e3-2ae65908f5f4",
      "guid": "ord-001-rc3-02",
      "state": "success"
    },
    {
      "file_id": "c5cec4df-6b04-4422-890c-52b585d3a0b1",
      "guid": "ord-001-rc3-03",
      "state": "success"
    }
  ]
}