> ## 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 companies (sociétés) the network trades under

> Returns one page of the LEGAL ENTITIES fiscal documents are issued in the name of, each with the identity version currently in force. A société is NOT an enseigne (banner): a store carries a société (mandatory) and a banner (optional), and they are different questions — the banner hierarchy is `/v1/company/*`, this is the fiscal axis. On a freshly migrated environment this returns exactly one row, the placeholder « Société à compléter », to which every existing store is attached. Page with `page`/`pageSize` (max 100) until `page` reaches `pageCount`.



## OpenAPI

````yaml /openapi.json get /v1/companies
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/companies:
    get:
      tags:
        - Network
      summary: List the companies (sociétés) the network trades under
      description: >-
        Returns one page of the LEGAL ENTITIES fiscal documents are issued in
        the name of, each with the identity version currently in force. A
        société is NOT an enseigne (banner): a store carries a société
        (mandatory) and a banner (optional), and they are different questions —
        the banner hierarchy is `/v1/company/*`, this is the fiscal axis. On a
        freshly migrated environment this returns exactly one row, the
        placeholder « Société à compléter », to which every existing store is
        attached. Page with `page`/`pageSize` (max 100) until `page` reaches
        `pageCount`.
      operationId: listCompanies
      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.
      responses:
        '200':
          description: A page of sociétés with the pagination totals.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        entity:
                          type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            country:
                              type: string
                              pattern: ^[A-Z]{2}$
                            currentVersion:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              maximum: 9007199254740991
                          required:
                            - id
                            - country
                            - currentVersion
                          additionalProperties: false
                        current:
                          type: object
                          properties:
                            legalEntityId:
                              type: string
                              minLength: 1
                            version:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              maximum: 9007199254740991
                            effectiveFrom:
                              type: string
                              minLength: 1
                            fingerprint:
                              type: string
                              minLength: 1
                            identity:
                              type: object
                              properties:
                                legalName:
                                  type: string
                                  minLength: 1
                                legalForm:
                                  type: string
                                  minLength: 1
                                registrationNumber:
                                  type: string
                                  minLength: 1
                                vatNumber:
                                  type: string
                                  minLength: 1
                                shareCapitalCents:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                registryLabel:
                                  type: string
                                  minLength: 1
                                address:
                                  type: object
                                  properties:
                                    lines:
                                      type: array
                                      items:
                                        type: string
                                        minLength: 1
                                    postalCode:
                                      type: string
                                      minLength: 1
                                    city:
                                      type: string
                                      minLength: 1
                                    country:
                                      type: string
                                      pattern: ^[A-Z]{2}$
                                  required:
                                    - lines
                                    - country
                                  additionalProperties: false
                                phone:
                                  type: string
                                  minLength: 1
                                email:
                                  type: string
                                  minLength: 1
                                statutoryMentions:
                                  type: array
                                  items:
                                    type: string
                                    minLength: 1
                              required:
                                - legalName
                                - address
                              additionalProperties: false
                          required:
                            - legalEntityId
                            - version
                            - effectiveFrom
                            - fingerprint
                            - identity
                          additionalProperties: false
                      required:
                        - entity
                        - current
                      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 sociétés with the pagination totals.
                example:
                  items:
                    - entity:
                        id: le-solya
                        country: FR
                        currentVersion: 1
                      current:
                        legalEntityId: le-solya
                        version: 1
                        effectiveFrom: '2026-02-01T09:00:00.000Z'
                        fingerprint: >-
                          9f2c1a5b7e0d4c3f8a6b2e1d9c0f7a4b5e3d2c1f0a9b8c7d6e5f4a3b2c1d0e9f
                        identity:
                          legalName: Solya Retail
                          legalForm: SAS
                          registrationNumber: '732829320'
                          vatNumber: FR44732829320
                          shareCapitalCents: 1000000
                          registryLabel: RCS Paris 732 829 320
                          address:
                            lines:
                              - 12 rue de Rivoli
                            postalCode: '75001'
                            city: Paris
                            country: FR
                          statutoryMentions:
                            - TVA non applicable, art. 293 B du CGI
                  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 <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.

````