> ## 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.

# Accrue loyalty points for a sale

> Appends an EARN entry to a customer's ledger for a settled sale. `subtotalCents` is the sale subtotal in integer cents; the points granted follow the active program's `accrualPointsPerCent`. `entryId` is the IDEMPOTENCY KEY: supply the sale's own stable id and a replay returns 409 instead of double-crediting; omit it and the server mints a UUID — never invent a key from a client-side counter, which collides across sessions. 422 when the subtotal is too small to earn a whole point.



## OpenAPI

````yaml /openapi.json post /v1/loyalty/accruals
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/loyalty/accruals:
    post:
      tags:
        - Loyalty
      summary: Accrue loyalty points for a sale
      description: >-
        Appends an EARN entry to a customer's ledger for a settled sale.
        `subtotalCents` is the sale subtotal in integer cents; the points
        granted follow the active program's `accrualPointsPerCent`. `entryId` is
        the IDEMPOTENCY KEY: supply the sale's own stable id and a replay
        returns 409 instead of double-crediting; omit it and the server mints a
        UUID — never invent a key from a client-side counter, which collides
        across sessions. 422 when the subtotal is too small to earn a whole
        point.
      operationId: accrueLoyaltyPoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entryId:
                  type: string
                  minLength: 1
                customerId:
                  type: string
                  minLength: 1
                subtotalCents:
                  type: integer
                  minimum: 0
                  exclusiveMinimum: true
                  maximum: 9007199254740991
              required:
                - customerId
                - subtotalCents
              example:
                customerId: cust-1
                subtotalCents: 10000
      responses:
        '201':
          description: 'The appended accrual entry (`kind: "accrual"`).'
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                  customerId:
                    type: string
                    minLength: 1
                  kind:
                    type: string
                    enum:
                      - accrual
                      - redemption
                  points:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 9007199254740991
                  valueCents:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  at:
                    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
                  - customerId
                  - kind
                  - points
                  - valueCents
                  - at
                additionalProperties: false
                description: 'The appended accrual entry (`kind: "accrual"`).'
                example:
                  id: b8f1c0d2-6d4f-4a2b-9c31-0f7a2e5d1a94
                  customerId: cust-1
                  kind: accrual
                  points: 100
                  valueCents: 10000
                  at: '2026-07-28T09:00:00.000Z'
        '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'
        '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.

````