> ## 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. # List the network's plans > Returns the plans this network is deciding on, SOONEST DEADLINE FIRST — the order the morning question asks for (« lesquels de mes plans ont besoin de moi aujourd'hui »), not an alphabetical convenience; an undated plan sorts last, never first. Narrow with `family`, with `status` — a status of THAT family's own lifecycle, since the six do not share one — and with `openOnly=true` to drop what is closed or cancelled. Page with `page`/`pageSize` (max 100). ## OpenAPI ````yaml /openapi.json get /v1/plans 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: get: tags: - Procurement summary: List the network's plans description: >- Returns the plans this network is deciding on, SOONEST DEADLINE FIRST — the order the morning question asks for (« lesquels de mes plans ont besoin de moi aujourd'hui »), not an alphabetical convenience; an undated plan sorts last, never first. Narrow with `family`, with `status` — a status of THAT family's own lifecycle, since the six do not share one — and with `openOnly=true` to drop what is closed or cancelled. Page with `page`/`pageSize` (max 100). operationId: listPlans parameters: - schema: default: 1 type: integer minimum: 1 maximum: 9007199254740991 in: query name: page required: false description: 1-based page index to return. Defaults to 1. - schema: default: 20 type: integer minimum: 1 maximum: 100 in: query name: pageSize required: false description: Rows per page, 1..100. Defaults to 20. - schema: type: string enum: - restock - rebalance - markdown - pre_season_order - supplier_return - supplier_exchange in: query name: family required: false description: >- One of the six families: `restock`, `rebalance`, `markdown`, `pre_season_order`, `supplier_return`, `supplier_exchange`. Omit to list every family. - schema: type: string enum: - DRAFT - VALIDATED - SENT - RECEIVED - PROPOSED - AGREED - IN_TRANSIT - SETTLED - CREDITED - CLOSED - CANCELLED in: query name: status required: false description: >- A status of THAT family's own lifecycle — the six do not share one. Omit for any status. - schema: type: string enum: - 'true' - 'false' in: query name: openOnly required: false description: >- `true` keeps only the plans that are still live (not `CLOSED`, not `CANCELLED`) — what the morning list asks for. Omit or `false` for the whole history. responses: '200': description: A page of plans, soonest deadline first, with the pagination totals. content: application/json: schema: type: object properties: items: type: array items: 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 rows on this page, in the query's sort order. total: type: integer minimum: 0 maximum: 9007199254740991 description: >- Total rows matching the filter across ALL pages, not just this one. page: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 description: The 1-based page number served. pageSize: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 description: Rows requested per page. pageCount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Total number of pages; stop walking when `page` reaches it. required: - items - total - page - pageSize - pageCount additionalProperties: false description: >- A page of plans, soonest deadline first, with the pagination totals. example: items: - 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 total: 1 page: 1 pageSize: 20 pageCount: 1 '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' '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 `. 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. ````