Receipt Item API

Retrieve receipt items, statistics and downloads — read-only

Base URL

https://{tenant}.logzi.com/api/receipt_item/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0. A receipt item represents a line of a receipt — product, quantity, price and warehouse data. This endpoint is read-only: to modify items, use the API of the specific receipt type.

GET /api/receipt_item/get

Retrieve a single receipt item.

Query parameters

ParameterTypeRequiredDescription
idintItem identifier
receipt_idintReceipt identifier
receipt_type_idintReceipt type identifier
product_idintProduct identifier
comment_topstringItem comment filter

Example request

GET /api/receipt_item/get?receipt_id=150&receipt_type_id=8
X-API-KEY: {az_api_kulcsod}
GET /api/receipt_item/get_extended

Retrieve extended item data (with partner, company, tax and warehouse data).

Same parameters as the /get endpoint, but returns more detailed data.

GET /api/receipt_item/list

List of items for a receipt.

Query parameters

ParameterTypeRequiredDescription
receipt_idintReceipt identifier
receipt_type_idintReceipt type identifier

Example request

GET /api/receipt_item/list?receipt_id=150&receipt_type_id=8
X-API-KEY: {az_api_kulcsod}
GET /api/receipt_item/list_light

Light list of items — with filter conditions and pagination.

Query parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_conditionobjectFilter conditions object

Example request

GET /api/receipt_item/list_light?list_condition[receipt_type_id]=8&list_offset=0
X-API-KEY: {az_api_kulcsod}
GET /api/receipt_item/list_slim

Items with minimal data (slim) — for fast synchronization.

Same parameters as the /list_light endpoint.

GET /api/receipt_item/list_group

Aggregated list of items grouped by product.

Same parameters as the /list_light endpoint.

GET /api/receipt_item/list_barcodes

Items enriched with barcode data.

Same parameters as the /list_light endpoint.

GET /api/receipt_item/list_tax

Retrieve the per-item tax summary of a receipt.

Same parameters as the /list_light endpoint.

GET /api/receipt_item/list_store_locality

Items enriched with warehouse location data.

Same parameters as the /list_light endpoint.

GET /api/receipt_item/statistic

Aggregated statistics of items.

Example request

GET /api/receipt_item/statistic
X-API-KEY: {az_api_kulcsod}
GET /api/receipt_item/download

Download the receipt item as PDF/other format.

Query parameters

ParameterTypeRequiredDescription
file_typestringDownload format (e.g. pdf, return-base64)
receipt_idintReceipt identifier
receipt_type_idintReceipt type identifier
languagestringLanguage code (e.g. hu, en)
language_idintTranslation language identifier
template_idintTemplate identifier
receipt_item_idintSpecific item identifier (optional filter)

Example request

GET /api/receipt_item/download?file_type=return-base64&receipt_id=150&receipt_type_id=8&language_id=1
X-API-KEY: {az_api_kulcsod}

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!