Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Accounting Period/Calendar

The Accounting Calendar defines the pattern of the financial year, its start and end dates to perform certain accounting functions.

Get Accounting Period Policy

get
/apis/policy-sets/v1/policy/calendar

Retrieves the accounting calendar period details associated with a specific tenant.

Responses
200

Get Accounting Calendar Policy

application/json
compliance_idstringOptional

A system-generated compliance ID to retrieve the accounting calendar.

compliance_namestringOptional

Name of the policy fetched by the system.

created_bystringOptional

ID of the user who created the policy.

created_onintegerOptional

Timestamp of the policy created by the user. This is a unix Epoch timestamp format.

last_modified_bystringOptional

ID of the user last modified by.

last_modified_onintegerOptional

Timestamp of the policy last modified on. This is a unix Epoch timestamp format.

policy_typestringOptional

Represents the type of policy.

statusstringOptional

Represents the status of the policy.

unique_keystringOptional

Unique combination of legal entity, tenant name and period name generated by the system.

version_idstringOptional

Represents the latest version of the policy.

get/apis/policy-sets/v1/policy/calendar
GET /apis/policy-sets/v1/policy/calendar HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200

Get Accounting Calendar Policy

[
  {
    "compliance_id": "bec2f65a-3693-40ad-bd08-70c81f4e65a2",
    "compliance_name": "calendar",
    "compliance_spec": [
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Jan-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-01-31",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Jan-21",
        "period_number": 1,
        "quarter_number": 1,
        "start_date": "2021-01-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Feb-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-02-28",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Feb-21",
        "period_number": 2,
        "quarter_number": 1,
        "start_date": "2021-02-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Mar-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-03-31",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Mar-21",
        "period_number": 3,
        "quarter_number": 1,
        "start_date": "2021-03-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Apr-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-04-30",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Apr-21",
        "period_number": 4,
        "quarter_number": 2,
        "start_date": "2021-04-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_May-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-05-31",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "May-21",
        "period_number": 5,
        "quarter_number": 2,
        "start_date": "2021-05-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Jun-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-06-30",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Jun-21",
        "period_number": 6,
        "quarter_number": 2,
        "start_date": "2021-06-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Jul-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-07-31",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Jul-21",
        "period_number": 7,
        "quarter_number": 3,
        "start_date": "2021-07-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Aug-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-08-31",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Aug-21",
        "period_number": 8,
        "quarter_number": 3,
        "start_date": "2021-08-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Sep-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-09-30",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Sep-21",
        "period_number": 9,
        "quarter_number": 3,
        "start_date": "2021-09-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Oct-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-10-31",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Oct-21",
        "period_number": 10,
        "quarter_number": 4,
        "start_date": "2021-10-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Nov-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-11-30",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Nov-21",
        "period_number": 11,
        "quarter_number": 4,
        "start_date": "2021-11-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      },
      {
        "can_delete": true,
        "code": "Default Legal Entity_tenant-name_Dec-21",
        "created_at": 1758634356,
        "created_by": "username@rightrev.com",
        "end_date": "2021-12-31",
        "fiscal_year_name": "FY-2021",
        "is_user_defined": true,
        "legal_entity": "Default Legal Entity",
        "period_name": "Dec-21",
        "period_number": 12,
        "quarter_number": 4,
        "start_date": "2021-12-01",
        "updated_at": 1758634356,
        "updated_by": "username@rightrev.com"
      }
    ],
    "created_by": "rightrev",
    "created_on": 1758634360,
    "last_modified_by": "rightrev",
    "last_modified_on": 1758634360,
    "policy_type": "calendar",
    "status": "Active",
    "unique_key": "code",
    "version_id": "dae8b520-431a-4d07-854f-0e71f689d343"
  }
]

Update Accounting Period Policy

post
/apis/policy-sets/v1/policy/calendar/{code}

Create a new Accounting Calendar in RightRev system by uploading calendar data via a CSV file.

  • Users must provide 12 months period for a fiscal year.

  • Start date must be less than the end date.

  • Both start and end dates must be provided.

  • Start and end date must be the 1st and last day of the month respectively.

Path parameters
codestringRequired

Provide code name as upload.

Body
filefile · binaryRequired

The CSV file to be uploaded to the system.

Refer a Sample CSV File for reference.

date_formattext · %m/%d/%YRequired

Start Date and End Date must be in mm-dd-yyyy format.

unique_keytext · codeRequired

A CSV file upload method.

Responses
200

Create a New Accounting Calendar Policy (CSV)

application/json
compliance_idstringOptional

A system-generated compliance ID to set an accounting calendar.

errorarrayOptional

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.

