Contents
Get Session Report - Plugixa POS for WooCommerce
GET /plugixa-pos/v1/sessions/{id}/report
The figures of a session, open or closed: the X report while it is open, the Z report once closed.
Needs a user with the plugixa_pos_sell capability (signed in with an Application Password, or the login cookie with an X-WP-Nonce header). Administrators hold it; other roles only when you grant it. The user must also be allowed to use the register (register access).
Request
GET https://your-site.example/wp-json/plugixa-pos/v1/sessions/84/report
Path parameters
| Name | Type | Description |
|---|---|---|
id |
integer |
The session’s id |
Responses
200 OK.
{
"success": true,
"data": {
"session": {
"id": 84,
"register_id": 3,
"opened_by": 101,
"closed_by": 101,
"opening_float": 15000,
"expected": {
"card": "280.40",
"cash": "197.90"
},
"counted": {
"card": "280.40",
"cash": "197.90"
},
"difference": 0,
"status": "closed",
"opened_at": "2026-11-14 08:34:00",
"closed_at": "2026-11-14 18:10:00",
"updated_at": "2026-11-14 18:10:00"
},
"currency": "EUR",
"sales_count": 7,
"refunds_count": 0,
"sales": "328.30",
"refunds": "0.00",
"net_sales": "328.30",
"tax": "54.72",
"discount": "0.00",
"opening_float": "150.00",
"cash_in": "0.00",
"cash_out": "0.00",
"payments": {
"card": "280.40",
"cash": "47.90"
},
"taxes": {
"8": {
"label": "TVA",
"rate": "20.0000",
"amount": "54.72"
}
},
"expected": {
"card": "280.40",
"cash": "197.90"
},
"deposits": {
"count": 0,
"received": "0.00",
"refunded": "0.00",
"applied": "0.00",
"tax": "0.00"
},
"foreign": []
}
}
| Field | Type | Meaning |
|---|---|---|
data.session |
object |
The session record (fields as in Get Current Session) |
data.currency |
string |
Shop currency |
data.sales_count |
integer |
Sales in the session |
data.refunds_count |
integer |
Refunds in the session |
data.sales |
string |
Sales total |
data.refunds |
string |
Refunds total |
data.net_sales |
string |
Sales minus refunds |
data.tax |
string |
Tax collected |
data.discount |
string |
Discounts given |
data.opening_float |
string |
Opening float, decimal |
data.cash_in |
string |
Cash put in |
data.cash_out |
string |
Cash taken out |
data.payments |
object |
Taken per payment method |
data.taxes |
object |
Per tax rate id: label, rate, amount |
data.expected |
object |
What should be in the drawer per method (cash includes the float and movements) |
data.deposits |
object |
Layaway deposits PRO: count, received, refunded, applied, tax |
data.foreign |
object[] |
Foreign cash taken PRO |
Errors
| Status | Code | When |
|---|---|---|
404 |
plugixa_pos_not_found |
No session with that id. |
403 |
plugixa_pos_register_forbidden |
The register is missing or archived, or the user may not use it. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-pos/v1/sessions/84/report" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/sessions/84/report');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-pos/v1/sessions/84/report', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share