> For the complete documentation index, see [llms.txt](https://apis.rightrev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apis.rightrev.com/rightrev-rest-api/revenue-desk-360/revenue-contract-more-actions/supporting-documents.md).

# Supporting Documents

## Get Supporting Docs List

> \- This API is to retrieve the file details of supporting document uploaded in Revenue Contract or Manual journal Entry.<br>

```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/supporting_doc/v1/lov/{doc_type}/{doc_id}":{"get":{"parameters":[{"name":"doc_type","in":"path","required":true,"schema":{"type":"string","title":"Doc Type"},"description":"This is the type of document. User can provide RC or MJE to fetch the supporting document details.\n"},{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","title":"Doc Id"},"description":"This is number of revenue contract or manual journal entry.\n"}],"responses":{"200":{"description":"Get Supporting document list","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"file_name":{"type":"string","description":"Name and type of the file uploaded as supporting document."},"file_size":{"type":"number","description":"Size of the supporting document file uploaded."},"last_modified":{"type":"string","description":"Timestamp of the policy last modified on. This is a unix Epoch timestamp format."},"user_name":{"type":"string","description":"Name of the user who uploaded supporting document file."},"doc_type":{"type":"string","description":"Type of the document uploaded for. Is it supporting document for RC or MJE."},"doc_id":{"type":"string","description":"Revenue contract or MJE number."}},"required":["doc_id","doc_type","file_name","file_size","last_modified","user_name"]}}}}}},"description":"- This API is to retrieve the file details of supporting document uploaded in Revenue Contract or Manual journal Entry.\n","tags":["Supporting Docs"],"summary":"Get Supporting Docs List","operationId":"get_supporting_docs_list_apis_supporting_doc_v1_lov__doc_type___doc_id__get"}}}}
```

## Upload Supporting Doc

> \- 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.<br>

```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/supporting_doc/v1/":{"post":{"responses":{"200":{"description":"Upload Supporting document","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"System generated message on file upload."}},"required":["message"]}}}}},"description":"- This API is to upload the supporting document file in Revenue Contract or Manual journal Entry. \n- User can upload multiple type of files -  pdf, doc, docx, xls, xlsx, txt, rtf, odt, ods, csv, html, htm, md, xml, jpg, jpeg, png.\n- The Supporting Documents feature is available only to users with the Sysadmin and Revenue Manager roles.\n","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"file","format":"binary","description":"Attach Supporting document file."}},"required":["file"]}}},"required":true},"tags":["Supporting Docs"],"summary":"Upload Supporting Doc","operationId":"upload_supporting_doc_apis_supporting_doc_v1__post"}}}}
```

## Download Supporting Doc

> \- This API is to retrieve the supporting document file uploaded in Revenue Contract or Manual journal Entry.<br>

```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name}":{"get":{"parameters":[{"name":"doc_type","in":"path","required":true,"schema":{"type":"string","title":"Doc Type"},"description":"This is type of document. User can provide RC or MJE to fetch the supporting document details.\n"},{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","title":"Doc Id"},"description":"This is number of revenue contract or manual journal entry.\n"},{"name":"file_name","in":"path","required":true,"schema":{"type":"string","title":"File Name"},"description":"This is the name of supporting document file user want to download.\n"}],"responses":{"200":{"description":"Download Supporting document","content":{"application/json":{"schema":{}}}}},"description":"- This API is to retrieve the supporting document file uploaded in Revenue Contract or Manual journal Entry.\n","tags":["Supporting Docs"],"summary":"Download Supporting Doc","operationId":"download_supporting_doc_apis_supporting_doc_v1__doc_type___doc_id___file_name__get"}}}}
```

## Delete Supporting Doc

> \- 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.<br>

```json
{"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name}":{"delete":{"parameters":[{"name":"doc_type","in":"path","required":true,"schema":{"type":"string","title":"Doc Type"},"description":"This is type of document. User can provide RC or MJE to fetch the supporting document details.\n"},{"name":"doc_id","in":"path","required":true,"schema":{"type":"string","title":"Doc Id"},"description":"This is number of revenue contract or manual journal entry. \n"},{"name":"file_name","in":"path","required":true,"schema":{"type":"string","title":"File Name"},"description":"This is the name of supporting document file user want to delete.\n"}],"responses":{"200":{"description":"Delete Supporting document","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Display system generates message on delete action."}},"required":["message"]}}}}},"description":"- This API is to delete the supporting document uploaded in Revenue Contract or Manual journal Entry.\n- Only the file owner (the user who uploaded the file) can delete their own files.\n","tags":["Supporting Docs"],"summary":"Delete Supporting Doc","operationId":"delete_supporting_doc_apis_supporting_doc_v1__doc_type___doc_id___file_name__delete"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apis.rightrev.com/rightrev-rest-api/revenue-desk-360/revenue-contract-more-actions/supporting-documents.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
