Base URL
https://{tenant}.logzi.com/api/receipt_file/
Every request returns a JSON response. On success result.code == 1, on error result.code == 0. A document file is a binary file attached to a document (invoice, order, contract, etc.) — stored with base64-encoded content.
/api/receipt_file/get
Retrieve a single document file by identifier.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | File record identifier |
Example request
GET /api/receipt_file/get?id=10
X-API-KEY: {your_api_key}/api/receipt_file/list
Paginated list of document files with filtering options.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset | int | Pagination offset (default: 0) | |
list_condition[receipt_id] | int | Filter by document identifier | |
list_condition[receipt_type_id] | int | Filter by document type | |
list_condition[partner_id] | int | Filter by all document files of a partner |
Example request
GET /api/receipt_file/list?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {your_api_key}/api/receipt_file/list_light
A lightweight list of document files — without file content (file_source), metadata only.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset | int | Pagination offset (default: 0) | |
list_condition | object | Filter criteria (same as the /list endpoint) |
Example request
GET /api/receipt_file/list_light?list_condition[receipt_id]=150&list_condition[receipt_type_id]=8
X-API-KEY: {your_api_key}/api/receipt_file/save
Upload a file or modify an existing one. For a new file use data[id] = 0.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | 0 = new file, >0 = update | |
receipt_type_id | int | Document type identifier | |
receipt_id | int | Document identifier | |
file_name | string | File name with extension (e.g. invoice.pdf) | |
file_source | string | File content, base64-encoded | |
file_type_id | int | File type identifier (default: 1) | |
file_classification_id | int | File classification identifier |
Example request
POST /api/receipt_file/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{
"data": {
"id": 0,
"receipt_type_id": 8,
"receipt_id": 150,
"file_name": "szamla_150.pdf",
"file_source": "JVBERi0x..."
}
}/api/receipt_file/delete
Delete a document file by identifier.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the file to delete |
Example request
POST /api/receipt_file/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 10 } }Create your account now,
pay later!
