openapi: 3.2.0
info:
  title: Kelowna Production Profitability API
  version: v1
tags:
- name: Profitability
paths:
  /Profitability/SetPricesMetric:
    post:
      tags:
      - Profitability
      summary: Updates material (and tank) prices using metric units
      description: 'Please fill in ONLY division name or ONLY country (with optional state) but not both.


        Leaving a price blank means it will be unchanged in the DB. This interface does not support clearing out data.'
      parameters:
      - name: DivisionName
        in: query
        description: The division to set prices for
        schema:
          type: string
      - name: Country
        in: query
        description: The country to set prices for
        schema:
          type: string
      - name: State
        in: query
        description: The state to set prices for (optional addition to country)
        schema:
          type: string
      - name: EffectiveDate
        in: query
        description: The date (YYYY-MM-DD) these prices took effect (note that later prices in the database will be overridden!)
        schema:
          type: string
          format: date
      - name: CementPriceUsdPerTonne
        in: query
        description: Cement price (USD/metric ton)
        schema:
          type: number
          format: double
      - name: SandPriceUsdPerTonne
        in: query
        description: Sand price (USD/metric ton)
        schema:
          type: number
          format: double
      - name: SlagPriceUsdPerTonne
        in: query
        description: Slag price (USD/metric ton)
        schema:
          type: number
          format: double
      - name: FlyAshPriceUsdPerTonne
        in: query
        description: Fly ash price (USD/metric ton)
        schema:
          type: number
          format: double
      - name: CO2PriceUsdPerKg
        in: query
        description: CO2 price (USD/kg)
        schema:
          type: number
          format: double
      - name: TankRentalPriceUsdPerMonth
        in: query
        description: Tank rental price (USD per system per month)
        schema:
          type: number
          format: double
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: postProfitabilitySetPricesMetric
      x-operation-id-source: derived
  /Profitability/SetPricesImperial:
    post:
      tags:
      - Profitability
      summary: Updates material (and tank) prices using imperial units
      description: 'Please fill in ONLY division name or ONLY country (with optional state) but not both.


        Leaving a price blank means it will be unchanged in the DB. This interface does not support clearing out data.'
      parameters:
      - name: DivisionName
        in: query
        description: The division to set prices for
        schema:
          type: string
      - name: Country
        in: query
        description: The country to set prices for
        schema:
          type: string
      - name: State
        in: query
        description: The state to set prices for (optional addition to country)
        schema:
          type: string
      - name: EffectiveDate
        in: query
        description: The date (YYYY-MM-DD) these prices took effect (note that later prices in the database will be overridden!)
        schema:
          type: string
          format: date
      - name: CementPriceUsdPerTon
        in: query
        description: Cement price (USD/ton)
        schema:
          type: number
          format: double
      - name: SandPriceUsdPerTon
        in: query
        description: Sand price (USD/ton)
        schema:
          type: number
          format: double
      - name: SlagPriceUsdPerTon
        in: query
        description: Slag price (USD/ton)
        schema:
          type: number
          format: double
      - name: FlyAshPriceUsdPerTon
        in: query
        description: Fly ash price (USD/ton)
        schema:
          type: number
          format: double
      - name: CO2PriceUsdPerLb
        in: query
        description: CO2 price (USD/lb)
        schema:
          type: number
          format: double
      - name: TankRentalPriceUsdPerMonth
        in: query
        description: Tank rental price (USD per system per month)
        schema:
          type: number
          format: double
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: postProfitabilitySetPricesImperial
      x-operation-id-source: derived
  /Profitability/DivisionNames:
    get:
      tags:
      - Profitability
      summary: Gets list of division names
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: getProfitabilityDivisionNames
      x-operation-id-source: derived
components:
  securitySchemes:
    OrcaAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}
    MyCCAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}
    M2MAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}