XReport

[POST] .../v1/pos/docsession/xreport

Returns Web cash register XReport. Build a POS X-report for the current open cash shift before closing or auditing the shift. The method does not require a request body, checks the current request user, accepted cashier binding and retail X-report permission, then returns result with session data, sale counters, sale details, payment totals and cash operation totals. Denied access, missing accepted cash register, no current shift, report calculation failures and storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

No request body.

Request Example

{}

Response Parameters

Response Example

{
  "ok": true,
  "result": {
    "cash_total": {
      "opr_cash_in": 1.0,
      "opr_cash_out": 1.0,
      "opr_change_in": 1.0,
      "opr_change_out": 1.0,
      "opr_payment_out": 1.0,
      "opr_return": 1.0,
      "opr_sale": 1.0
    },
    "payment_sale": [
      {
        "amount": 1.0,
        "is_return": true,
        "payment_type": {
          "account": {
            "code": "string",
            "currency": {
              "code_chr": "string",
              "code_num": 1,
              "deleted": true,
              "exchange_rate": 1.0,
              "id": 1,
              "is_base": true,
              "last_update": 1,
              "name": "string"
            },
            "id": 1,
            "last_update": 1,
            "name": "string"
          },
          "enabled": "True",
          "id": 1,
          "image_url": "string",
          "is_cash": true,
          "kkm_code": 1,
          "last_update": 1,
          "name": "string",
          "shortkey": 1
        }
      }
    ],
    "sale_counters": [
      {
        "is_return": true,
        "sale_counter": 1,
        "sale_status": 1
      }
    ],
    "sale_details": [
      {
        "is_return": true,
        "position_counter": 1,
        "units_counter": 1.0
      }
    ],
    "session": {
      "close_amount": 1.0,
      "close_date": 1,
      "close_user": {
        "active": true,
        "address": "string",
        "can_authorize": true,
        "date_of_birth": "string",
        "description": "string",
        "email": "string",
        "enable_hints": true,
        "fields": [
          {
            "data_type": "string",
            "field_id": 1,
            "is_custom": true,
            "key": "string",
            "metadata": "string",
            "name": "string",
            "required": true,
            "value": "string"
          }
        ],
        "first_name": "string",
        "full_name": "string",
        "id": 1,
        "internal_phone": "string",
        "language_code": "string",
        "last_name": "string",
        "last_update": 1,
        "login": "string",
        "main_phone": "string",
        "middle_name": "string",
        "phones": "string",
        "photo_url": "string",
        "seller_barcode": "string",
        "sex": "none",
        "sub": "string",
        "system": true,
        "user_group": {
          "child_count": 1,
          "id": 1,
          "last_update": 1,
          "name": "string",
          "parent_id": 1
        }
      },
      "closed": true,
      "code": "string",
      "last_update": 1,
      "operating_cash_id": 1,
      "start_amount": 1.0,
      "start_date": 1,
      "start_user": {
        "active": true,
        "address": "string",
        "can_authorize": true,
        "date_of_birth": "string",
        "description": "string",
        "email": "string",
        "enable_hints": true,
        "fields": [
          {
            "data_type": "string",
            "field_id": 1,
            "is_custom": true,
            "key": "string",
            "metadata": "string",
            "name": "string",
            "required": true,
            "value": "string"
          }
        ],
        "first_name": "string",
        "full_name": "string",
        "id": 1,
        "internal_phone": "string",
        "language_code": "string",
        "last_name": "string",
        "last_update": 1,
        "login": "string",
        "main_phone": "string",
        "middle_name": "string",
        "phones": "string",
        "photo_url": "string",
        "seller_barcode": "string",
        "sex": "none",
        "sub": "string",
        "system": true,
        "user_group": {
          "child_count": 1,
          "id": 1,
          "last_update": 1,
          "name": "string",
          "parent_id": 1
        }
      },
      "uuid": "00000000-0000-0000-0000-000000000000"
    }
  }
}