Sign in

v1

latestOpenAPI 3.0.32026-08-06150495.9 KB
Financial Reconciliation API

Store Wise POS Vs Off-Premise Details

GET /finance-manager/financial/pos-vs-off-premise-details

This endpoint retrieves the details of point of sale (POS) versus off-premise financial data for a specific client.

Request

  • Method: GET

  • Base URL: {{base-url}}

  • Path: /finance-manager/financial/pos-vs-off-premise-details

  • Query Parameters:

    • clientId (string, required): The unique identifier of the client.

Request Body

  • Type: Raw

  • { "startDate": "2025-02-23", "endDate": "2025-03-26", "listingIds": ["P5441"], "channel": ["DOORDASH"], "payoutDates": [] }

Response

  • Status: 200

  • Content-Type: application/json

  • { "status": true, "statusCode": 0, "message": "", "result": { "up_sell": true, "pos": { "name": "", "color": "", "icon": "" }, "is_incomplete": true, "first_date": "", "last_updated": "", "is_pos_available": true, "first_date_off_premise": "", "last_date_off_premise": "", "is_off_premise_available": true, "storeWise": [ { "storeId": "", "orderDiff": { "offPremise": 0, "pos": 0, "missedOffPremise": 0, "missedPos": 0, "totalMissedOrders": 0 }, "subTotalDiff": { "pos": 0, "offPremise": 0, "diffOffPremise": 0, "diffPos": 0, "totalDiff": 0 }, "statusDifference": { "totalDiff": 0 }, "revenueToClaimBack": 0 } ] }, "error": null }

get/finance-manager/financial/pos-vs-off-premise-details

Query parameters

clientIdstring
Example:604517c0-fae8-41b7-8c20-0fe4778e415c

(required) – The common ID between Voosh and the partner, used to identify the client.

Headers

access-tokenstring
Example:{{access-token}}

(required) – The unique token ID provided to the partner for authentication and secure data access.

Request body

channelstring[]
endDatestring
listingIdsstring[]
startDatestring

Example request

{
  "channel": [
    "DOORDASH",
    "UBEREATS",
    "GRUBHUB",
    "EZCATER"
  ],
  "endDate": "2025-03-26",
  "listingIds": [
    "P5441",
    "P5461",
    "P5471",
    "P5481",
    "P5491",
    "P5501",
    "P5511",
    "P5531",
    "P5541",
    "P5551",
    "P5561",
    "P5571",
    "P5581",
    "P8191"
  ],
  "payoutDates": [],
  "startDate": "2025-02-23"
}