post/apis/policy-sets/v1/policy/calendar/{code}
POST /apis/policy-sets/v1/policy/calendar/{code} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: multipart/form-data
Accept: */*
Content-Length: 50

{
  "file": null,
  "date_format": null,
  "unique_key": null
}
200

Create a New Accounting Calendar Policy (CSV)

{
  "compliance_details": [
    {
      "error": [],
      "message": "created successfully",
      "unique_key": "Default Legal Entity_tenant-name_Jan-2021"
    }
  ],
  "compliance_id": "90853521-ee0a-486c-988f-c6e642e5ec12",
  "error": []
}

Post Accounting Period Policy

post
/apis/policy-sets/v1/policy/calendar

Create a new Accounting Calendar in the RightRev system by providing calendar data in JSON format.

  • Users must provide 12 months period for a fiscal year.

  • Start date must be less than the end date.

  • Both start and end dates must be provided.

  • Start and end date must be the 1st and last day of the month respectively.

Body
compliance_namestringRequired

Name of the policy fetched by the system.

unique_keystringRequired

Unique combination of legal entity and period name.

Example:

  • Legal Entity: Default Legal Entity
  • Period Name: Jan-21
  • Code: Default Legal Entity_Jan-21
Responses
200

Create a New Accounting Calendar Policy (JSON)

application/json
compliance_idstringOptional

A system-generated compliance ID to set an accounting calendar.

errorarrayOptional

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.

post/apis/policy-sets/v1/policy/calendar
POST /apis/policy-sets/v1/policy/calendar HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 3168

{
  "compliance_name": "Accounting Calendar",
  "unique_key": "code",
  "compliance_spec": [
    {
      "can_delete": true,
      "code": "Default Legal Entity_Jan-21",
      "end_date": "2021-01-31",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Jan-21",
      "period_number": 1,
      "quarter_number": 1,
      "start_date": "2021-01-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Feb-21",
      "end_date": "2021-02-28",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Feb-21",
      "period_number": 2,
      "quarter_number": 1,
      "start_date": "2021-02-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Mar-21",
      "end_date": "2021-03-31",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Mar-21",
      "period_number": 3,
      "quarter_number": 1,
      "start_date": "2021-03-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Apr-21",
      "end_date": "2021-04-30",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Apr-21",
      "period_number": 4,
      "quarter_number": 2,
      "start_date": "2021-04-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_May-21",
      "end_date": "2021-05-31",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "May-21",
      "period_number": 5,
      "quarter_number": 2,
      "start_date": "2021-05-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Jun-21",
      "end_date": "2021-06-30",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Jun-21",
      "period_number": 6,
      "quarter_number": 2,
      "start_date": "2021-06-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Jul-21",
      "end_date": "2021-07-31",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Jul-21",
      "period_number": 7,
      "quarter_number": 3,
      "start_date": "2021-07-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Aug-21",
      "end_date": "2021-08-31",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Aug-21",
      "period_number": 8,
      "quarter_number": 3,
      "start_date": "2021-08-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Sep-21",
      "end_date": "2021-09-30",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Sep-21",
      "period_number": 9,
      "quarter_number": 3,
      "start_date": "2021-09-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Oct-21",
      "end_date": "2021-10-31",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Oct-21",
      "period_number": 10,
      "quarter_number": 4,
      "start_date": "2021-10-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Nov-21",
      "end_date": "2021-11-30",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Nov-21",
      "period_number": 11,
      "quarter_number": 4,
      "start_date": "2021-11-01"
    },
    {
      "can_delete": true,
      "code": "Default Legal Entity_Dec-21",
      "end_date": "2021-12-31",
      "fiscal_year_name": "FY-2021",
      "is_user_defined": true,
      "legal_entity": "Default Legal Entity",
      "period_name": "Dec-21",
      "period_number": 12,
      "quarter_number": 4,
      "start_date": "2021-12-01"
    }
  ]
}
200

Create a New Accounting Calendar Policy (JSON)

{
  "compliance_details": [
    {
      "error": [],
      "message": "created successfully",
      "unique_key": "Default Legal Entity_Jan-21"
    }
  ],
  "compliance_id": "90853521-ee0a-486c-988f-c6e642e5ec12",
  "error": []
}

Delete Accounting Period Policy

delete
/apis/policy-sets/v1/policy/calendar/{compliance_id}/{object_unique_value}

Delete the existing Accounting Calendar in the RightRev system.

  • If user deletes one fiscal year, then all the future fiscal years will be deleted.

Path parameters
compliance_idstringRequired

User has to provide a compliance id to delete an accounting calendar. This compliance id can be fetched from the response of the Accounting Calendar Policy - GET API.

object_unique_valuestringRequired

A Unique combination of legal entity, tenant name and period name.

Example:

  • Legal Entity: Default Legal Entity
  • Tenant Name: tenant-name
  • Period Name: Jan-21
  • Object Unique Value: Default Legal Entity_tenant-name_Jan-21
Responses
200

Delete Accounting Calendar Policy

application/json
compliance_idstringOptional

A system-generated compliance ID to delete an accounting calendar.

errorarrayOptional

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.

delete/apis/policy-sets/v1/policy/calendar/{compliance_id}/{object_unique_value}
DELETE /apis/policy-sets/v1/policy/calendar/{compliance_id}/{object_unique_value} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200

Delete Accounting Calendar Policy

{
  "compliance_details": [
    {
      "error": [],
      "message": "deleted successfully",
      "unique_key": "Default Legal Entity_tenant-name_Jan-21"
    }
  ],
  "compliance_id": "bec2f65a-3693-40ad-bd08-70c81f4e65a2",
  "error": []
}
PreviousCompany Profile
NextLegal Entity

Last updated

Was this helpful?