aYOUne
← Sales API

CommissionSettlements

Singular: CommissionSettlement — Base URL: https://sale-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

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": "65e0b1e6121b7d48fe15a3b2",
    "status": "Neu",
    "sent": false,
    "net_total": 0,
    "tax": 0,
    "total": 0,
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "from": "2024-02-29T16:33:42.057Z",
    "positions": [],
    "createdAt": "2024-02-29T16:33:42.058Z",
    "updatedAt": "2024-02-29T16:33:42.058Z",
    "shortID": "3FUkhNLlHYYM",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://sale-api.ayoune.app/commissionsettlements/65e0b1e6121b7d48fe15a3b2",
        "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"
      },
      {
        "rel": "Affiliates",
        "title": "MODEL_AFFILIATE",
        "href": "https://api.ayoune.app/config/affiliates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.affiliates"
      }
    ],
    "debugId": "6aa3870533636e7170d61f06",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_COMMISSIONSETTLEMENT",
        "href": "https://api.ayoune.app/sale/commissionsettlements/65e0b1e6121b7d48fe15a3b2/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_COMMISSIONSETTLEMENT",
        "href": "https://api.ayoune.app/sale/commissionsettlements/65e0b1e6121b7d48fe15a3b2",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.61.0",
      "core": "2026.331.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2447",
      "reset": "1789105415",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 208.434418,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also