Base URL
https://{tenant}.logzi.com/api/cash_register/
Every request returns a JSON response. On success result.code == 1, on failure result.code == 0.
/api/cash_register/get
Retrieves a single in-store sales receipt by identifier, with the full line item list.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Unique identifier of the receipt |
Example request
GET /api/cash_register/get?id=101
X-API-KEY: {your_api_key}/api/cash_register/list
Retrieves a paginated list of in-store sales receipts with filtering options.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset | int | Pagination offset (default: 0) | |
list_count | int | Number of records per page | |
list_condition[identify] | string | Filter by receipt number (LIKE) | |
list_condition[company_name] | string | Filter by customer name (LIKE) | |
list_condition[status_id] | int | Filter by status | |
list_condition[date_create_from] | date | Creation date — from (YYYY-MM-DD) | |
list_condition[date_create_to] | date | Creation date — to (YYYY-MM-DD) |
Example request
GET /api/cash_register/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {your_api_key}/api/cash_register/save
Creates or updates an in-store sales receipt. For a new receipt use data[id] = 0.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | 0 = new receipt, >0 = update | |
company_id | int | Company identifier | |
company_user_id | int | ID of the responsible employee | |
company_address_id | int | Site identifier | |
currency_id | int | Currency identifier | |
paymod_id | int | Payment method identifier | |
partner_id | int | Customer partner identifier | |
date_perform | date | Fulfillment date (YYYY-MM-DD) | |
comment_top | string | Comment | |
item | array | Array of line items (see below) |
Line item fields — data[item][]
| Field | Type | Required | Description |
|---|---|---|---|
product_id | int | Product identifier | |
quantity | float | Quantity | |
price | float | Gross unit price | |
tax_id | int | VAT rate identifier | |
store_id | int | Warehouse identifier | |
remove | int | 1 = remove item during update |
Example request
POST /api/cash_register/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{
"data": {
"id": 0,
"company_id": 1,
"company_user_id": 3,
"company_address_id": 1,
"currency_id": 1,
"paymod_id": 1,
"item": [
{ "product_id": 5, "quantity": 2, "price": 3990, "tax_id": 2 }
]
}
}/api/cash_register/delete
Deletes an in-store sales receipt. Only a receipt with open status can be deleted.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
receipt_id | int | Identifier of the receipt to delete |
Example request
POST /api/cash_register/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "receipt_id": 101 } }/api/cash_register/close
Closes an in-store sales receipt. Upon closing, the stock movement and financial entry take place. Only a receipt with open status (status_id=1) can be closed.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
receipt_id | int | Identifier of the receipt to close |
Example request
POST /api/cash_register/close
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "receipt_id": 101 } }/api/cash_register/download
Downloads the document of an in-store sales receipt in various formats (PDF, printable receipt).
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
receipt_id | int | Identifier of the receipt | |
file_type | string | pdf, pdf-string, pdf-thermal, pos-thermal, stream | |
language | string | Name of the template language folder | |
template_id | int | Custom print template ID |
Example request
GET /api/cash_register/download?receipt_id=101&file_type=pdf
X-API-KEY: {your_api_key}Create your account now,
pay later!
