Base URL
https://{tenant}.logzi.com/api/delivery_note_in/
Every request returns a JSON response. On success result.code == 1, on failure result.code == 0.
/api/delivery_note_in/get
Retrieves a single incoming delivery note by identifier, with full details.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Unique identifier of the delivery note |
Example request
GET /api/delivery_note_in/get?id=30
X-API-KEY: {your_api_key}/api/delivery_note_in/list
Retrieves a paginated list of incoming delivery notes 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 identifier (LIKE) | |
list_condition[company_name] | string | Filter by supplier 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/delivery_note_in/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {your_api_key}/api/delivery_note_in/save
Creates or updates an incoming delivery note. For a new record use data[id] = 0.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | 0 = new delivery note, >0 = update | |
company_id | int | Company identifier | |
company_user_id | int | ID of the responsible employee | |
company_address_id | int | Company site ID | |
currency_id | int | Currency identifier | |
partner_id | int | Supplier partner identifier | |
date_perform | date | Delivery date (YYYY-MM-DD) | |
comment_top | string | Comment | |
comment_bottom | string | Internal 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 | Net unit price | |
tax_id | int | VAT rate identifier | |
store_id | int | Destination warehouse identifier | |
remove | int | 1 = remove item during update |
Example request
POST /api/delivery_note_in/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,
"partner_id": 8,
"date_perform": "2024-06-18",
"item": [
{ "product_id": 2, "quantity": 50, "price": 500, "tax_id": 2, "store_id": 1 }
]
}
}/api/delivery_note_in/delete
Deletes an incoming delivery note. Only a delivery note with open status can be deleted.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
receipt_id | int | Identifier of the delivery note to delete |
Example request
POST /api/delivery_note_in/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "receipt_id": 30 } }/api/delivery_note_in/close
Closes an incoming delivery note. Upon closing, the line items are added to stock. Only a delivery note with open status (status_id=1) can be closed.
POST fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
receipt_id | int | Identifier of the delivery note to close |
Example request
POST /api/delivery_note_in/close
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "receipt_id": 30 } }/api/delivery_note_in/download
Downloads the document of an incoming delivery note in various formats.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
receipt_id | int | Identifier of the delivery note | |
file_type | string | pdf, pdf-string, pdf-string-sample, stream | |
language | string | Name of the template language folder | |
template_id | int | Custom print template ID |
Example request
GET /api/delivery_note_in/download?receipt_id=30&file_type=pdf
X-API-KEY: {your_api_key}Create your account now,
pay later!
