API
User Manual
  • Introduction to API v2
  • Guides
    • Getting started
    • Authorization
    • Delivery Notes Integrations
  • API Reference
    • General
      • Data types
        • Validation
        • Prices
      • Schema
      • Flags
      • ETags
        • ETag examples
      • Filtering
      • Sorting
      • Paging
      • Methods
      • HTTP Status Codes
    • Enums
      • Payment methods
      • Units
      • Order status
  • Entity
    • Attendance
    • Branch
    • Category
    • Cloud
    • Course
    • Customer
    • Customer Account
    • Customer Account Log
    • Daily Menu
    • Daily Menu Product
    • Delivery Note
    • Discount group
    • EET subject
    • Employee
    • Money log
    • Order
    • Order item
    • Product
    • Product Customization
    • Product Ingredient
    • Reservation
    • Stock Packaging
    • Supplier
    • Table
    • Tag
    • Tax (VAT rates)
    • Warehouse
    • Warehouse Branch
  • Others
    • Reports
      • Base Sales Report
    • POS actions
    • Release notes
    • Breaking changes
    • Webhook
    • Third-party libraries
  • Migration
    • Migrating from API v1
    • API v1 Services
      • Branch Service
      • Category Service
      • Customer Service
      • Employee Service
      • OAuth2 Login Service
      • POS action service
      • Product Service
      • Reservation Service
      • Sale Service
      • Stock Service
      • Supplier Service
      • Tableseat Service
      • Tag Service
      • Warehouse Service
Powered by GitBook
On this page
  • Get Receipt by ID
  • Get All Shift ranges for Branch
  • Base sales report
  • Get Order by ID for Branch
  • Get Order by ID
  • Get Moneylog by ID for Branch
  • Get All Orders for Cloud
  • Get All Orders for Branch
  • Get All Receipts for Cloud
  • Get All Receipts for Branch
  • Get All Moneylogs for Cloud
  • Get All Moneylogs for Branch
  • Get all open Orders for Branch

Was this helpful?

Export as PDF
  1. Migration
  2. API v1 Services

Sale Service

Get Receipt by ID

GET /api/receipt/:cloudId/:orderItemId

GET /v2/clouds/:cloudId/order-items/:orderItemId

Get All Shift ranges for Branch

GET /api/moneylog/shifts/:cloudId/:branchId

GET /v2/clouds/:cloudId/money-logs ?filter=_branchId|eq|:branchId;transactionType|in|REGISTER_OPEN,REGISTER_CLOSE &sort=-created

Pseudo-code to get results similar to API v1

List shiftRangeList = new List() ShiftRange shiftRange = new ShiftRange() for each moneyLog in result { if (moneyLog.transactionType == "REGISTER_OPEN") { shiftRange.start = moneyLog.created shiftRange.openedBy = moneyLog._employeeId shiftRangeList.append(shiftRange) } if (moneyLog.transactionType == "REGISTER_CLOSE") { shiftRange.end = moneyLog.created shiftRange.closedBy = moneyLog._employeeId shiftRange = new ShiftRange() } }

Convert employee ID into employee name

GET /v2/clouds/:cloudId/employees/:employeeId

Base sales report

GET /api/sales/report/:cloudId/:branchId?vatPayer=:vatPayer&dateRange=:dateFrom-:dateTo

GET /v2/clouds/:cloudId/branches/:branchId/sales-report?vatPayer=:vatPayer&dateFrom=:dateFrom&dateTo=:dateTo

Get Order by ID for Branch

GET /api/order/:cloudId/:branchId/:orderId

GET /v2/clouds/:cloudId/orders?filter=_branchId|eq|:branchId;id|eq|:orderId&include=orderItems

Note: filter on branch ID is redundant, order ID is sufficient to identify a single order.

Get Order by ID

GET /api/order/:cloudId/orderid/:orderId

GET /v2/clouds/:cloudId/orders?filter=id|eq|:orderId&include=orderItems

Get Moneylog by ID for Branch

GET /api/moneylog/:cloudId/:branchId/:moneylogId

GET /v2/clouds/:cloudId/money-logs/:moneyLogId

Note: filter on branch ID is redundant, money log ID is sufficient to identify a single money log.

Get All Orders for Cloud

GET /api/order/:cloudId

GET /v2/clouds/:cloudId/orders

With order items GET /v2/clouds/:cloudId/orders?include=orderItems

Get All Orders for Branch

GET /api/order/:cloudId/:branchId

GET /v2/clouds/:cloudId/orders?filter=_branchId|eq|:branchId

With order items GET /v2/clouds/:cloudId/orders?filter=_branchId|eq|:branchId&include=orderItems

Get All Receipts for Cloud

GET /api/receipt/list/:cloudId

GET /v2/clouds/:cloudId/order-items

Get All Receipts for Branch

GET /api/receipt/list/:cloudId/:branchId

GET /v2/clouds/:cloudId/order-items?filter=_branchId|eq|:branchId GET /v2/clouds/:cloudId/order-items?filter=_branchId|in|:branchId1,:branchId2

Get All Moneylogs for Cloud

GET /api/moneylog/list/:cloudId

GET /v2/clouds/:cloudId/money-logs

Get All Moneylogs for Branch

GET /api/moneylog/list/:cloudId/:branchId

GET /v2/clouds/:cloudId/money-logs?filter=_branchId|eq|:branchId GET /v2/clouds/:cloudId/money-logs?filter=_branchId|in|:branchId1,:branchId2

Get all open Orders for Branch

GET /api/order-open/:cloudId/:branchId

GET /v2/clouds/:cloudId/orders?filter=_branchId|eq|:branchId&namedFilter=openOrders

with order items: GET /v2/clouds/:cloudId/orders?filter=_branchId|eq|:branchId&include=orderItems&namedFilter=openOrders;orderItems.openOrderItems

PreviousReservation ServiceNextStock Service

Last updated 4 years ago

Was this helpful?