Manual Journals
To retrieve the list of all Manual Journal Batches created in the system.
This is optional field. Page represents page number of the policy list.
This is optional field. Page size represents how many records available on each page.
Get Manual Journal Runs
This will display count of total Manual Journal records
GET /apis/mje/v1/batches HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Manual Journal Runs
{
"batches": [
{
"approved_hold_id": null,
"batch_name": "MJE-std",
"created_at": 1749194928,
"created_by": "user@rightrev.com",
"created_period": "Apr-2021",
"date_format": null,
"file_format": "csv",
"file_id": "b9307a7d-8f03-4cbe-b9b7-c1b3c189bd81",
"file_location": null,
"file_name": "MJE_Std_April 2021.csv",
"file_size": 330,
"functional_currency": "USD",
"legal_entity": "LE_02",
"mje_id": "MJE-BATCH-1",
"mje_type": "Standard",
"rc_action_at": null,
"rc_action_by": null,
"rc_id": "MJE-1",
"rc_initiated_at": null,
"rc_initiated_by": null,
"reject_event_id": null,
"reject_hold_id": null,
"status": "mje_rc_created",
"tenant_id": "tenant_ID",
"total_rows_failed": null,
"total_rows_processed": 1,
"total_rows_received": 1,
"user_comments": null
}
],
"total_records": 1
}This API is used to retrieve of MJE Batch ID details.
Provide MJE Batch ID in action field.
get all mje details.
ID of the approval hold applied to this MJE
Name of the MJE Batch
Timestamp of the policy created by the user. This is a unix Epoch timestamp format.
ID of the user who created the policy. Example: username@rightrev.com
Name of the period in which MJE is created.
Format used for dates in the uploaded file. For e.g. MM/DD/YYYY
Format of the uploaded file (e.g., CSV, XLSX).
System-generated ID of the uploaded file.
Storage path where the file is stored. Value will be null
Name of the uploaded file.
Size of the file in bytes.
Currency codes used for the MJE amounts.
Legal entity associated with the MJE.
System-generated unique MJE batch identifier.
Type of MJE (e.g., Standard or Waterfall).
Timestamp when the reviewer took an action. Value will be null
ID of the User who performed the reviewer action. Value will be null
Revenue Contract ID of the MJE
Timestamp when the RC initiated. Value will be null
ID of the User who initiated action. Value will be null
ID for rejection event (if MJE was rejected).
Hold ID applied during rejection
Current status of the MJE workflow. For e.g. File uploaded or MJE Approved
Tenant/environment identifier.
Number of rows in the uploaded file that failed validation.
Number of rows in the uploaded file that processed successfully.
Total number of rows uploaded in the file.
Comments provided by the user for this MJE.
GET /apis/mje/v1/batches/{action} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
get all mje details.
{
"approved_hold_id": null,
"batch_name": "MJE-std",
"created_at": 1749194928,
"created_by": "manikranth@rightrev.com",
"created_period": "Apr-2021",
"date_format": null,
"file_format": "csv",
"file_id": "b9307a7d-8f03-4cbe-b9b7-c1b3c189bd81",
"file_location": null,
"file_name": "Snow_Ing_template - MJE_Std (29).csv",
"file_size": 330,
"functional_currency": "USD",
"legal_entity": "LE_02",
"mje_id": "MJE-BATCH-1",
"mje_type": "Standard",
"rc_action_at": null,
"rc_action_by": null,
"rc_id": "MJE-1",
"rc_initiated_at": null,
"rc_initiated_by": null,
"reject_event_id": null,
"reject_hold_id": null,
"status": "mje_rc_created",
"tenant_id": "test-rrapi-qa",
"total_rows_failed": null,
"total_rows_processed": 1,
"total_rows_received": 1,
"user_comments": null
}This API is used to download the Standard Templates of Standard Or Waterfall Manual Journal.
User need to provide the Manual Journal Type they want to download. Supported values are standard or waterfall. The standard templates are attached below.
Get Journal Template - In Raw text, columns seperated by commas
GET /apis/mje/v1/{mje_type}/template HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Journal Template - In Raw text, columns seperated by commas
This API is used to download the uploaded Manual journal file.
A system generated alpha-numeric number at the time of uploading file.
Manual Journal Download
GET /apis/mje/v1/batches/{file_id}/download HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Manual Journal Download
{}This API is used to create Manual Journal through csv file upload.
The CSV file to be uploaded to the system. Refer a [Sample CSV File] TODO
Name of the Manual Journal Batch.
Date format of Manual Journal.
Legal Entity in which user is creating Manual Journal
Type of the Manual Journal. Either STANDARD or WATERFALL.
Functional Currency of the Manual Journal.
post mje
A system generated alpha-numeric number.
A message generated on csv file upload.
POST /apis/mje/v1/batches/{action} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: multipart/form-data
Accept: */*
Content-Length: 113
{
"file": null,
"batch_name": null,
"date_format": null,
"legal_entity": null,
"mje_type": null,
"functional_currency": null
}post mje
{
"file_id": "47df6c20-d400-4d7c-b325-c9d73f1ce7c0",
"message": "File successfully uploaded"
}This API is used to Approve or Reject the manual journal.
Manual Journal ID.
Supported actions are approve or reject.
ID of the user who is approving or rejecting the Manual Journal.
Any comments added by the user at the time of approve or reject Manual Journal.
This API is used to Approve or Reject the manual journal.
Timestamp of the approve or reject action initiated by the user. This is a unix Epoch timestamp format.
ID of the user. This action will be done at engine side. So , ID of the user will always be RIGHTREV.
PUT /apis/mje/v1/batches/{mje_id}/{action} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"user_name": "user@rightrev.com",
"user_comments": "Approve batch"
}This API is used to Approve or Reject the manual journal.
{
"current_timestamp": "2026-02-03",
"hold_details": [
{
"applied_by": "",
"applied_on": "",
"hold_activity": "RELEASE",
"hold_name": "Manual Journals - Approval",
"hold_type": "transfer",
"message": "MJE batch Approve / Reject action initiated successfully",
"mje_id": "MJE-BATCH-12",
"released_by": "raviteja.d@rightrev.com",
"released_on": "2026-02-03 15:44:05.889",
"revenue_contract_id": "MJE-7",
"user_comments": "MJE release hold on MJE-7"
}
],
"user_name": "RIGHTREV"
}This API is to retrieve the file details of supporting document uploaded in Revenue Contract or Manual journal Entry.
This is the type of document. User can provide RC or MJE to fetch the supporting document details.
This is number of revenue contract or manual journal entry.
Get Supporting document list
Name and type of the file uploaded as supporting document.
Size of the supporting document file uploaded.
Timestamp of the policy last modified on. This is a unix Epoch timestamp format.
Name of the user who uploaded supporting document file.
Type of the document uploaded for. Is it supporting document for RC or MJE.
Revenue contract or MJE number.
GET /apis/supporting_doc/v1/lov/{doc_type}/{doc_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Supporting document list
[
{
"file_name": "supporting_doc.md",
"file_size": 0.0068359375,
"last_modified": "2026-04-15T21:03:43+00:00",
"user_name": "username@rightrev.com",
"doc_type": "RC",
"doc_id": "RC-134"
}
]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.
Attach Supporting document file.
Upload Supporting document
System generated message on file upload.
POST /apis/supporting_doc/v1/ HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: multipart/form-data
Accept: */*
Content-Length: 2
{}Upload Supporting document
{
"message": "Uploaded successfully."
}This API is to retrieve the supporting document file uploaded in Revenue Contract or Manual journal Entry.
This is type of document. User can provide RC or MJE to fetch the supporting document details.
This is number of revenue contract or manual journal entry.
This is the name of supporting document file user want to download.
Download Supporting document
GET /apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Download Supporting document
{}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.
This is type of document. User can provide RC or MJE to fetch the supporting document details.
This is number of revenue contract or manual journal entry.
This is the name of supporting document file user want to delete.
Delete Supporting document
Display system generates message on delete action.
DELETE /apis/supporting_doc/v1/{doc_type}/{doc_id}/{file_name} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Delete Supporting document
{
"message": "Deleted successfully."
}Last updated
Was this helpful?