Skip to main content

Escalations Overview

This documentation extends the Base Econ Model Documentation.

Properties​

escalation (required)​

An object that describes the escalation of differentials over time.

rows​

An array of objects that describe the escalation of differentials over time.

  • Data Type: array of objects
  • Required Properties for each object:
    • pctPerYear or dollarPerYear
    • monthPeriod, entireWellLife, or dates
  • Validation Rules:
    • The rows array must contain at least 1 object and no more than 100 objects.
    • The object must have exactly one of the following properties: pctPerYear or dollarPerYear.
    • The object must have exactly one of the following properties: monthPeriod, entireWellLife, or dates.
    • The values of pctPerYear and dollarPerYear must be within their respective minimum and maximum ranges.
    • The monthPeriod value must be between 1 and 1200.
    • The dates value must be a date between January 1, 1900 and April 1, 2262 in YYYY-MM-DD format.

escalationFrequency (required)​

A string that describes the frequency of escalation.

  • Data Type: string
  • Enumeration:
    • monthly
    • yearly
    • constant

calculationMethod (required)​

A string that describes the method of differential calculation.

  • Data Type: string
  • Enumeration:
    • simple
    • compound

Definitions​

PctPerYear​

A number that describes the percent per year escalation.

  • Data Type: number
  • Minimum Value: -10000
  • Maximum Value: 10000
  • Minimum Decimal Precision: 0.000001

DollarPerYear​

A number that describes the dollar per year escalation.

  • Data Type: number
  • Minimum Value: -100000000
  • Maximum Value: 100000000
  • Minimum Decimal Precision: 0.000001

Rows Validation

monthPeriod​

  • Data Type: number
  • value must be between 1 and 1200.

entireWellLife​

  • A string that is an enum with a value of "Flat".
dates​
  • Data Type: string
  • Validation Rules:
    • The value must be a date between January 1, 1900 and April 1, 2262 in the format YYYY-MM-DD.
    • each dates property must have a "01" for the days. Ex: "2020-05-01"
    • The value for each dates property in the rows array must be at minimum one month later than the previous dates property. For Example: 
      "rows": [
              {
                  "dates": "2020-01-01",
                  "pctOfBasePrice": 1000000
              },
              {
                  "dates": "2020-02-01",
                  "pctOfBasePrice": 0.123456
              },
              {
                  "dates": "2021-02-01",
                  "pctOfBasePrice": 0
              }
      ]

Example

"escalation": {
    "rows": [
        {
            "pctPerYear": 12,
            "monthPeriod": 1
        },
        {
            "pctPerYear": 32,
            "monthPeriod":5
        },
        {
            "pctPerYear": 57.665,
            "monthPeriod": 3
        }
    ],
    "escalationFrequency": "monthly",
    "calculationMethod": "compound"
}