aYOUne
← Konfiguration API

PaymentGroups

Singular: PaymentGroup — 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": "65e0b042121b7d48fe157a30",
    "name": "-",
    "kind_of_payment": "Rechnung",
    "text": "",
    "text_en": "",
    "creditorIBAN": "",
    "creditorBIC": "",
    "text_invoice": "",
    "text_invoice_en": "",
    "text_credit": "",
    "text_credit_en": "",
    "print_bank": false,
    "active": true,
    "credit_allowed": true,
    "payment_confirmation_needed": false,
    "pos": false,
    "period1": 7,
    "period2": 14,
    "period3": 30,
    "skonto1": 0,
    "skonto2": 0,
    "skonto3": 0,
    "days_till_collection": 4,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:26:42.804Z",
    "updatedAt": "2024-02-29T16:26:42.804Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/paymentgroups/65e0b042121b7d48fe157a30",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "PaymentProviders",
        "title": "MODEL_PAYMENTPROVIDER",
        "href": "https://api.ayoune.app/config/paymentproviders",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.paymentproviders"
      }
    ],
    "debugId": "6a62de0af27d6098834ae352",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PAYMENTGROUP",
        "href": "https://api.ayoune.app/config/paymentgroups/65e0b042121b7d48fe157a30/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PAYMENTGROUP",
        "href": "https://api.ayoune.app/config/paymentgroups/65e0b042121b7d48fe157a30/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1086",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 102.419634,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend