openapi: 3.1.0
info:
  title: Salesforce Net Zero Cloud REST Carbon Emissions Water Usage API
  description: REST API for managing carbon emissions data, sustainability records, and environmental impact tracking within Salesforce Net Zero Cloud. Provides programmatic access to carbon accounting, ESG reporting, energy consumption, waste management, and supply chain emissions data.
  version: 59.0.0
  termsOfService: https://www.salesforce.com/company/legal/agreements/
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Master Subscription Agreement
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.my.salesforce.com/services/data/v59.0
  description: Salesforce Production Instance
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Water Usage
  description: Water consumption tracking
paths:
  /sobjects/WaterWithdrawal:
    get:
      operationId: listWaterWithdrawalRecords
      summary: List Water Withdrawal Records
      description: Retrieves water withdrawal and consumption records from various sources such as municipal supply, groundwater, and rainwater.
      tags:
      - Water Usage
      responses:
        '200':
          description: Successfully retrieved water withdrawal records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WaterWithdrawalListResponse'
    post:
      operationId: createWaterWithdrawalRecord
      summary: Create Water Withdrawal Record
      description: Creates a new water withdrawal record.
      tags:
      - Water Usage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WaterWithdrawalInput'
      responses:
        '201':
          description: Water withdrawal record created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateResponse'
components:
  schemas:
    CreateResponse:
      type: object
      properties:
        id:
          type: string
        success:
          type: boolean
        errors:
          type: array
          items:
            type: string
    WaterWithdrawalListResponse:
      type: object
      properties:
        totalSize:
          type: integer
        done:
          type: boolean
        records:
          type: array
          items:
            $ref: '#/components/schemas/WaterWithdrawal'
    WaterWithdrawal:
      type: object
      properties:
        Id:
          type: string
        Name:
          type: string
        WaterSource:
          type: string
          enum:
          - MunicipalWater
          - Groundwater
          - SurfaceWater
          - Rainwater
          - Recycled
        QuantityCubicMeters:
          type: number
        FacilityId:
          type: string
        ReportingYear:
          type: integer
    WaterWithdrawalInput:
      type: object
      required:
      - WaterSource
      - QuantityCubicMeters
      - ReportingYear
      properties:
        WaterSource:
          type: string
        QuantityCubicMeters:
          type: number
        FacilityId:
          type: string
        ReportingYear:
          type: integer
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your data
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Salesforce Net Zero Cloud API Developer Guide
  url: https://developer.salesforce.com/docs/atlas.en-us.netzero_api.meta/netzero_api/