Base URL
https://{tenant}.logzi.com/api/receipt_comment/
Every request returns a JSON response. On success result.code == 1, on error result.code == 0. A receipt comment is a predefined text that can automatically be inserted into the header or footer of a document — based on payment method or document type.
/api/receipt_comment/get
Retrieve a single comment template by its identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Comment template identifier |
Example request
GET /api/receipt_comment/get?id=1
X-API-KEY: {your_api_key}/api/receipt_comment/list
Paginated list of comment templates.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset | int | Pagination offset (default: 0) | |
list_condition | object | Object containing filter conditions |
Example request
GET /api/receipt_comment/list?list_offset=0
X-API-KEY: {your_api_key}/api/receipt_comment/save
Create or update a comment template. For a new template use data[id] = 0.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | 0 = new template, >0 = update | |
comment_name | string | Comment name (for internal identification) | |
comment_value | string | Comment text | |
receipt_type_id | int | Document type identifier | |
receipt_comment_type_id | int | Comment type (header / footer) | |
receipt_comment_auto_fill | int | 1 = auto fill-in | |
receipt_comment_paymod_id | int | Payment method filter (if NULL: applies to every payment method) |
Example request
POST /api/receipt_comment/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{
"data": {
"id": 0,
"comment_name": "Átutalásos megjegyzés",
"comment_value": "Kérjük az összeget 8 napon belül átutalni.",
"receipt_type_id": 8,
"receipt_comment_type_id": 2,
"receipt_comment_auto_fill": 1,
"receipt_comment_paymod_id": 2
}
}/api/receipt_comment/delete
Delete a comment template by its identifier.
POST fields
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the comment to delete |
Example request
POST /api/receipt_comment/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "id": 1 }Create your account now,
pay later!
