Sales API

Products, offers, invoices, shipping, pricing, commissions

Base URL: https://sale-api.ayoune.app — 27 entities

Example

cURL

curl -H "Authorization: Bearer pat_your_token" \
  https://sale-api.ayoune.app/assignmentlists?limit=10

TypeScript SDK

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

const result = await ay.sale.assignmentLists.find().limit(10).exec();
console.log(result.payload());

Entities

Entity	REST Path	SDK	Access	Right
AssignmentLists	`/assignmentlists`	`ay.sale.assignmentLists`	CRUD	`sale.assignmentlists`	play_circle
Assignments	`/assignments`	`ay.sale.assignments`	CRUD	`sale.assignments`	play_circle
BankTurnovers	`/bankturnovers`	`ay.sale.bankTurnovers`	CRUD	`sale.bankturnovers`	play_circle
CashRegisters	`/cashregisters`	`ay.sale.cashRegisters`	CRUD	`sale.cashregisters`	play_circle
CommissionSettlements	`/commissionsettlements`	`ay.sale.commissionSettlements`	CRUD	`sale.commissionsettlements`	play_circle
Configurations	`/configurations`	`ay.sale.configurations`	CRUD	`sale.configurations`	play_circle
Contracts	`/contracts`	`ay.sale.contracts`	CRUD	`sale.contracts`	play_circle
CreditNotes	`/creditnotes`	`ay.sale.creditNotes`	CRUD	`sale.creditnotes`	play_circle
Credits	`/credits`	`ay.sale.credits`	CRUD	`sale.credits`	play_circle
DepositInvoices	`/depositinvoices`	`ay.sale.depositInvoices`	CRUD	`sale.depositinvoices`	play_circle
DeviceRegistrations	`/deviceregistrations`	`ay.sale.deviceRegistrations`	CRUD	`sale.deviceregistrations`	play_circle
Insurances	`/insurances`	`ay.sale.insurances`	read-only	`sale.insurances`	play_circle
Invoices	`/invoices`	`ay.sale.invoices`	CRUD	`sale.invoices`	play_circle
LoadingLists	`/loadinglists`	`ay.sale.loadingLists`	CRUD	`sale.loadinglists`	play_circle
Lots	`/lots`	`ay.sale.lots`	CRUD	`sale.lots`	play_circle
OfferCalculations	`/offercalculations`	`ay.sale.offerCalculations`	CRUD	`sale.offercalculations`	play_circle
Offers	`/offers`	`ay.sale.offers`	CRUD	`sale.offers`	play_circle
Opportunities	`/opportunities`	`ay.sale.opportunities`	CRUD	`sale.opportunities`	play_circle
PackLists	`/packlists`	`ay.sale.packLists`	CRUD	`sale.packlists`	play_circle
PosOrders	`/posorders`	`ay.sale.posOrders`	CRUD	`sale.posorders`	play_circle
PosSessions	`/possessions`	`ay.sale.posSessions`	CRUD	`sale.possessions`	play_circle
Receipts	`/receipts`	`ay.sale.receipts`	CRUD	`sale.receipts`	play_circle
Reminders	`/reminders`	`ay.sale.reminders`	CRUD	`sale.reminders`	play_circle
Shippings	`/shippings`	`ay.sale.shippings`	CRUD	`sale.shippings`	play_circle
Shippments	`/shippments`	`ay.sale.shippments`	CRUD	`sale.shippments`	play_circle
Tickets	`/tickets`	`ay.sale.tickets`	CRUD	`sale.tickets`	play_circle
Trades	`/trades`	`ay.sale.trades`	read-only	`sale.trades`	play_circle