aYOUne
← Sales API

CashRegisters

Singular: CashRegister — Base URL: https://sale-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": {
    "cashDrawer": {
      "balance": 0
    },
    "_id": "6a61993d01c854403a7cd7fe",
    "createdBy": "6045f4d25704710012485569",
    "name": "DEPENDENT_YELLOW_SAESEE TIIN",
    "currency": "EUR",
    "status": "closed",
    "openingFloat": 0,
    "zReportSequence": 0,
    "active": true,
    "reports": [],
    "createdAt": "2026-07-23T04:31:57.577Z",
    "updatedAt": "2026-07-23T04:31:57.577Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://sale-api.ayoune.app/cashregisters/6a61993d01c854403a7cd7fe",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Stores",
        "title": "MODEL_STORE",
        "href": "https://api.ayoune.app/affiliate/stores",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "affiliate.stores"
      },
      {
        "rel": "CardReaders",
        "title": "MODEL_CARDREADER",
        "href": "https://api.ayoune.app/config/cardreaders",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.cardreaders"
      },
      {
        "rel": "PosSessions",
        "title": "MODEL_POSSESSION",
        "href": "https://api.ayoune.app/sale/possessions",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.possessions"
      }
    ],
    "debugId": "6a61993e01c854403a7cd82a",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CASHREGISTER",
        "href": "https://api.ayoune.app/sale/cashregisters/6a61993d01c854403a7cd7fe/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CASHREGISTER",
        "href": "https://api.ayoune.app/sale/cashregisters/6a61993d01c854403a7cd7fe/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.37.2",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2192",
      "reset": "1784784645",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 57.380058,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also