Skip to content

Sale Service

Get Receipt by ID

Info

GET /api/receipt/:cloudId/:orderItemId

Success

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

Get All Shift ranges for Branch

Info

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

Success

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

Info

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

Success

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

Get Order by ID for Branch

Info

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

Success

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

Info

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

Success

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

Get Moneylog by ID for Branch

Info

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

Success

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

Info

GET /api/order/:cloudId

Success

GET /v2/clouds/:cloudId/orders

With order items

GET /v2/clouds/:cloudId/orders?include=orderItems

Get All Orders for Branch

Info

GET /api/order/:cloudId/:branchId

Success

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

Info

GET /api/receipt/list/:cloudId

Success

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

Get All Receipts for Branch

Info

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

Success

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

Info

GET /api/moneylog/list/:cloudId

Success

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

Get All Moneylogs for Branch

Info

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

Success

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

Info

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

Success

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