> 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/period-close/journal-run.md).
# Journal Run
## Get Journal Runs
> This API will retrieve the details of all journal run IDs
```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/je/v1/":{"get":{"description":"This API will retrieve the details of all journal run IDs\n","parameters":[{"name":"page_number","in":"query","required":false,"schema":{"type":"string","title":"page number"},"description":"This is optional field. It represents page number.\n"},{"name":"page_size","in":"query","required":false,"schema":{"type":"string","title":"page_size"},"description":"This is optional field. It represents how many records available on each page."}],"responses":{"200":{"description":"Get Journal Runs","content":{"application/json":{"schema":{"type":"object","properties":{"additional_info":{"type":"array","description":"This includes all the details of journal run IDs."},"journal_run_list":{"type":"array","items":{"type":"object","properties":{"accounting_period":{"type":"string","description":"name of the period for which user has initiated journals"},"created_by":{"type":"string","description":"ID of the user who created the journal. Example- username@rightrev.com"},"created_on":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"currency_code":{"type":"string","description":"Functioanl currency code of the legal entity."},"file_id":{"type":"string","description":"A system generated alpha-numeric number."},"file_version":{"type":"integer","description":"Version of the journal run."},"gl_integration_app_name":{"type":"string","description":"Name of the configured GL outbound integration system."},"journal_run_id":{"type":"integer","description":"System generated journal run ID."},"journals_agg_fields":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Code of the field used for journal aggrgation"},"label":{"type":"string","description":"Label or name of the field used for journal aggrgation"}},"required":["code","label"]},"description":"These are the name of the fields used for journal aggregation."},"last_modified_by":{"type":"string","description":"ID of the user who modified the policy. Example - username@rightrev.com"},"last_modified_on":{"type":"integer","description":"Timestamp of the policy modified by the user. This is a unix Epoch timestamp format."},"legal_entity":{"type":"string","description":"Name of the legal entity."},"no_of_journal_entries":{"type":"integer","description":"Count of journal entries."},"posted_to_gl":{"type":"boolean","description":"Boolean field idicating if journals are posted to GL or not."},"rc_ids":{"type":"null","description":"This will display list of Revenue contracts selected to transfer."},"state":{"type":"string","description":"Status of journal run. For e.g. Ready To Transfer or Transferred"},"tenant_id":{"type":"string","description":"ID assigned to the tenant."},"total_credit_amount":{"type":"number","description":"Total credit amount of the journals."},"total_debit_amount":{"type":"number","description":"Total debit amount of the journals."},"transfer_currency_type":{"type":"string","description":"Functional / transactionl currency in which journals are transferred"}},"required":["accounting_period","created_by","created_on","currency_code","file_id","file_version","gl_integration_app_name","journal_run_id","journals_agg_fields","last_modified_by","last_modified_on","legal_entity","no_of_journal_entries","posted_to_gl","rc_ids","state","tenant_id","total_credit_amount","total_debit_amount","transfer_currency_type"]},"description":"Details of all the fields available iun this API."},"request_id":{"type":"string","description":"A system-generated request ID"},"total_records":{"type":"integer","description":"No of total records fetched by this API."}},"required":["additional_info","journal_run_list","request_id","total_records"]}}}}},"tags":["Journals"],"summary":"Get Journal Runs","operationId":"get_journal_runs_apis_je_v1__get"}}}}
```
## Create Journal Run
> This API will be used to initite new journals for all eligible legal entities.
```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/je/v1/":{"post":{"description":"This API will be used to initite new journals for all eligible legal entities.\n","responses":{"200":{"description":"Create Journal Run","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Journal Run ID generated by the system."},"message":{"type":"string","description":"System will display a message of success or error on journal creation."}},"required":["id","message"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"legal_entity":{"type":"string","description":"Name of the legal entity."},"accounting_period":{"type":"string","description":"name of the period for which user has initiated journals"},"rc_ids":{"type":"array","items":{"type":"string"},"description":"Revenue contract IDs selected for journal transfer."}},"required":["accounting_period","legal_entity"]}}},"required":true},"tags":["Journals"],"summary":"Create Journal Run","operationId":"create_journal_run_apis_je_v1__post"}}}}
```
## Get Journal Summary
> This API will retrieve the details of SUMMARY BY GL ACCOUNT section in journal run.
```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/je/v1/{journal_run_id}/summary":{"get":{"description":"This API will retrieve the details of SUMMARY BY GL ACCOUNT section in journal run.\n","parameters":[{"name":"journal_run_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Run Id"},"description":"User need to provide Journal Run ID.\n"},{"name":"page_number","in":"query","required":false,"schema":{"type":"string","title":"page_number"},"description":"This is optional field. It represents page number.\n"},{"name":"page_size","in":"query","required":false,"schema":{"type":"string","title":"page_size"},"description":"This is optional field. It represents how many records available on each page."}],"responses":{"200":{"description":"Get Journal Summary","content":{"application/json":{"schema":{"type":"object","properties":{"additional_info":{"type":"array","description":"Information related to all additional attributes."},"journal_run_list":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","description":"GL Account number."},"accounting_type":{"type":"string","description":"Type of the account. Contractual or Craves - Revenue or Liability account."},"credit":{"type":"number","description":"Total credit balance on this journal line."},"currency_code":{"type":"string","description":"Currency code of the legal entity."},"debit":{"type":"number","description":"Total debit balance on this journal line."}},"required":["account","accounting_type","credit","currency_code","debit"]},"description":"Details of all the journal lines."},"request_id":{"type":"null","description":"System generated alpha-numeric ID."},"total_records":{"type":"integer","description":"No of total records fetched by this API."}},"required":["additional_info","journal_run_list","request_id","total_records"]}}}}},"tags":["Journals"],"summary":"Get Journal Summary","operationId":"get_journal_summary_apis_je_v1__journal_run_id__summary_get"}}}}
```
## Get Journal Detail
> This API will retrieve the details of SUMMARY BY ATTRIBUTES section in journal run.
```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/je/v1/{journal_run_id}/details":{"get":{"description":"This API will retrieve the details of SUMMARY BY ATTRIBUTES section in journal run.\n","parameters":[{"name":"journal_run_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Run Id"},"description":"User need to provide Journal Run ID.\n"},{"name":"page_number","in":"query","required":false,"schema":{"type":"string","title":"page_number"},"description":"This is optional field. It represents page number.\n"},{"name":"page_size","in":"query","required":false,"schema":{"type":"string","title":"page_size"},"description":"This is optional field. It represents how many records available on each page."}],"responses":{"200":{"description":"Get Journal Detail","content":{"application/json":{"schema":{"type":"object","properties":{"additional_info":{"type":"array","description":"Information related to all additional attributes."},"journal_run_list":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","description":"GL Account number."},"accounting_period":{"type":"string","description":"Name of the accounting period"},"accounting_period_name":{"type":"string","description":"Name of the accounting period"},"accounting_type":{"type":"string","description":"Type of the account. Contractual or Carves - Revenue or Liability account."},"credit":{"type":"integer","description":"Total credit balance on this journal line."},"currency_code":{"type":"string","description":"Currency code of the legal entity."},"debit":{"type":"number","description":"Total debit balance on this journal line."},"gl_int_department_id":{"type":"string","description":"These is additional GL Aggregation Integration field"},"gl_int_location_id":{"type":"string","description":"These is additional GL Aggregation Integration field"},"order_financial_id":{"type":"string","description":"These is additional GL Aggregation Integration field. Summary will happen at transaction line level."},"revenue_contract_id":{"type":"string","description":"These is additional GL Aggregation Integration field. Summary will happen at revenue contract level."}},"required":["account","accounting_period","accounting_period_name","accounting_type","credit","currency_code","debit","gl_int_department_id","gl_int_location_id","order_financial_id","revenue_contract_id"]},"description":"Details of all the journal lines."},"request_id":{"type":"null","description":"System generated alpha-numeric ID."},"total_records":{"type":"integer","description":"No of total records fetched by this API."}},"required":["additional_info","journal_run_list","request_id","total_records"]}}}}},"tags":["Journals"],"summary":"Get Journal Detail","operationId":"get_journal_detail_apis_je_v1__journal_run_id__details_get"}}}}
```
## Transfer Journal
> This API is used to Transfer journals from Ready to Transfer state.
```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/je/v1/{journal_run_id}/transfer":{"put":{"description":"This API is used to Transfer journals from Ready to Transfer state.\n","parameters":[{"name":"journal_run_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Run Id"},"description":"User need to provide Journal run ID.\n"}],"responses":{"200":{"description":"Transfer Journal","content":{"application/json":{"schema":{"type":"object","properties":{"additional_info":{"type":"array","description":"Information related to all additional attributes."},"journal_run_list":{"type":"array","items":{"type":"object","properties":{"accounting_period":{"type":"string","description":"Name of the accountig period."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example - username@rightrev.com"},"created_on":{"type":"string","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"currency_code":{"type":"string","description":"Functional currency code of the legal entity."},"file_id":{"type":"string","description":"System generated alpha-numeric ID."},"file_version":{"type":"integer","description":"Version of the file."},"journal_run_id":{"type":"integer","description":"Journal Run ID generated by the system."},"last_modified_by":{"type":"string","description":"ID of the user who updated the policy. Example- username@rightrev.com"},"last_modified_on":{"type":"string","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format."},"legal_entity":{"type":"string","description":"Name of the legal entity."},"no_of_journal_entries":{"type":"integer","description":"Count of the journal entries to be transferred."},"state":{"type":"string","description":"Status could be Ready to transfer or Transfer-In-Progress."},"tenant_id":{"type":"string","description":"Tenant ID of the system."},"total_credit_amount":{"type":"integer","description":"Total credit amount of journal run"},"total_debit_amount":{"type":"integer","description":"Total debit amount of journal run"}},"required":["accounting_period","created_by","created_on","currency_code","file_id","file_version","journal_run_id","last_modified_by","last_modified_on","legal_entity","no_of_journal_entries","state","tenant_id","total_credit_amount","total_debit_amount"]},"description":"Details of all the journal lines."},"request_id":{"type":"string","description":"System generated alpha-numeric ID."},"total_records":{"type":"integer","description":"No of total records fetched by this API."}},"required":["additional_info","journal_run_list","request_id","total_records"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_version":{"type":"integer","description":"Version of the file."}},"required":["file_version"]}}},"required":true},"tags":["Journals"],"summary":"Transfer Journal","operationId":"transfer_journal_apis_je_v1__journal_run_id__transfer_put"}}}}
```
## Cancel Journal
> This API is used to Cancel journal which are in READY TO TRANSFER state.
```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/je/v1/{journal_run_id}/cancel":{"put":{"description":"This API is used to Cancel journal which are in READY TO TRANSFER state.\n","parameters":[{"name":"journal_run_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Run Id"},"description":"User need to provide Journal Run ID.\n"}],"responses":{"200":{"description":"Cancel Journal","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"System generated message on cancellation."}},"required":["message"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_version":{"type":"integer","description":"Version of the file."},"force":{"type":"boolean","description":"This is boolean field. User need to provide true or false."}},"required":["file_version","force"]}}},"required":true},"tags":["Journals"],"summary":"Cancel Journal","operationId":"cancel_journal_apis_je_v1__journal_run_id__cancel_put"}}}}
```
## Post Journal
> This API is used to Post the journals to GL system.
```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/je/v1/{journal_run_id}":{"put":{"description":"This API is used to Post the journals to GL system.\n","parameters":[{"name":"journal_run_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Run Id"},"description":"User need to provide Journal Run ID\n"}],"responses":{"200":{"description":"Post Journal","content":{"application/json":{"schema":{"type":"object","properties":{"additional_info":{"type":"array","items":{"type":"object","properties":{"accounting_period":{"type":"string","description":"name of the period for which user has initiated journals"},"action":{"type":"string","description":"Updation to transferred file with posted_to_gl."},"file_name":{"type":"string","description":"System generated file ID."},"status":{"type":"string","description":"Success or Failure"},"state":{"type":"string","description":"Archiving the prior file from transferred path."}},"required":["accounting_period","file_name","status"]},"description":"Additional information"},"message":{"type":"string","description":"Journal run with id __ got updated successfully."},"posted_to_gl":{"type":"boolean","description":"Boolean field indicating posted to GL or not."},"request_id":{"type":"string","description":"Syatem generated alpha-numeric number."},"state":{"type":"string","description":"It will be transferred."}},"required":["additional_info","message","posted_to_gl","request_id","state"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"posted_to_gl":{"type":"boolean","description":"Boolean field indicating posted to GL or not."}},"required":["posted_to_gl"]}}},"required":true},"tags":["Journals"],"summary":"Post Journal","operationId":"post_journal_apis_je_v1__journal_run_id__put"}}}}
```
## Get Journal Download
> This API is used to download journals data.
```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/je/v1/{journal_run_id}/download":{"get":{"description":"This API is used to download journals data.\n","parameters":[{"name":"journal_run_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Run Id"},"description":"User need to provide journal run ID.\n"}],"responses":{"200":{"description":"Get Journal Download","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{}}}}},"tags":["Journals"],"summary":"Get Journal Download","operationId":"get_journal_download_apis_je_v1__journal_run_id__download_get"}}}}
```
---
# 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/period-close/journal-run.md?ask=&goal=
```
`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.