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

# Edit a draft plan

> Changes the name, the notes or the deadline of a plan that is still a `DRAFT`. NOT the family, NOT the supplier, NOT the shops, NOT the status — re-pointing a validated restock at another supplier would keep the reference, the lines and the history while changing who is owed the money. Once a plan has left `DRAFT` its name is part of what was agreed to, so this 422s. `expectedVersion` is required: send the `version` you read.



## OpenAPI

````yaml /openapi.json patch /v1/plans/{planId}
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/plans/{planId}:
    patch:
      tags:
        - Procurement
      summary: Edit a draft plan
      description: >-
        Changes the name, the notes or the deadline of a plan that is still a
        `DRAFT`. NOT the family, NOT the supplier, NOT the shops, NOT the status
        — re-pointing a validated restock at another supplier would keep the
        reference, the lines and the history while changing who is owed the
        money. Once a plan has left `DRAFT` its name is part of what was agreed
        to, so this 422s. `expectedVersion` is required: send the `version` you
        read.
      operationId: editPlan
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: planId
          required: true
          description: The plan id, e.g. `plan-restock-aigle-32`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                expectedVersion:
                  type: integer
                  minimum: 0
                  exclusiveMinimum: true
                  maximum: 9007199254740991
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                notes:
                  nullable: true
                  type: string
                  maxLength: 10000
                deadline:
                  nullable: true
                  type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
              required:
                - expectedVersion
              example:
                expectedVersion: 1
                name: Réassort Aigle — semaine 33 (corrigé)
                notes: Fenêtre de commande décalée d'un jour par le fournisseur.
      responses:
        '200':
          description: The plan as persisted, at its new version.
          content:
            application/json:
              schema:
                allOf:
                  - oneOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            minLength: 1
                          reference:
                            type: string
                            minLength: 1
                            maxLength: 64
                          name:
                            type: string
                            minLength: 1
                            maxLength: 255
                          notes:
                            nullable: true
                            type: string
                            maxLength: 10000
                          status:
                            type: string
                            enum:
                              - DRAFT
                              - VALIDATED
                              - SENT
                              - RECEIVED
                              - PROPOSED
                              - AGREED
                              - IN_TRANSIT
                              - SETTLED
                              - CREDITED
                              - CLOSED
                              - CANCELLED
                          ruleGroupId:
                            nullable: true
                            type: string
                            minLength: 1
                          deadline:
                            nullable: true
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                          issuedDocument:
                            nullable: true
                            type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - purchase_order
                                  - transfer
                                  - return_to_vendor
                                  - markdown_schedule
                              id:
                                type: string
                                minLength: 1
                            required:
                              - kind
                              - id
                            additionalProperties: false
                          version:
                            type: integer
                            minimum: 0
                            exclusiveMinimum: true
                            maximum: 9007199254740991
                          family:
                            type: string
                            enum:
                              - restock
                              - pre_season_order
                              - supplier_return
                              - supplier_exchange
                          supplierId:
                            type: string
                            minLength: 1
                          storeId:
                            nullable: true
                            type: string
                            minLength: 1
                        required:
                          - id
                          - reference
                          - name
                          - notes
                          - status
                          - ruleGroupId
                          - deadline
                          - issuedDocument
                          - version
                          - family
                          - supplierId
                          - storeId
                        additionalProperties: false
                      - type: object
                        properties:
                          id:
                            type: string
                            minLength: 1
                          reference:
                            type: string
                            minLength: 1
                            maxLength: 64
                          name:
                            type: string
                            minLength: 1
                            maxLength: 255
                          notes:
                            nullable: true
                            type: string
                            maxLength: 10000
                          status:
                            type: string
                            enum:
                              - DRAFT
                              - VALIDATED
                              - SENT
                              - RECEIVED
                              - PROPOSED
                              - AGREED
                              - IN_TRANSIT
                              - SETTLED
                              - CREDITED
                              - CLOSED
                              - CANCELLED
                          ruleGroupId:
                            nullable: true
                            type: string
                            minLength: 1
                          deadline:
                            nullable: true
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                          issuedDocument:
                            nullable: true
                            type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - purchase_order
                                  - transfer
                                  - return_to_vendor
                                  - markdown_schedule
                              id:
                                type: string
                                minLength: 1
                            required:
                              - kind
                              - id
                            additionalProperties: false
                          version:
                            type: integer
                            minimum: 0
                            exclusiveMinimum: true
                            maximum: 9007199254740991
                          family:
                            type: string
                            enum:
                              - rebalance
                          outgoingStoreId:
                            type: string
                            minLength: 1
                          incomingStoreId:
                            type: string
                            minLength: 1
                        required:
                          - id
                          - reference
                          - name
                          - notes
                          - status
                          - ruleGroupId
                          - deadline
                          - issuedDocument
                          - version
                          - family
                          - outgoingStoreId
                          - incomingStoreId
                        additionalProperties: false
                      - type: object
                        properties:
                          id:
                            type: string
                            minLength: 1
                          reference:
                            type: string
                            minLength: 1
                            maxLength: 64
                          name:
                            type: string
                            minLength: 1
                            maxLength: 255
                          notes:
                            nullable: true
                            type: string
                            maxLength: 10000
                          status:
                            type: string
                            enum:
                              - DRAFT
                              - VALIDATED
                              - SENT
                              - RECEIVED
                              - PROPOSED
                              - AGREED
                              - IN_TRANSIT
                              - SETTLED
                              - CREDITED
                              - CLOSED
                              - CANCELLED
                          ruleGroupId:
                            nullable: true
                            type: string
                            minLength: 1
                          deadline:
                            nullable: true
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                          issuedDocument:
                            nullable: true
                            type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - purchase_order
                                  - transfer
                                  - return_to_vendor
                                  - markdown_schedule
                              id:
                                type: string
                                minLength: 1
                            required:
                              - kind
                              - id
                            additionalProperties: false
                          version:
                            type: integer
                            minimum: 0
                            exclusiveMinimum: true
                            maximum: 9007199254740991
                          family:
                            type: string
                            enum:
                              - markdown
                          eventName:
                            type: string
                            minLength: 1
                            maxLength: 255
                          startsAt:
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                          endsAt:
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        required:
                          - id
                          - reference
                          - name
                          - notes
                          - status
                          - ruleGroupId
                          - deadline
                          - issuedDocument
                          - version
                          - family
                          - eventName
                          - startsAt
                          - endsAt
                        additionalProperties: false
                  - type: object
                    properties:
                      version:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                        maximum: 9007199254740991
                    required:
                      - version
                    additionalProperties: false
                description: The plan as persisted, at its new version.
                example:
                  id: plan-restock-aigle-32
                  family: restock
                  reference: RSA-26-0142
                  name: Réassort Aigle — semaine 32
                  notes: null
                  status: VALIDATED
                  ruleGroupId: null
                  deadline: '2026-08-14T16:00:00.000Z'
                  supplierId: sup-aigle
                  storeId: null
                  version: 3
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No resource matches the addressed identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            The request conflicts with current state (duplicate id or stale
            version).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The request is well-formed but violates a domain rule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````