openapi: 3.1.0
info:
  title: Salesforce Net Zero Cloud REST Carbon Emissions Sustainability Goals 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: Sustainability Goals
  description: Net zero and sustainability target management
paths:
  /sobjects/SustainabilityGoal:
    get:
      operationId: listSustainabilityGoals
      summary: List Sustainability Goals
      description: Retrieves sustainability goals and net zero targets, including current progress, baseline years, and target years.
      tags:
      - Sustainability Goals
      responses:
        '200':
          description: Successfully retrieved sustainability goals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SustainabilityGoalListResponse'
    post:
      operationId: createSustainabilityGoal
      summary: Create Sustainability Goal
      description: Creates a new sustainability goal or net zero commitment with target metrics and timeline.
      tags:
      - Sustainability Goals
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SustainabilityGoalInput'
      responses:
        '201':
          description: Sustainability goal created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateResponse'
components:
  schemas:
    SustainabilityGoalInput:
      type: object
      required:
      - GoalType
      - BaselineYear
      - TargetYear
      properties:
        Name:
          type: string
        GoalType:
          type: string
        BaselineYear:
          type: integer
        TargetYear:
          type: integer
        ReductionTargetPercentage:
          type: number
    SustainabilityGoalListResponse:
      type: object
      properties:
        totalSize:
          type: integer
        done:
          type: boolean
        records:
          type: array
          items:
            $ref: '#/components/schemas/SustainabilityGoal'
    SustainabilityGoal:
      type: object
      properties:
        Id:
          type: string
        Name:
          type: string
        GoalType:
          type: string
          enum:
          - NetZero
          - CarbonNeutral
          - ScienceBasedTarget
          - RenewableEnergy
          - WasteReduction
          - WaterReduction
        BaselineYear:
          type: integer
        TargetYear:
          type: integer
        ReductionTargetPercentage:
          type: number
        CurrentProgressPercentage:
          type: number
        Status:
          type: string
          enum:
          - Active
          - Achieved
          - Missed
          - InProgress
    CreateResponse:
      type: object
      properties:
        id:
          type: string
        success:
          type: boolean
        errors:
          type: array
          items:
            type: string
  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/