Carboncuretechnologies myCC - Credits API

openapi: 3.2.0
info:
  title: Kelowna Production myCC - Credits API
  version: v1
tags:
- name: myCC - Credits
paths:
  /Accounts/{accountId}/Credits/CreditTable:
    get:
      tags:
      - myCC - Credits
      summary: Gets a table of credits
      parameters:
      - name: accountId
        in: path
        description: The account to get credits for.
        required: true
        schema:
          type: integer
          format: int32
      - name: Limit
        in: query
        description: Limit number of responses. Used for pagination.
        schema:
          type: integer
          format: int32
      - name: Offset
        in: query
        description: Skip this many rows in the query. Used for pagination.
        schema:
          type: integer
          format: int32
      - name: SortColumn
        in: query
        description: The name of the column to sort by.
        schema:
          type: string
      - name: SortOrder
        in: query
        description: The order with which to sort the table by the sort column.
        schema:
          $ref: '#/components/schemas/SortOrder'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreditTableTableResults'
            application/json:
              schema:
                $ref: '#/components/schemas/CreditTableTableResults'
            text/json:
              schema:
                $ref: '#/components/schemas/CreditTableTableResults'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsCreditTable
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/BatchingTable:
    get:
      tags:
      - myCC - Credits
      summary: Gets a table of batching file uploads
      parameters:
      - name: accountId
        in: path
        description: The account to get batching file uploads for.
        required: true
        schema:
          type: integer
          format: int32
      - name: Limit
        in: query
        description: Limit number of responses. Used for pagination.
        schema:
          type: integer
          format: int32
      - name: Offset
        in: query
        description: Skip this many rows in the query. Used for pagination.
        schema:
          type: integer
          format: int32
      - name: SortColumn
        in: query
        description: The name of the column to sort by.
        schema:
          type: string
      - name: SortOrder
        in: query
        description: The order with which to sort the table by the sort column.
        schema:
          $ref: '#/components/schemas/SortOrder'
      - name: searchKey
        in: query
        description: Search key that filters table results.
        schema:
          type: string
      - name: shouldIncludeErrors
        in: query
        description: Toggles ingestion errors. No errors is default.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/BatchingTableTableResults'
            application/json:
              schema:
                $ref: '#/components/schemas/BatchingTableTableResults'
            text/json:
              schema:
                $ref: '#/components/schemas/BatchingTableTableResults'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsBatchingTable
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/CO2Suppliers/{plantId}:
    get:
      tags:
      - myCC - Credits
      summary: Gets a list of co2 depots nearest to a plant
      description: Used for dropdowns.
      parameters:
      - name: plantId
        in: path
        description: The plant to get the nearest co2 depots for.
        required: true
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: The number of co2 depots to return.
        schema:
          type: integer
          format: int32
      - name: accountId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsCO2SuppliersByPlantId
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/GhgEmitters/{plantId}:
    get:
      tags:
      - myCC - Credits
      summary: Gets a list of co2 capture facilities nearest to a plant
      description: Used for dropdowns.
      parameters:
      - name: plantId
        in: path
        description: The plant to get the nearest co2 capture facilities for.
        required: true
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: The number of co2 capture facilities to return.
        schema:
          type: integer
          format: int32
      - name: accountId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items: {}
            application/json:
              schema:
                type: array
                items: {}
            text/json:
              schema:
                type: array
                items: {}
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsGhgEmittersByPlantId
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/Breakdown:
    get:
      tags:
      - myCC - Credits
      summary: Gets a breakdown of the credits for an account
      description: 'Credits are broken down into:


        "No Data" - estimated credits we could make from injections that we have no batching data for


        "Unvalidated" - we''ve gotten batching data but haven''t aggregated the data into credits


        "Validated" - credits that have been created but haven''t been sold yet


        "Sold" - credits that have been sold to a buyer'
      parameters:
      - name: accountId
        in: path
        description: The myCC account ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CreditBreakdown'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CreditBreakdown'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CreditBreakdown'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsBreakdown
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/ActionItems:
    get:
      tags:
      - myCC - Credits
      summary: Gets a list of action items for an account to obtain more credits
      parameters:
      - name: accountId
        in: path
        description: The myCC account ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ActionItems'
            application/json:
              schema:
                $ref: '#/components/schemas/ActionItems'
            text/json:
              schema:
                $ref: '#/components/schemas/ActionItems'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsActionItems
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/BatchingActionItems:
    get:
      tags:
      - myCC - Credits
      summary: Get a list of batching action items for an account to obtain more credits
      parameters:
      - name: accountId
        in: path
        description: The myCC account ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BatchingActionItem'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BatchingActionItem'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BatchingActionItem'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsBatchingActionItems
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/QcActionItems:
    get:
      tags:
      - myCC - Credits
      summary: Gets a list of QC action items for an account to obtain more credits
      parameters:
      - name: accountId
        in: path
        description: The myCC account ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/QcActionItem'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/QcActionItem'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/QcActionItem'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsQcActionItems
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/LynxInformationRequest:
    post:
      tags:
      - myCC - Credits
      summary: Sends lynx information request email the customer data project manager
      parameters:
      - name: accountId
        in: path
        description: The account for the which the support request is being sent.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: postAccountsByAccountIdCreditsLynxInformationRequest
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/CreditSummary:
    get:
      tags:
      - myCC - Credits
      summary: Summary of a customer's credit portfolio
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreditSummary'
            application/json:
              schema:
                $ref: '#/components/schemas/CreditSummary'
            text/json:
              schema:
                $ref: '#/components/schemas/CreditSummary'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsCreditSummary
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/CreditUpdate:
    get:
      tags:
      - myCC - Credits
      summary: Credit update for a specific user.
      description: Only meant for MyCC users, updates for staff users are always 0.
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreditUpdate'
            application/json:
              schema:
                $ref: '#/components/schemas/CreditUpdate'
            text/json:
              schema:
                $ref: '#/components/schemas/CreditUpdate'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsCreditUpdate
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/CreditSalesTable:
    get:
      tags:
      - myCC - Credits
      summary: Credit sale details table
      parameters:
      - name: accountId
        in: path
        description: Id of the mycc account
        required: true
        schema:
          type: integer
          format: int32
      - name: Limit
        in: query
        description: Limit number of responses. Used for pagination.
        schema:
          type: integer
          format: int32
      - name: Offset
        in: query
        description: Skip this many rows in the query. Used for pagination.
        schema:
          type: integer
          format: int32
      - name: SortColumn
        in: query
        description: The name of the column to sort by.
        schema:
          type: string
      - name: SortOrder
        in: query
        description: The order with which to sort the table by the sort column.
        schema:
          $ref: '#/components/schemas/SortOrder'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreditSalesTableTableResults'
            application/json:
              schema:
                $ref: '#/components/schemas/CreditSalesTableTableResults'
            text/json:
              schema:
                $ref: '#/components/schemas/CreditSalesTableTableResults'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsCreditSalesTable
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/CreditTransactionReceipt:
    get:
      tags:
      - myCC - Credits
      summary: Credit Transaction Receipt Pdf
      parameters:
      - name: accountId
        in: path
        description: id of the mycc account
        required: true
        schema:
          type: integer
          format: int32
      - name: creditTransactionId
        in: query
        description: id of the credit transaction
        schema:
          type: integer
          format: int32
      - name: languageStr
        in: query
        description: language the receipt should be in
        schema:
          type: string
      responses:
        '200':
          description: OK
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsCreditTransactionReceipt
      x-operation-id-source: derived
  /Accounts/{accountId}/Credits/EligibleLynxPlants:
    get:
      tags:
      - myCC - Credits
      summary: Returns list of plants eligible for Lynx that have not yet installed
      parameters:
      - name: accountId
        in: path
        description: ID of MyCC account
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlantNames'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlantNames'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlantNames'
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdCreditsEligibleLynxPlants
      x-operation-id-source: derived
