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

# Abrechnungswerte abrufen



## OpenAPI

````yaml GET /payroll/settlements/{yearMonth}
openapi: 3.1.0
info:
  title: Stampfactory API
  version: 1.0.0
  description: >-
    REST API für die Stampfactory Zeiterfassungs- und
    Personalverwaltungsplattform.


    ## Basis-URL


    Jeder Mandant hat eine eigene Subdomain: `https://{tenant}.stamp.eu/rest/…`.

    Custom Domains werden unterstützt; der Pfad-Präfix ist immer `/rest`.

    Authentifizierung über `POST /rest/login` (Bearer-Token, Laravel Sanctum).


    ## Datenformate (verbindlich, ADR 0005)


    | Typ | Format | Beispiel |

    |---|---|---|

    | Dauer (Anzeige) | String `HH:MM:SS.mmm`, Feldname ohne Suffix |
    `"08:00:00.000"` |

    | Dauer (Rohwert) | Integer Millisekunden, Feldname mit Suffix `_ms` |
    `28800000` |

    | Datum | ISO 8601 (`YYYY-MM-DD`) | `"2026-07-25"` |

    | Fachliche Zeitstempel (Stempelungen, Korrekturen) | ISO 8601 in
    Mandanten-Zeitzone | `"2026-07-25T08:00:00+02:00"` |

    | Technische Metadaten (`created_at`, `updated_at`) | ISO 8601 UTC |
    `"2026-07-25T06:00:00+00:00"` |

    | IDs | UUID bzw. TypeID-String | `"9d3f…"` |

    | Arbeitszeit-Flags | Integer-Bitmaske (`flags`), Bits siehe
    `WorkingTimeFlag` | `512` = Feiertag |

    | Monats-Perioden | `YYYY-MM` | `"2026-07"` |


    ## Responses


    Erfolgs-Responses liefern die fachliche Payload unter `data`

    (dokumentierte Ausnahmen: `POST /rest/terminal/{code}` und `/rest/mobile`).

    Listen sind, wo paginiert, im Laravel-Paginator-Format (`data` + `links` +
    `meta`).


    ## Fehlerformat


    Alle Fehler (4xx/5xx) folgen einem einheitlichen Envelope:


    ```json

    {
      "request_id": "…",
      "timestamp": "2026-07-25T06:00:00Z",
      "message": "Menschlich lesbare Meldung",
      "field_errors": { "feld": ["Meldung"] },
      "errors": [{ "title": "…", "detail": "…", "type": "https://docs.stampfactory.eu/errors#…", "_meta": { } }]
    }

    ```


    `field_errors` erscheint bei Validierungsfehlern (422). Endpoint-spezifische

    Zusatzdaten (z. B. `warnings`, `earliest`, `code`) stehen kanonisch in

    `errors[0]._meta`; Top-Level-Duplikate sind eine
    Übergangs-Kompatibilitätsschicht.

    Die `type`-URLs verlinken auf die Fehlerdokumentation.
servers:
  - url: https://{tenant}.stamp.eu/rest
    description: Production
    variables:
      tenant:
        default: demo
        description: Subdomain des Mandanten
security:
  - http: []
paths:
  /payroll/settlements/{yearMonth}:
    get:
      tags:
        - Sonstiges
      summary: GET /rest/payroll/settlements/{yearMonth}
      operationId: tenant.payroll.settlements.index
      parameters:
        - name: yearMonth
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      enabled:
                        type: boolean
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/HourlyWageSettlementResource'
                      year_month:
                        type: string
                      period:
                        type: object
                        properties:
                          status:
                            type: string
                            enum:
                              - closed
                              - open
                        required:
                          - status
                    required:
                      - enabled
                      - data
                      - year_month
                      - period
                  - type: object
                    properties:
                      enabled:
                        type: boolean
                      data:
                        type: array
                        items:
                          type: string
                        minItems: 0
                        maxItems: 0
                        additionalItems: false
                    required:
                      - enabled
                      - data
        '401':
          $ref: '#/components/responses/AuthenticationException'
components:
  schemas:
    HourlyWageSettlementResource:
      type: object
      properties:
        id:
          type: string
        employee_id:
          type: string
        employee_name:
          type: string
        reference_no:
          type: string
        year_month:
          type: string
        hours:
          type: object
          properties:
            worked:
              type: string
            vacation:
              type: string
            illness:
              type: string
            holiday:
              type: string
            other:
              type: string
            correction:
              type: string
            total:
              type: string
          required:
            - worked
            - vacation
            - illness
            - holiday
            - other
            - correction
            - total
        hourly_rate_cents:
          type: string
        amount_cents:
          type: integer
        rate_missing:
          type: boolean
        segments:
          anyOf:
            - type: string
            - type: array
              items:
                type: string
              minItems: 0
              maxItems: 0
              additionalItems: false
        corrections:
          anyOf:
            - type: string
            - type: array
              items:
                type: string
              minItems: 0
              maxItems: 0
              additionalItems: false
        warnings:
          anyOf:
            - type: string
            - type: array
              items:
                type: string
              minItems: 0
              maxItems: 0
              additionalItems: false
        minijob:
          type:
            - object
            - 'null'
          properties:
            limit_cents:
              type: integer
            utilization:
              type: number
          required:
            - limit_cents
            - utilization
        settled_at:
          type: string
      required:
        - id
        - employee_id
        - employee_name
        - reference_no
        - year_month
        - hours
        - hourly_rate_cents
        - amount_cents
        - rate_missing
        - segments
        - corrections
        - warnings
        - minijob
        - settled_at
      title: HourlyWageSettlementResource
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
  securitySchemes:
    http:
      type: http
      description: Bearer-Token, erhalten über den Login-Endpunkt (POST /rest/login).
      scheme: bearer

````