Sales Report by Criteria

This endpoint allows you to query sales receipts based on various parameters like customer ID, staff ID, search keyword, date range, and pagination.

Request

Path Params

storeid

string

required

ID of the store location where the sale occurred

Query Params

customer

string

optional

Customer ID for filtering sales records by customer

Default:

staff

string

optional

Staff ID for filtering sales records by staff

Default:

string

optional

Search query to filter sales records, e.g., customer name

Default:

startdate

string <date-time>

optional

Start date for the query, formatted as yyyy-MM-dd

Example:

2024-03-01

enddate

string <date-time>

optional

End date for the query, formatted as yyyy-MM-dd

Example:

2024-03-31

per_page

integer <int32>

optional

Number of records to return per page

Default:

current_page

integer <int32>

optional

The current page number for pagination

Default:

Header Params

sessiontoken

string

required

Session token of the logged-in user

Responses

🟢200OK

*/*

Sales receipt report successfully retrieved

Body

success

boolean

optional

message

string

optional

storeId

string

optional

timeOfQuery

string <date-time>

optional

queryPeriod

object (DateDuration)

optional

start

string <date-time>

optional

end

string <date-time>

optional

duration

integer <int64>

optional

metric

string

optional

minutes

integer <int32>

optional

hours

integer <int32>

optional

processOnce

boolean

optional

difference

integer <int64>

optional

staff

string

optional

data

array [array]

optional

object

optional

pagination

object (DataPages)

optional

totalPages

integer <int32>

optional

currentPage

integer <int32>

optional

perPage

integer <int32>

optional

variables

array [object]

optional

headings

array[string]

optional

queryReference

string

optional

records

array[object (SalesReport) {14}]

optional

salesTime

string <date-time>

optional

salesOriginTime

string <date-time>

optional

unitsSold

integer <int32>

optional

volumeSold

number <double>

optional

receiptNo

string

optional

customerInfo

string

optional

customerId

string

optional

totalPaid

integer <int64>

optional

totalSubTotalAmount

integer <int64>

optional

totalBalance

integer <int64>

optional

itemName

string

optional

itemBarcode

string

optional

category

string

optional

channel

string

optional

Example

{
  "success": true,
  "message": "string",
  "storeId": "string",
  "timeOfQuery": "2019-08-24T14:15:22Z",
  "queryPeriod": {
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "duration": 0,
    "metric": "string",
    "minutes": 0,
    "hours": 0,
    "processOnce": true,
    "difference": 0
  },
  "staff": "string",
  "data": [
    [
      {}
    ]
  ],
  "pagination": {
    "totalPages": 0,
    "currentPage": 0,
    "perPage": 0
  },
  "variables": [
    {}
  ],
  "headings": [
    "string"
  ],
  "queryReference": "string",
  "records": [
    {
      "salesTime": "2019-08-24T14:15:22Z",
      "salesOriginTime": "2019-08-24T14:15:22Z",
      "unitsSold": 0,
      "volumeSold": 0,
      "receiptNo": "string",
      "customerInfo": "string",
      "customerId": "string",
      "totalPaid": 0,
      "totalSubTotalAmount": 0,
      "totalBalance": 0,
      "itemName": "string",
      "itemBarcode": "string",
      "category": "string",
      "channel": "string"
    }
  ]
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses