Supporting Documents

Get Supporting Docs List

get

/apis/supporting_doc/v1/lov/{doc_type}/{doc_id}

• This API is to retrieve the file details of supporting document uploaded in Revenue Contract or Manual journal Entry.

Path parameters

doc_typestringRequired

This is the type of document. User can provide RC or MJE to fetch the supporting document details.

doc_idstringRequired

This is number of revenue contract or manual journal entry.

Responses

200

Get Supporting document list

application/json

file_namestringRequired

Name and type of the file uploaded as supporting document.

file_sizenumberRequired

Size of the supporting document file uploaded.

last_modifiedstringRequired

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

user_namestringRequired

Name of the user who uploaded supporting document file.

doc_typestringRequired

Type of the document uploaded for. Is it supporting document for RC or MJE.

doc_idstringRequired

Revenue contract or MJE number.

get/apis/supporting_doc/v1/lov/{doc_type}/{doc_id}

GET /apis/supporting_doc/v1/lov/{doc_type}/{doc_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Get Supporting document list

[
  {
    "file_name": "supporting_doc.md",
    "file_size": 0.0068359375,
    "last_modified": "2026-04-15T21:03:43+00:00",
    "user_name": "[e-mail]",
    "doc_type": "RC",
    "doc_id": "RC-134"
  }
]

Upload Supporting Doc

post

/apis/supporting_doc/v1/

• This API is to upload the supporting document file in Revenue Contract or Manual journal Entry.
• User can upload multiple type of files - pdf, doc, docx, xls, xlsx, txt, rtf, odt, ods, csv, html, htm, md, xml, jpg, jpeg, png.
• The Supporting Documents feature is available only to users with the Sysadmin and Revenue Manager roles.

Body

filefile · binaryRequired

Attach Supporting document file.

Responses

200

Upload Supporting document

application/json

messagestringRequired

System generated message on file upload.

post/apis/supporting_doc/v1/

POST /apis/supporting_doc/v1/ HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: multipart/form-data
Accept: */*
Content-Length: 2

{}

200

Upload Supporting document

{
  "message": "Uploaded successfully."
}

Download Supporting Doc

get

/apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name}

• This API is to retrieve the supporting document file uploaded in Revenue Contract or Manual journal Entry.

Path parameters

doc_typestringRequired

This is type of document. User can provide RC or MJE to fetch the supporting document details.

doc_idstringRequired

This is number of revenue contract or manual journal entry.

file_namestringRequired

This is the name of supporting document file user want to download.

Responses

200

Download Supporting document

application/json

anyOptional

get/apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name}

GET /apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Download Supporting document

{}

Delete Supporting Doc

delete

/apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name}

• This API is to delete the supporting document uploaded in Revenue Contract or Manual journal Entry.
• Only the file owner (the user who uploaded the file) can delete their own files.

Path parameters

doc_typestringRequired

This is type of document. User can provide RC or MJE to fetch the supporting document details.

doc_idstringRequired

This is number of revenue contract or manual journal entry.

file_namestringRequired

This is the name of supporting document file user want to delete.

Responses

200

Delete Supporting document

application/json

messagestringRequired

Display system generates message on delete action.

delete/apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name}

DELETE /apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Delete Supporting document

{
  "message": "Deleted successfully."
}