Journal Run
This API will retrieve the details of all journal run IDs
This is optional field. It represents page number.
This is optional field. It represents how many records available on each page.
Get Journal Runs
This includes all the details of journal run IDs.
A system-generated request ID
No of total records fetched by this API.
GET /apis/je/v1/ HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Journal Runs
{
"additional_info": [],
"journal_run_list": [
{
"accounting_period": "2026-1",
"created_by": "thiyagu@rightrev.com",
"created_on": 1780412537,
"currency_code": "CAD",
"file_id": "sage-int-test##df01e92f-f35c-41ab-9cb4-674c54071c25",
"file_version": 1,
"gl_integration_app_name": "SAGE",
"journal_run_id": 133,
"journals_agg_fields": [
{
"code": "gl_int_location_id",
"label": "Location ID"
},
{
"code": "order_financial_id",
"label": "Order Financial ID"
},
{
"code": "revenue_contract_id",
"label": "Revenue Contract ID"
},
{
"code": "gl_int_department_id",
"label": "Department ID"
}
],
"last_modified_by": "thiyagu@rightrev.com",
"last_modified_on": 1780412728,
"legal_entity": "400",
"no_of_journal_entries": 22,
"posted_to_gl": false,
"rc_ids": null,
"state": "Transferred",
"tenant_id": "sage-int-test",
"total_credit_amount": 1390.95,
"total_debit_amount": 1390.95,
"transfer_currency_type": "functional"
}
],
"request_id": "sage-int-test",
"total_records": 99
}This API will be used to initite new journals for all eligible legal entities.
Name of the legal entity.
name of the period for which user has initiated journals
Revenue contract IDs selected for journal transfer.
Create Journal Run
Journal Run ID generated by the system.
System will display a message of success or error on journal creation.
POST /apis/je/v1/ HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"legal_entity": "100",
"accounting_period": "2026-5"
}Create Journal Run
{
"id": 134,
"message": "Journal Run:134 created"
}This API will retrieve the details of SUMMARY BY GL ACCOUNT section in journal run.
User need to provide Journal Run ID.
This is optional field. It represents page number.
This is optional field. It represents how many records available on each page.
Get Journal Summary
Information related to all additional attributes.
System generated alpha-numeric ID.
No of total records fetched by this API.
GET /apis/je/v1/{journal_run_id}/summary HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Journal Summary
{
"additional_info": [],
"journal_run_list": [
{
"account": "20701",
"accounting_type": "Contractual Liability",
"credit": 0,
"currency_code": "CAD",
"debit": 1390.95
},
{
"account": "40200",
"accounting_type": "Contractual Revenue",
"credit": 1390.95,
"currency_code": "CAD",
"debit": 0
}
],
"request_id": null,
"total_records": 2
}This API will retrieve the details of SUMMARY BY ATTRIBUTES section in journal run.
User need to provide Journal Run ID.
This is optional field. It represents page number.
This is optional field. It represents how many records available on each page.
Get Journal Detail
Information related to all additional attributes.
System generated alpha-numeric ID.
No of total records fetched by this API.
GET /apis/je/v1/{journal_run_id}/details HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Journal Detail
{
"additional_info": [],
"journal_run_list": [
{
"account": "20701",
"accounting_period": "2026-1",
"accounting_period_name": "2026-1",
"accounting_type": "Contractual Liability",
"credit": 0,
"currency_code": "CAD",
"debit": 126.45,
"gl_int_department_id": "500",
"gl_int_location_id": "401",
"order_financial_id": "SO0522_RR026_ST.3",
"revenue_contract_id": "RC-94"
},
{
"account": "20701",
"accounting_period": "2026-1",
"accounting_period_name": "2026-1",
"accounting_type": "Contractual Liability",
"credit": 0,
"currency_code": "CAD",
"debit": 126.45,
"gl_int_department_id": "500",
"gl_int_location_id": "401",
"order_financial_id": "SO0522_RR027_ST.3",
"revenue_contract_id": "RC-127"
}
],
"request_id": null,
"total_records": 22
}This API is used to Transfer journals from Ready to Transfer state.
User need to provide Journal run ID.
Version of the file.
Transfer Journal
Information related to all additional attributes.
System generated alpha-numeric ID.
No of total records fetched by this API.
PUT /apis/je/v1/{journal_run_id}/transfer HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"file_version": 1
}Transfer Journal
{
"additional_info": [],
"journal_run_list": [
{
"accounting_period": "2026-5",
"created_by": "thiyagu@rightrev.com",
"created_on": "2026-06-10 17:13:59.723",
"currency_code": "USD",
"file_id": "20d94ddc-929a-4d98-8714-fdbea4362fa4",
"file_version": 1,
"journal_run_id": 135,
"last_modified_by": "thiyagu@rightrev.com",
"last_modified_on": "2026-06-10 17:15:41.256",
"legal_entity": "100",
"no_of_journal_entries": 2,
"state": "Transfer-In-Progress",
"tenant_id": "sage-int-test",
"total_credit_amount": 1750,
"total_debit_amount": 1750
}
],
"request_id": "20d94ddc-929a-4d98-8714-fdbea4362fa4",
"total_records": 1
}This API is used to Cancel journal which are in READY TO TRANSFER state.
User need to provide Journal Run ID.
Version of the file.
This is boolean field. User need to provide true or false.
Cancel Journal
System generated message on cancellation.
PUT /apis/je/v1/{journal_run_id}/cancel HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"file_version": 1,
"force": true
}Cancel Journal
{
"message": "Journal Run:134 cancelled "
}This API is used to Post the journals to GL system.
User need to provide Journal Run ID
Boolean field indicating posted to GL or not.
Post Journal
Journal run with id __ got updated successfully.
Boolean field indicating posted to GL or not.
Syatem generated alpha-numeric number.
It will be transferred.
PUT /apis/je/v1/{journal_run_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"posted_to_gl": true
}Post Journal
{
"additional_info": [
{
"accounting_period": "2026-5",
"action": "Updation to transferred file with posted_to_gl.",
"file_name": "85409be3-ca1c-4358-8c8b-afb4641501eb.json",
"status": "success"
},
{
"accounting_period": "2026-5",
"file_name": "85409be3-ca1c-4358-8c8b-afb4641501eb.json",
"state": "Archiving the prior file from transferred path.",
"status": "success"
}
],
"message": "Journal run with id 135 got updated successfully.",
"posted_to_gl": true,
"request_id": "85409be3-ca1c-4358-8c8b-afb4641501eb",
"state": "Transferred"
}This API is used to download journals data.
User need to provide journal run ID.
Get Journal Download
GET /apis/je/v1/{journal_run_id}/download HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Journal Download
https://dev-rev-engine.s3.amazonaws.com/lineage/<tenant_id>/journal_details/journal_run_133.csv?response-content-disposition=attachment%3B%20filename%3D%22journal_run_133.csv%22&AWSAccessKeyId=XX&Signature=XX&Expires=1781110039Last updated
Was this helpful?