Pos Detail

Overview

The POS Detail endpoint returns detailed POS transaction records for the requested reporting period. Each record represents a POS transaction item and includes product information, transaction date, invoice number, quantity, price, discounts, taxes, service charges, total amount, and revenue.

The response also provides related POS, category, payment, sales type, employee, guest, serving period, agent, and transaction information when available. This endpoint is commonly used to review detailed POS activity, analyze product-level sales, and support transaction reporting and reconciliation.

Request Endpoint

• Method: POST
• Path: {{base_url}}/api/reports/pos-detail

Payload Construction and Schema Definition

The request payload is submitted as form-data fields.

Request Body Fields

Field	Type	Required	Description
start_date	string (date)	Yes	Start date (YYYY-MM-DD) for the report.
end_date	string (date)	Yes	End date (YYYY-MM-DD) for the report.
company_id	string	yes	POS filter. Use all for all POS.

Response Body Fields

Field	Type	Always present	Description
error	boolean	Yes	Indicates whether the request failed. false means success.
status	string	Yes	Status string. On success the example returns "ok".
message	string	Yes	Human-readable message. Often empty on success.
data	arrya of object	Yes (on success)	List of POS transaction detail records

Response data Fields

Field	Type	Description	Example
id	string	Unique identifier of the POS transaction record.	148c1ec0-9556-11f1-...
pax	number	Number of guests associated with the transaction.	1
pos_type	string	Type of POS transaction.	STANDAR
product_id	string	Product id.	""
pos_name	string	Name of the POS outlet or source.	Restaurant
category_name	string	Product category name. May be empty when unavailable.	""
name	string	Product or transaction item name.	- Rounding
parent_name	string	Parent product or category name when available.	null
transaction_date	string	Date of the transaction.	2026-07-17
invoice_no	string	Invoice number of the transaction.	1661
created_time	string	Time when the transaction was created.	03:27:16 PM
created_by	string	User who created the transaction.	gusadi
created_at	string	Date and time when the record was created.	2026-08-11 15:27:16
qty	number	Quantity of the transaction item.	1
price	number	Unit price of the transaction item.	235
discount	number	Discount amount applied to the transaction item.	0
taxes	number	Tax amount applied to the transaction item.	0
service	number	Service charge amount applied to the transaction item.	0
account_name	string	Account associated with the transaction.	Room Revenue
total	number	Total transaction amount.	235
revenue	number	Revenue amount generated by the transaction.	235
remark	string	Transaction remark or description.	Payment In POS
consigment_amount	number	Consignment amount associated with the transaction.	0
payment_method_name	string	Payment method name when available.	null
sales_type_name	string	Sales type name when available.	null
employee_name	string	Employee associated with the transaction when available.	null
guest_profile_name	string	Guest profile name when available.	null
product_remark	string	Product remark or note.	""
tags_list	string	Tags associated with the transaction when available.	null
serving_period_name	string	Serving period associated with the transaction.	Dinner
na_status	number	Night audit status of the transaction.	0
agent_id	string	Agent identifier when available.	null
tx_product_remark	string	Transaction product remark when available.	null
rounding	number	Rounding adjustment amount.	235
table_no	string	Table number associated with the transaction when available.	null
country	string	Country associated with the guest or transaction when available.	null
nationality	string	Nationality associated with the guest when available.	null
agent	string	Agent information when available.	null

Expected System Responses

The system responds with HTTP 200 OK.

{

     "error": false,
    "status": "ok",
    "message": "",
    "data": [
        {

            "id": "148c1ec0-9556-11f1-ba89",
            "pax": 1,
            "pos_type": "STANDAR",
            "product_id": "",
            "pos_name": "Restaurant",
            "category_name": "",
            "name": " - Rounding",
            "parent_name": null,
            "transaction_date": "2026-07-17",
            "invoice_no": "1661",
            "created_time": "03:27:16 PM",
            "created_by": "gusadi",
            "created_at": "2026-08-11 15:27:16",
            "qty": 1,
            "price": 235,
            "discount": 0,
            "taxes": 0,
            "service": 0,
            "account_name": "Room Revenue",
            "total": 235,
            "revenue": 235,
            "remark": "Payment In POS",
            "consignment_amount": 0,
            "payment_method_name": null,
            "sales_type_name": null,
            "employee_name": null,
            "guest_profile_name": null,
            "product_remark": "",
            "tags_list": null,
            "serving_period_name": "Dinner",
            "na_status": 0,
            "agent_id": null,
            "tx_product_remark": null,
            "rounding": 235,
            "table_no": null,
            "country": null,
            "nationality": null,
            "agent": null
        }   
    ]        
}