ProfitLossReport

  • capex
    Type: object
    required

    Capital spend broken out by account (e.g. intangible drilling, tangible drilling & completion). Excluded from expenses.total and netIncome.

    • accounts
      Type: array object[] · PnlRow[]
      required

      One report line — a per-month breakdown plus a period total.

    • total
      Type: object · PnlRow
      required

      One report line — a per-month breakdown plus a period total.

  • cashFlow
    Type: object
    required

    Money actually moved in the period, independent of the accrual/interest bases. Cash in = revenue received (statement net payment by check date); cash out = bills paid (by paid date, including CapEx).

    • cashIn
      Type: object · PnlRow
      required

      One report line — a per-month breakdown plus a period total.

    • cashOut
      Type: object · PnlRow
      required

      One report line — a per-month breakdown plus a period total.

    • netCash
      Type: object · PnlRow
      required

      One report line — a per-month breakdown plus a period total.

  • expenses
    Type: object
    required

    Operating expenses only. CapEx is reported separately under capex.

    • groups
      Type: array object[] · PnlExpenseGroup[]
      required

      Operating-expense report group (e.g. Lease Operating Expense) with its accounts.

    • total
      Type: object · PnlRow
      required

      One report line — a per-month breakdown plus a period total.

  • meta
    Type: object
    required

    The resolved parameters this report was computed with.

    • endDate
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • expenseDateBasis
      Type: string enum
      values
      • invoice
      • paid
    • interestBasis
      Type: string enum
      values
      • owner
      • eightEighths
    • revenueDateBasis
      Type: string enum
      values
      • production
      • check
    • startDate
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • wellIds
      Type: array string[] | null
  • months
    Type: array string[]
    required

    "YYYY-MM" month keys, ascending. Every row's byMonth is keyed by these.

  • netIncome
    Type: object · PnlRow
    required

    Net Revenue − Operating Expenses (excludes CapEx).

    • byMonth
      Type: object
      required

      Amount per month, keyed by "YYYY-MM" (matching the report's months).

    • id
      Type: string
      required
    • label
      Type: string
      required
    • total
      Type: number
      required
  • revenue
    Type: object
    required
    • byProduct
      Type: array object[] · PnlRow[]
      required

      One report line — a per-month breakdown plus a period total.

    • deductions
      Type: object · PnlRow
      required

      One report line — a per-month breakdown plus a period total.

    • grossTotal
      Type: object · PnlRow
      required

      One report line — a per-month breakdown plus a period total.

    • netTotal
      Type: object · PnlRow
      required

      One report line — a per-month breakdown plus a period total.

    • taxes
      Type: object · PnlRow
      required

      One report line — a per-month breakdown plus a period total.