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

# Zuschlagsabrechnung abrufen



## OpenAPI

````yaml GET /surcharge_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:
  /surcharge_settlements/{yearMonth}:
    get:
      tags:
        - Sonstiges
      summary: GET /rest/surcharge_settlements/{yearMonth}
      operationId: tenant.surcharge_settlements.index
      parameters:
        - name: yearMonth
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        employee:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            surname:
                              type: string
                          required:
                            - id
                            - name
                            - surname
                        positions:
                          type: array
                          items:
                            $ref: '#/components/schemas/SurchargeSettlementResource'
                        totals:
                          type: object
                          properties:
                            hours_ms:
                              type: integer
                            amount_cents:
                              type: integer
                            amount:
                              type: string
                            tax_free_cents:
                              type: integer
                            taxable_cents:
                              type: integer
                            rate_missing:
                              type: boolean
                          required:
                            - hours_ms
                            - amount_cents
                            - amount
                            - tax_free_cents
                            - taxable_cents
                            - rate_missing
                      required:
                        - employee
                        - positions
                        - totals
                  year_month:
                    type: string
                  period_status:
                    type: string
                    enum:
                      - closed
                      - open
                  sv_base_wage_cap_cents:
                    type: integer
                    const: 2500
                required:
                  - data
                  - year_month
                  - period_status
                  - sv_base_wage_cap_cents
        '401':
          $ref: '#/components/responses/AuthenticationException'
components:
  schemas:
    SurchargeSettlementResource:
      type: object
      properties:
        id:
          type: string
        employee_id:
          type: string
        surcharge_rule_id:
          type: string
        rule_name:
          type: string
        year_month:
          type: string
        hours:
          type:
            - string
            - 'null'
        hours_ms:
          type: string
        amount_cents:
          type: string
        amount:
          type:
            - string
            - 'null'
        tax_free_cents:
          type: string
        tax_free:
          type:
            - string
            - 'null'
        taxable_cents:
          type: string
        taxable:
          type:
            - string
            - 'null'
        currency:
          type: string
        hourly_rate_cents:
          type: string
        rate_missing:
          type: boolean
        rate_type:
          type: string
        rate_value:
          type: number
        correction_for_year_month:
          type: string
        calculated_at:
          type: string
      required:
        - id
        - employee_id
        - surcharge_rule_id
        - year_month
        - hours
        - hours_ms
        - amount_cents
        - amount
        - tax_free_cents
        - tax_free
        - taxable_cents
        - taxable
        - currency
        - hourly_rate_cents
        - rate_missing
        - rate_type
        - rate_value
        - correction_for_year_month
        - calculated_at
      title: SurchargeSettlementResource
  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

````