aYOUne
← Configuration API

CalculationGroups

Singular: CalculationGroup — Base URL: https://config-api.ayoune.app — Access: CRUD

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "65ce136aa2b22f4b7d2c0683",
    "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",
    "createdAt": "2024-02-15T13:36:42.351Z",
    "updatedAt": "2024-02-15T13:36:42.351Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/calculationgroups/65ce136aa2b22f4b7d2c0683",
        "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": "6a62dce130b7d778029e5cd2",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CALCULATIONGROUP",
        "href": "https://api.ayoune.app/config/calculationgroups/65ce136aa2b22f4b7d2c0683/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CALCULATIONGROUP",
        "href": "https://api.ayoune.app/config/calculationgroups/65ce136aa2b22f4b7d2c0683/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.94.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2324",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 100.710404,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /calculationgroups List with filters/pagination config.calculationgroups.view
GET /calculationgroups/:id Single record config.calculationgroups.view
POST /calculationgroups Create new record config.calculationgroups.new
PUT /calculationgroups Update record config.calculationgroups.edit
DELETE /calculationgroups/:id Delete record config.calculationgroups.delete

SDK

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

// List all
const list = await ay.config.calculationGroups.find().limit(10).exec();

// Single record
const one = await ay.config.calculationGroups.findById('OBJECT_ID').exec();

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

See also