aYOUne
← Konfiguration API

CalculationSchemas

Singular: CalculationSchema — Base-URL: https://config-api.ayoune.app — Zugriff: CRUD

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": "65e0afe5121b7d48fe155f38",
    "gk": 0,
    "surcharge": 0,
    "blend": 0,
    "gkNk": 0,
    "averageWage": 0,
    "dailyExpenses": 0,
    "hoursPerDay": 8,
    "averageWageTotal": 0,
    "calculationWage": 0,
    "wageInternal": 0,
    "wageExternal": 0,
    "wageSubcontractor": 0,
    "wageGlobal": 0,
    "createdBy": "6045f4d25704710012485569",
    "fields": [],
    "createdAt": "2024-02-29T16:25:09.154Z",
    "updatedAt": "2024-02-29T16:25:09.154Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/calculationschemas/65e0afe5121b7d48fe155f38",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      }
    ],
    "debugId": "6a62dce830b7d778029e5ef4",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CALCULATIONSCHEMA",
        "href": "https://api.ayoune.app/config/calculationschemas/65e0afe5121b7d48fe155f38/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CALCULATIONSCHEMA",
        "href": "https://api.ayoune.app/config/calculationschemas/65e0afe5121b7d48fe155f38/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.94.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2295",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 98.729604,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend