aYOUne
← HR API

PayrollRuns

Singular: PayrollRun — Base-URL: https://hr-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "_id": "6a730a3f6da0f318dcca5a24",
    "period": "2026-07",
    "status": "draft",
    "isDraft": true,
    "createdBy": "5a76d07e2d8b3270ff6df587",
    "createdAt": "2026-08-05T10:02:39.203Z",
    "updatedAt": "2026-08-05T10:04:38.807Z",
    "employeeCount": 10,
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://hr-api.ayoune.app/payrollruns/6a730a3f6da0f318dcca5a24",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6aa37aac0b6d9b2fe8252f45",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PAYROLLRUN",
        "href": "https://api.ayoune.app/hr/payrollruns/6a730a3f6da0f318dcca5a24/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PAYROLLRUN",
        "href": "https://api.ayoune.app/hr/payrollruns/6a730a3f6da0f318dcca5a24",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.32.0",
      "core": "2026.335.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2310",
      "reset": "1789102207",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 329.236443,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /payrollruns Liste mit Filtern/Paginierung hr.payrollruns.view
GET /payrollruns/:id Einzelner Datensatz hr.payrollruns.view
POST /payrollruns Neuen Datensatz erstellen hr.payrollruns.new
PUT /payrollruns Datensatz aktualisieren hr.payrollruns.edit
DELETE /payrollruns/:id Datensatz löschen hr.payrollruns.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// Alle abrufen
const list = await ay.hr.payrollRuns.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.hr.payrollRuns.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.hr.payrollRuns.create({ name: 'Foo' });

Weiterführend