Contents
On this page

Read Journal - Plugixa POS for WooCommerce

GET /plugixa-pos/v1/fiscal/journal

The register’s fiscal journal: every sale, refund and closing, in order. Each entry holds the hash of the one before it (prev_hash) and its own hash, so a changed or missing entry breaks the chain.

Needs a user with the plugixa_pos_fiscal_audit 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.

Request

GET https://your-site.example/wp-json/plugixa-pos/v1/fiscal/journal?register_id=1&after_seq=100&per_page=1

Query parameters

Field Type Required Description
register_id integer Yes The register.
after_seq integer No Return entries after this sequence number. Defaults to 0.
per_page integer No 1 to 500. Defaults to 100.

Page through the journal by passing the last seq you received as after_seq.

Responses

200 OK.

{
  "success": true,
  "data": [
    {
      "id": 202,
      "register_id": 1,
      "seq": 101,
      "event_type": "sale",
      "order_id": 4001,
      "user_id": 87,
      "payload": {
        "currency": "EUR",
        "order_id": 4001,
        "order_number": "4001",
        "register": "R1",
        "session_id": 21,
        "sold_at": "2026-11-16T15:53:18+00:00",
        "lines": [
          {
            "name": "Ceramic bowl",
            "product_id": 3745,
            "qty": "1",
            "sku": "KIT-BOWL",
            "subtotal": "11.67",
            "tax": "2.33",
            "total": "11.67",
            "variation_id": 0
          }
        ],
        "payments": [
          {
            "amount": "14.00",
            "label": "Card (terminal)",
            "method": "card"
          }
        ],
        "taxes": {
          "8": {
            "amount": "2.33",
            "label": "TVA",
            "rate": "20.0000"
          }
        },
        "totals": {
          "discount": "0.00",
          "subtotal": "11.67",
          "tax": "2.33",
          "total": "14.00"
        },
        "tendered": "14.00",
        "change": "0.00",
        "customer_id": 0
      },
      "prev_hash": "386a38242fc55860d011bd1115a6e7566a939c042dd391b6625daac86b6e19ba",
      "hash": "2ccece6ae13ed42cd22a099508e6e5c0c74c4b8939c14165f1df093cec9964fc",
      "created_at": "2026-10-13 10:20:23"
    }
  ]
}
Field Type Meaning
data[].seq integer Position in the register’s chain
data[].event_type string Such as sale, refund or a closing
data[].payload object What was recorded, as hashed
data[].prev_hash string Hash of the previous entry
data[].hash string SHA-256 hash of this entry
data[].created_at string UTC, Y-m-d H:i:s

Errors

Status Code When
400 rest_missing_callback_param register_id is missing.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-pos/v1/fiscal/journal?register_id=1&after_seq=100&per_page=1" \
  -u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-pos/v1/fiscal/journal?register_id=1&after_seq=100&per_page=1');
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/fiscal/journal?register_id=1&after_seq=100&per_page=1', {
  headers: {
    'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
  },
});
const { data } = await response.json();

Quick Links

Share