components:
  schemas:
    BatchingDataStatus:
      enum:
      - Successful
      - MissingData
      - Error
      type: string
    CreditSummary:
      type: object
      properties:
        creditsToValidate:
          type: number
          format: double
        validatedCredits:
          type: number
          format: double
      additionalProperties: false
    CreditTable:
      type: object
      properties:
        creditId:
          type: integer
          format: int32
        creditUniqueId:
          type:
          - string
          - 'null'
        creationTimestamp:
          type: string
          format: date-time
        soldTimestamp:
          type:
          - string
          - 'null'
          format: date-time
        isSold:
          type: boolean
      additionalProperties: false
    SortOrder:
      enum:
      - Ascending
      - Descending
      type: string
    BatchingActionItem:
      type: object
      properties:
        startDate:
          type: string
          format: date
        endDate:
          type: string
          format: date
        estimatedCredits:
          type: number
          format: double
      additionalProperties: false
    CreditTableTableResults:
      type: object
      properties:
        count:
          type: integer
          format: int32
        results:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreditTable'
      additionalProperties: false
    CreditBreakdown:
      type: object
      properties:
        category:
          type:
          - string
          - 'null'
        totalCredits:
          type:
          - number
          - 'null'
          format: double
      additionalProperties: false
    CreditSalesTableTableResults:
      type: object
      properties:
        count:
          type: integer
          format: int32
        results:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreditSalesTable'
      additionalProperties: false
    BatchingTableTableResults:
      type: object
      properties:
        count:
          type: integer
          format: int32
        results:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BatchingTable'
      additionalProperties: false
    QcActionItem:
      type: object
      properties:
        mixCode:
          type:
          - string
          - 'null'
        estimatedCredits:
          type: number
          format: double
      additionalProperties: false
    CreditSalesTable:
      type: object
      properties:
        creditTransactionId:
          type: integer
          format: int32
        creditAmount:
          type: integer
          format: int32
        hasDetailsAvailable:
          type: boolean
        date:
          type: string
          format: date
      additionalProperties: false
    CreditUpdate:
      type: object
      properties:
        validatedCredits:
          type: integer
          format: int32
        soldCredits:
          type: integer
          format: int32
      additionalProperties: false
    PlantNames:
      type: object
      properties:
        plantId:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
    ActionItems:
      type: object
      properties:
        batchingActions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BatchingActionItem'
        qcActions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/QcActionItem'
        showSourcesAction:
          type: boolean
      additionalProperties: false
    BatchingTable:
      type: object
      properties:
        uploadLogId:
          type: integer
          format: int32
        status:
          $ref: '#/components/schemas/BatchingDataStatus'
        source:
          type:
          - string
          - 'null'
        fileName:
          type:
          - string
          - 'null'
        uploadTimestamp:
          type:
          - string
          - 'null'
          format: date-time
        timeframe:
          type:
          - string
          - 'null'
      additionalProperties: false
  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: {}