Period Open-Close
Controls the status of accounting periods (open or closed). API transactions are processed only when the relevant periods are open.
To retrieves list of all active legal entities with details and status of current open period and stats of last 3 periods close.
To retrieve details of error transactions, holds and journals of legal entity and current open period, please refer to below attached sheet.
Get Period Open and Close Policy
A system-generated compliance ID to retrieve the period open-close Policies
Name of the policy fetched by the system.
ID of the user who created the policy. Example: username@rightrev.com
Timestamp of the policy created by the user. This is a unix Epoch timestamp format
ID of the user last modified by
Timestamp of the policy last modified on. This is a unix Epoch timestamp format
Represents the type of policy
Represents the status of policy
Unique key is code which is unique combination of Legal Entity, Tenant ID and current open period.
Unique alpha-numeric number generated by the system.
GET /apis/policy-sets/v1/policy/period-open-close HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
Get Period Open and Close Policy
[
{
"compliance_id": "463c0b62-c1dc-40f7-9d19-45bf1fe96650",
"compliance_name": "period-open-close",
"compliance_spec": [
{
"can_delete": false,
"code": "DefaultLegalEntity_tenantID_Jan-2021",
"created_at": 1763478464,
"created_by": "username@rightrev.com",
"end_date": "2021-01-31",
"fiscal_year_name": "FY-2021",
"is_user_defined": true,
"legal_entity": "LegalEntity1",
"opened_date": "2021-01-15",
"period_name": "Jan-2021",
"period_number": 1,
"quarter_number": 1,
"request_id": "tenantID_Jan-2021",
"start_date": "2021-01-01",
"status": "open",
"updated_at": 1763478464,
"updated_by": "username@rightrev.com"
}
],
"created_by": "RIGHTREV",
"created_on": 1767799103,
"last_modified_by": "RIGHTREV",
"last_modified_on": 1767799103,
"policy_type": "period-open-close",
"status": "Active",
"unique_key": "code",
"version_id": "fd44b439-283a-45a7-960d-98ab1f7acc79"
}
]To close current period and open new period in the system.
To Open First Period after creation of legal entity.
closed_date will be null and status will be open when user set open period for the first time.
A system-generated compliance ID to update the policy.
Format type of the request code used to collect data - For e.g. JSON
Operational name of the policy.
Name of the policy
It's a code which is unique combination of Legal Entity, tenant ID and Period name.
Update Period Open and Close Policy
A system-generated compliance ID for period open-close action.
Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.
PATCH /apis/policy-sets/v1/policy/period-open-close/{compliance_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 1045
{
"format_type": "json",
"compliance_name": "Open/Close period Operation",
"policy_type": "period-open-close",
"unique_key": "code",
"compliance_spec": [
{
"closed_date": "2026-01-08",
"end_date": "2021-05-31",
"fiscal_year_name": "FY-2021",
"legal_entity": "LE_03",
"opened_date": "2026-01-08",
"period_name": "May-2021",
"period_number": 5,
"quarter_number": 2,
"start_date": "2021-05-01",
"status": "closed",
"code": "DefaultLegalEntity_tenantID_May-2021",
"comments": "close"
},
{
"closed_date": null,
"end_date": "2021-06-30",
"fiscal_year_name": "FY-2021",
"legal_entity": "LE_03",
"opened_date": "2026-01-08",
"period_name": "Jun-2021",
"period_number": 6,
"quarter_number": 2,
"start_date": "2021-06-01",
"status": "open",
"code": "DefaultLegalEntity_tenantID_Jun-2021",
"comments": "close"
},
{
"closed_date": null,
"end_date": "2021-01-31",
"fiscal_year_name": "FY-2021",
"legal_entity": "Default_Legal_Entity",
"opened_date": "2026-01-08",
"period_name": "Jan-2021",
"period_number": 1,
"quarter_number": 1,
"start_date": "2021-01-01",
"status": "open",
"code": "DefaultLegalEntity_tenantID_Jan-2021",
"comments": null
}
]
}Update Period Open and Close Policy
{
"compliance_details": [
{
"error": [],
"message": "updated successfully",
"unique_key": "9ba8f9bd-c031-4a1d-8a9e-78b75fb26f22"
}
],
"compliance_id": "4486ab41-ce2b-4bd5-bdae-deda95434145",
"error": []
}To close current period and open new period in the Salesforce.
To Open First Period after creation of legal entity.
closed_date will be null and status will be open when user set open period for the first time.
A system-generated compliance ID to retrieve the period open-close Policies
Format type of the request code used to collect data - For e.g. JSON
Operational name of the policy.
It's a code which is unique combination of Legal Entity and Period name.
Replace Period Open and Close Policy
A system-generated compliance ID on creating or updating the policy
Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.
PUT /apis/policy-sets/v1/policy/period-open-close/{compliance_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 914
{
"format_type": "json",
"compliance_name": "period-open-close",
"unique_key": "code",
"compliance_spec": [
{
"period_description": "Jan 2026-USD-Default Revenue Book-Default Legal Entity",
"code": "a1sfo000000FIsfAAG_a2Pfo00000012ubEAA",
"end_date": "2026-01-31",
"fiscal_year_name": "FY-2026",
"legal_entity": "a1sfo000000FIsfAAG",
"period_name": "a2Pfo00000012ubEAA",
"period_number": 1,
"quarter_number": 1,
"start_date": "2026-01-01",
"status": "closed",
"opened_date": "2025-11-26",
"closed_date": "2026-01-07",
"comments": "Close period"
},
{
"period_description": "Feb 2026-USD-Default Revenue Book-Default Legal Entity",
"code": "a1sfo000000FIsfAAG_a2Pfo00000012ucEAA",
"end_date": "2026-02-28",
"fiscal_year_name": "FY-2026",
"legal_entity": "a1sfo000000FIsfAAG",
"period_name": "a2Pfo00000012ucEAA",
"period_number": 2,
"quarter_number": 1,
"start_date": "2026-02-01",
"status": "open",
"opened_date": "2026-01-07",
"closed_date": null,
"comments": "Close Period"
}
]
}Replace Period Open and Close Policy
{
"compliance_details": [
{
"error": [],
"message": "updated successfully",
"unique_key": "9ba8f9bd-c031-4a1d-8a9e-78b75fb26f22"
}
],
"compliance_id": "4486ab41-ce2b-4bd5-bdae-deda95434145",
"error": []
}Last updated
Was this helpful?