> ## Documentation Index
> Fetch the complete documentation index at: https://docs.energy.nlead.ch/llms.txt
> Use this file to discover all available pages before exploring further.

# Put Rahmenvertrag

> Record a framework contract with this partner. The Quittungs-
Nachfass then names it: the missing acknowledgment belongs to a
relationship the partner entered deliberately, not to a first
contact.



## OpenAPI

````yaml /setup/internal-openapi.json put /v1/process/market-partners/{key}/rahmenvertrag
openapi: 3.1.0
info:
  title: n:lead Scheduling Bridge — Internal API
  version: 0.4.0
  description: >-
    Internal API of the n:lead scheduling bridge: the process endpoints that
    drive the day-ahead pipeline (aggregate, publish the open position, submit
    schedules, generate forecasts, orchestrate) and the operator console
    endpoints. Requires the process API key; not for customer use.
servers:
  - url: https://{host}
    description: Deployed service
    variables:
      host:
        default: api.energy.nlead.ch
        description: >-
          The service hostname - n:lead provides it (see the Base URL on the API
          introduction page)
  - url: http://localhost:8000
    description: Local development
security: []
paths:
  /v1/process/market-partners/{key}/rahmenvertrag:
    put:
      summary: Put Rahmenvertrag
      description: |-
        Record a framework contract with this partner. The Quittungs-
        Nachfass then names it: the missing acknowledgment belongs to a
        relationship the partner entered deliberately, not to a first
        contact.
      operationId: put_rahmenvertrag_v1_process_market_partners__key__rahmenvertrag_put
      parameters:
        - name: key
          in: path
          required: true
          schema:
            type: string
            title: Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RahmenvertragRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RahmenvertragResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    RahmenvertragRequest:
      properties:
        reason:
          type: string
          maxLength: 300
          minLength: 3
          title: Reason
          description: >-
            Where the contract is recorded, e.g. 'VNB-Kampagne, Spalte Status:
            Vertrag geschlossen, Stand 11.09.2026'
      type: object
      required:
        - reason
      title: RahmenvertragRequest
      description: |-
        Record that a Lieferantenrahmenvertrag with this partner exists.

        A framework contract changes what a chase may assume: the two houses
        have a contract, so a missing acknowledgment is not the silence of a
        stranger. The Quittungs-Nachfass says so, and the Nachversand may
        lean on it as evidence that the partner knows us.
    RahmenvertragResponse:
      properties:
        mp_id:
          type: string
          title: Mp Id
        name:
          type: string
          title: Name
          description: Partner name from the registry, may be empty
        reason:
          type: string
          title: Reason
        noted_at:
          type: string
          title: Noted At
      type: object
      required:
        - mp_id
        - name
        - reason
        - noted_at
      title: RahmenvertragResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    HTTPBearer:
      type: http
      description: OIDC access token (Auth0 M2M)
      scheme: bearer

````