Documents
Delivery notes, invoices, credit notes and consolidated invoices that you issue to buyers. Create them one at a time or in bulk, and see what each buyer actually received.
The Document object
Attributes
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Israeli invoice allocation number. Mandatory for amounts above 5,000 ILS.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
What the buyer has done with the document, such as receiving, disputing or exporting it.
Possible values
pendingreceivedreceived_with_differencesdisputedapproved_for_exportexported{
"id": "5520931",
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"accounting_period": "2026-09",
"due_date": null,
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"buyer": {
"id": "71148",
"name": "שניצי קפה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": null,
"source": "purchase",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75",
"discount": "0.00"
},
"allocation_number": null,
"lines": [
{
"id": "5520931-1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"order_id": "2335619",
"order_line_id": "l1",
"quantity_received": "1",
"purchase_type": null,
"expense_account": null
},
{
"id": "5520931-2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "416.40",
"order_id": "2335619",
"order_line_id": "l2",
"quantity_received": "10",
"purchase_type": null,
"expense_account": null
}
],
"buyer_status": "received_with_differences",
"differences": [
{
"line_id": "5520931-2",
"sku": "412",
"field": "quantity",
"issued": "12",
"received": "10",
"note": "התקבלו 10 קרטונים מתוך 12"
}
],
"payment_status": "unpaid",
"paid_at": null,
"export_status": "not_ready",
"exported_at": null,
"files": [
{
"id": "file_01J9KQ7X4M",
"name": "delivery-note-4471.pdf",
"content_type": "application/pdf",
"size_bytes": 184213,
"download_url": "https://storage.zester.co.il/signed/f7K2mQ9vT4xB"
}
],
"external_ref": "DN-2026-4471",
"history": [
{
"at": "2026-09-14T06:12:04+03:00",
"action": "created",
"actor": {
"type": "api_client",
"id": "cl_01J9KQ7X4M",
"name": "סנכרון ERP"
}
},
{
"at": "2026-09-14T09:47:31+03:00",
"action": "received",
"actor": {
"type": "user",
"id": "u_58213",
"name": "דנה כהן"
},
"changes": {
"buyer_status": {
"from": "pending",
"to": "received_with_differences"
},
"lines[1].quantity_received": {
"from": null,
"to": "10"
}
}
}
],
"created_at": "2026-09-14T06:12:04+03:00",
"updated_at": "2026-09-14T09:47:31+03:00",
"deleted_at": null
}GET
/supplier/documentsQuery parameters
Opaque cursor returned as next_cursor in a previous response. Pass it to fetch the next page.
Return only items whose updated_at is strictly after this timestamp. Use it for incremental sync.
Start of the date range, inclusive, matched against the document date or the order date.
Comma-separated list of document types to filter by.
Possible values
delivery_noteinvoicecredit_noteconsolidated_invoiceWhat the buyer has done with the document, such as receiving, disputing or exporting it.
Possible values
pendingreceivedreceived_with_differencesdisputedapproved_for_exportexportedResponses
200A page of documents.
Show 28 child attributesHide child attributes
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Israeli invoice allocation number. Mandatory for amounts above 5,000 ILS.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
What the buyer has done with the document, such as receiving, disputing or exporting it.
Possible values
pendingreceivedreceived_with_differencesdisputedapproved_for_exportexportedcurl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents?updated_since=2026-09-14T00:00:00%2B03:00&type=delivery_note&buyer_status=received_with_differences&expand=lines&limit=50" \
-H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents?updated_since=2026-09-14T00:00:00%2B03:00&type=delivery_note&buyer_status=received_with_differences&expand=lines&limit=50", {
method: "GET",
headers: {
Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
},
});
const data = await res.json();import requests
res = requests.get(
"https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents?updated_since=2026-09-14T00:00:00%2B03:00&type=delivery_note&buyer_status=received_with_differences&expand=lines&limit=50",
headers={
"Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
},
)
data = res.json()using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
var res = await http.GetAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents?updated_since=2026-09-14T00:00:00%2B03:00&type=delivery_note&buyer_status=received_with_differences&expand=lines&limit=50");
var data = await res.Content.ReadAsStringAsync();{
"data": [
{
"id": "5520931",
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"accounting_period": "2026-09",
"due_date": null,
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"buyer": {
"id": "71148",
"name": "שניצי קפה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": null,
"source": "purchase",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75",
"discount": "0.00"
},
"allocation_number": null,
"lines": [
{
"id": "5520931-1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"order_id": "2335619",
"order_line_id": "l1",
"quantity_received": "1"
},
{
"id": "5520931-2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "416.40",
"order_id": "2335619",
"order_line_id": "l2",
"quantity_received": "10"
}
],
"buyer_status": "received_with_differences",
"differences": [
{
"line_id": "5520931-2",
"sku": "412",
"field": "quantity",
"issued": "12",
"received": "10",
"note": "התקבלו 10 קרטונים מתוך 12"
}
],
"payment_status": "unpaid",
"paid_at": null,
"export_status": "not_ready",
"exported_at": null,
"external_ref": "DN-2026-4471",
"created_at": "2026-09-14T06:12:04+03:00",
"updated_at": "2026-09-14T09:47:31+03:00",
"deleted_at": null
},
{
"id": "5520874",
"type": "delivery_note",
"number": "4468",
"date": "2026-09-13",
"accounting_period": "2026-09",
"due_date": null,
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"buyer": {
"id": "71202",
"name": "ביסטרו הנמל"
},
"branch": {
"id": "71202-1",
"name": "ביסטרו הנמל – ראשי",
"tax_id": "000000000"
},
"purchase_type": null,
"source": "purchase",
"order_ids": [
"2335480"
],
"currency": "ILS",
"totals": {
"before_vat": "531.60",
"vat": "95.69",
"with_vat": "627.29",
"discount": "14.40"
},
"allocation_number": null,
"lines": [
{
"id": "5520874-1",
"sku": "518",
"name": "קרואסון חמאה",
"quantity": "3",
"unit": "carton",
"unit_price": "96.00",
"discount_pct": "5",
"vat_exempt": false,
"total": "273.60",
"order_id": "2335480",
"order_line_id": "l1",
"quantity_received": "3"
},
{
"id": "5520874-2",
"sku": "604",
"name": "לחם שיפון פרוס",
"quantity": "20",
"unit": "unit",
"unit_price": "12.90",
"discount_pct": null,
"vat_exempt": false,
"total": "258.00",
"order_id": "2335480",
"order_line_id": "l2",
"quantity_received": "0"
}
],
"buyer_status": "received_with_differences",
"differences": [
{
"line_id": "5520874-2",
"sku": "604",
"field": "missing_line",
"issued": "20",
"received": "0",
"note": "לחם השיפון לא הגיע במשלוח"
}
],
"payment_status": "unpaid",
"paid_at": null,
"export_status": "not_ready",
"exported_at": null,
"external_ref": "DN-2026-4468",
"created_at": "2026-09-13T05:48:10+03:00",
"updated_at": "2026-09-14T08:05:22+03:00",
"deleted_at": null
}
],
"next_cursor": null,
"has_more": false
}POST
/supplier/documentsCreate a delivery note, invoice, credit note or consolidated invoice. Upload attachments first with POST /files and reference them in file_ids. The Idempotency-Key header is required: use the document number as its value.
Headers
Required key for safely retrying the request. Use a stable business key, such as the document number. Sending the same key with the same body within 24 hours returns the original response. Reusing the key with a different body returns 409 with code idempotency_conflict.
Up to 128 characters
Request body application/json
ID of the buyer's branch the document is for. Required when the buyer has more than one branch and order_ids is empty.
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Show 9 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Responses
201The created document.
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Israeli invoice allocation number. Mandatory for amounts above 5,000 ILS.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
What the buyer has done with the document, such as receiving, disputing or exporting it.
Possible values
pendingreceivedreceived_with_differencesdisputedapproved_for_exportexported409The request conflicts with the current state. The code is conflict, or idempotency_conflict when an Idempotency-Key is reused with a different body.
422The request body or query parameters failed validation. See errors[] for each invalid field.
curl -X POST "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents" \
-H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: tm-2026-4471" \
-d '{
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"buyer_id": "71148",
"branch_id": "71148-1",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l1"
},
{
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l2"
}
],
"file_ids": [
"file_01J9KQ7X4M"
],
"external_ref": "DN-2026-4471",
"notes": "לפרוק בכניסה האחורית עד 07:00"
}'const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents", {
method: "POST",
headers: {
Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Content-Type": "application/json",
"Idempotency-Key": "tm-2026-4471",
},
body: JSON.stringify({
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"buyer_id": "71148",
"branch_id": "71148-1",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l1"
},
{
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l2"
}
],
"file_ids": [
"file_01J9KQ7X4M"
],
"external_ref": "DN-2026-4471",
"notes": "לפרוק בכניסה האחורית עד 07:00"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents",
headers={
"Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Idempotency-Key": "tm-2026-4471",
},
json={
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"buyer_id": "71148",
"branch_id": "71148-1",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"vat_exempt": False,
"order_id": "2335619",
"order_line_id": "l1"
},
{
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"vat_exempt": False,
"order_id": "2335619",
"order_line_id": "l2"
}
],
"file_ids": [
"file_01J9KQ7X4M"
],
"external_ref": "DN-2026-4471",
"notes": "לפרוק בכניסה האחורית עד 07:00"
},
)
data = res.json()using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
http.DefaultRequestHeaders.Add("Idempotency-Key", "tm-2026-4471");
var body = new StringContent("""
{
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"buyer_id": "71148",
"branch_id": "71148-1",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l1"
},
{
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l2"
}
],
"file_ids": [
"file_01J9KQ7X4M"
],
"external_ref": "DN-2026-4471",
"notes": "לפרוק בכניסה האחורית עד 07:00"
}
""", Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents", body);
var data = await res.Content.ReadAsStringAsync();{
"id": "5520931",
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"accounting_period": "2026-09",
"due_date": null,
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"buyer": {
"id": "71148",
"name": "שניצי קפה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": null,
"source": "purchase",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75",
"discount": "0.00"
},
"allocation_number": null,
"lines": [
{
"id": "5520931-1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"order_id": "2335619",
"order_line_id": "l1",
"quantity_received": null
},
{
"id": "5520931-2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "416.40",
"order_id": "2335619",
"order_line_id": "l2",
"quantity_received": null
}
],
"buyer_status": "pending",
"differences": [],
"payment_status": "unpaid",
"paid_at": null,
"export_status": "not_ready",
"exported_at": null,
"files": [
{
"id": "file_01J9KQ7X4M",
"name": "delivery-note-4471.pdf",
"content_type": "application/pdf",
"size_bytes": 184213
}
],
"external_ref": "DN-2026-4471",
"created_at": "2026-09-14T06:12:04+03:00",
"updated_at": "2026-09-14T06:12:04+03:00",
"deleted_at": null
}{
"type": "https://developers.zester.co.il/errors/idempotency_conflict",
"title": "Idempotency key reused",
"status": 409,
"code": "idempotency_conflict",
"detail": "Idempotency-Key tm-2026-4471 was used in the last 24 hours with a different request body. Send the original body to get the original response, or use a new key for a new document.",
"request_id": "req_01J9KR3B8N"
}{
"type": "https://developers.zester.co.il/errors/validation_error",
"title": "Validation failed",
"status": 422,
"code": "validation_error",
"detail": "2 fields are invalid",
"request_id": "req_01J9KR3C2P",
"errors": [
{
"field": "lines[1].order_line_id",
"code": "not_found",
"message": "Order 2335619 has no line l7"
},
{
"field": "totals.before_vat",
"code": "totals_mismatch",
"message": "Line totals add up to 496.40 but totals.before_vat is 469.40"
}
]
}POST
/supplier/documents/batchCreate up to 500 documents in one request. The response reports a result for each item, and the request returns 422 only when every item fails.
Headers
Required key for safely retrying the request. Use a stable business key, such as the document number. Sending the same key with the same body within 24 hours returns the original response. Reusing the key with a different body returns 409 with code idempotency_conflict.
Up to 128 characters
Request body application/json
Up to 500 items
Show 14 child attributesHide child attributes
ID of the buyer's branch the document is for. Required when the buyer has more than one branch and order_ids is empty.
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Show 9 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Responses
200A result for each item. At least one item succeeded.
Show 5 child attributesHide child attributes
422Every item failed. The body reports the result and errors for each item.
curl -X POST "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents/batch" \
-H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: tm-batch-2026-09-14" \
-d '{
"items": [
{
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"buyer_id": "71148",
"branch_id": "71148-1",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l1"
},
{
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l2"
}
],
"file_ids": [
"file_01J9KQ7X4M"
],
"external_ref": "DN-2026-4471"
},
{
"type": "invoice",
"number": "INV-2026-1188",
"date": "2026-09-14",
"due_date": "2026-10-30",
"buyer_id": "71202",
"branch_id": "71202-1",
"currency": "ILS",
"totals": {
"before_vat": "5610.00",
"vat": "1009.80",
"with_vat": "6619.80"
},
"lines": [
{
"sku": "518",
"name": "קרואסון חמאה",
"quantity": "45",
"unit": "carton",
"unit_price": "96.00",
"vat_exempt": false
},
{
"sku": "604",
"name": "לחם שיפון פרוס",
"quantity": "100",
"unit": "unit",
"unit_price": "12.90",
"vat_exempt": false
}
],
"external_ref": "AR-2026-1188",
"notes": "אספקה לאירוע סוף הקיץ, תנאי תשלום שוטף + 30"
}
]
}'const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents/batch", {
method: "POST",
headers: {
Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Content-Type": "application/json",
"Idempotency-Key": "tm-batch-2026-09-14",
},
body: JSON.stringify({
"items": [
{
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"buyer_id": "71148",
"branch_id": "71148-1",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l1"
},
{
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l2"
}
],
"file_ids": [
"file_01J9KQ7X4M"
],
"external_ref": "DN-2026-4471"
},
{
"type": "invoice",
"number": "INV-2026-1188",
"date": "2026-09-14",
"due_date": "2026-10-30",
"buyer_id": "71202",
"branch_id": "71202-1",
"currency": "ILS",
"totals": {
"before_vat": "5610.00",
"vat": "1009.80",
"with_vat": "6619.80"
},
"lines": [
{
"sku": "518",
"name": "קרואסון חמאה",
"quantity": "45",
"unit": "carton",
"unit_price": "96.00",
"vat_exempt": false
},
{
"sku": "604",
"name": "לחם שיפון פרוס",
"quantity": "100",
"unit": "unit",
"unit_price": "12.90",
"vat_exempt": false
}
],
"external_ref": "AR-2026-1188",
"notes": "אספקה לאירוע סוף הקיץ, תנאי תשלום שוטף + 30"
}
]
}),
});
const data = await res.json();import requests
res = requests.post(
"https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents/batch",
headers={
"Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
"Idempotency-Key": "tm-batch-2026-09-14",
},
json={
"items": [
{
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"buyer_id": "71148",
"branch_id": "71148-1",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"vat_exempt": False,
"order_id": "2335619",
"order_line_id": "l1"
},
{
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"vat_exempt": False,
"order_id": "2335619",
"order_line_id": "l2"
}
],
"file_ids": [
"file_01J9KQ7X4M"
],
"external_ref": "DN-2026-4471"
},
{
"type": "invoice",
"number": "INV-2026-1188",
"date": "2026-09-14",
"due_date": "2026-10-30",
"buyer_id": "71202",
"branch_id": "71202-1",
"currency": "ILS",
"totals": {
"before_vat": "5610.00",
"vat": "1009.80",
"with_vat": "6619.80"
},
"lines": [
{
"sku": "518",
"name": "קרואסון חמאה",
"quantity": "45",
"unit": "carton",
"unit_price": "96.00",
"vat_exempt": False
},
{
"sku": "604",
"name": "לחם שיפון פרוס",
"quantity": "100",
"unit": "unit",
"unit_price": "12.90",
"vat_exempt": False
}
],
"external_ref": "AR-2026-1188",
"notes": "אספקה לאירוע סוף הקיץ, תנאי תשלום שוטף + 30"
}
]
},
)
data = res.json()using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
http.DefaultRequestHeaders.Add("Idempotency-Key", "tm-batch-2026-09-14");
var body = new StringContent("""
{
"items": [
{
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"buyer_id": "71148",
"branch_id": "71148-1",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75"
},
"lines": [
{
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l1"
},
{
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"vat_exempt": false,
"order_id": "2335619",
"order_line_id": "l2"
}
],
"file_ids": [
"file_01J9KQ7X4M"
],
"external_ref": "DN-2026-4471"
},
{
"type": "invoice",
"number": "INV-2026-1188",
"date": "2026-09-14",
"due_date": "2026-10-30",
"buyer_id": "71202",
"branch_id": "71202-1",
"currency": "ILS",
"totals": {
"before_vat": "5610.00",
"vat": "1009.80",
"with_vat": "6619.80"
},
"lines": [
{
"sku": "518",
"name": "קרואסון חמאה",
"quantity": "45",
"unit": "carton",
"unit_price": "96.00",
"vat_exempt": false
},
{
"sku": "604",
"name": "לחם שיפון פרוס",
"quantity": "100",
"unit": "unit",
"unit_price": "12.90",
"vat_exempt": false
}
],
"external_ref": "AR-2026-1188",
"notes": "אספקה לאירוע סוף הקיץ, תנאי תשלום שוטף + 30"
}
]
}
""", Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents/batch", body);
var data = await res.Content.ReadAsStringAsync();{
"summary": {
"total": 2,
"succeeded": 1,
"failed": 1,
"skipped": 0
},
"items": [
{
"index": 0,
"key": "4471",
"status": "created",
"id": "5520931"
},
{
"index": 1,
"key": "INV-2026-1188",
"status": "failed",
"errors": [
{
"field": "allocation_number",
"code": "required",
"message": "An Israel Tax Authority allocation number is required for invoices above 5,000.00 ILS before VAT"
}
]
}
]
}{
"summary": {
"total": 2,
"succeeded": 0,
"failed": 2,
"skipped": 0
},
"items": [
{
"index": 0,
"key": "4471",
"status": "failed",
"errors": [
{
"field": "number",
"code": "already_exists",
"message": "Delivery note 4471 already exists for buyer 71148 as document 5520931"
}
]
},
{
"index": 1,
"key": "INV-2026-1188",
"status": "failed",
"errors": [
{
"field": "allocation_number",
"code": "required",
"message": "An Israel Tax Authority allocation number is required for invoices above 5,000.00 ILS before VAT"
}
]
}
]
}GET
/supplier/documents/{document_id}Path parameters
Query parameters
Responses
200The document.
Show 4 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Israeli invoice allocation number. Mandatory for amounts above 5,000 ILS.
Show 14 child attributesHide child attributes
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.
What the buyer has done with the document, such as receiving, disputing or exporting it.
Possible values
pendingreceivedreceived_with_differencesdisputedapproved_for_exportexported404The resource does not exist or belongs to another account.
curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents/5520931?expand=lines,files,history" \
-H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…"const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents/5520931?expand=lines,files,history", {
method: "GET",
headers: {
Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
},
});
const data = await res.json();import requests
res = requests.get(
"https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents/5520931?expand=lines,files,history",
headers={
"Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
},
)
data = res.json()using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", "zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…");
var res = await http.GetAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/supplier/documents/5520931?expand=lines,files,history");
var data = await res.Content.ReadAsStringAsync();{
"id": "5520931",
"type": "delivery_note",
"number": "4471",
"date": "2026-09-14",
"accounting_period": "2026-09",
"due_date": null,
"supplier": {
"id": "72223",
"name": "מאפייה אחת עשרה"
},
"buyer": {
"id": "71148",
"name": "שניצי קפה"
},
"branch": {
"id": "71148-1",
"name": "שניצי קפה – ראשי",
"tax_id": "000000000"
},
"purchase_type": null,
"source": "purchase",
"order_ids": [
"2335619"
],
"currency": "ILS",
"totals": {
"before_vat": "496.40",
"vat": "89.35",
"with_vat": "585.75",
"discount": "0.00"
},
"allocation_number": null,
"lines": [
{
"id": "5520931-1",
"sku": "300",
"name": "בייבי ג׳בטה לבן",
"quantity": "1",
"unit": "carton",
"unit_price": "80.00",
"discount_pct": null,
"vat_exempt": false,
"total": "80.00",
"order_id": "2335619",
"order_line_id": "l1",
"quantity_received": "1",
"purchase_type": null,
"expense_account": null
},
{
"id": "5520931-2",
"sku": "412",
"name": "לחמניית חיטה מלאה",
"quantity": "12",
"unit": "carton",
"unit_price": "34.70",
"discount_pct": null,
"vat_exempt": false,
"total": "416.40",
"order_id": "2335619",
"order_line_id": "l2",
"quantity_received": "10",
"purchase_type": null,
"expense_account": null
}
],
"buyer_status": "received_with_differences",
"differences": [
{
"line_id": "5520931-2",
"sku": "412",
"field": "quantity",
"issued": "12",
"received": "10",
"note": "התקבלו 10 קרטונים מתוך 12"
}
],
"payment_status": "unpaid",
"paid_at": null,
"export_status": "not_ready",
"exported_at": null,
"files": [
{
"id": "file_01J9KQ7X4M",
"name": "delivery-note-4471.pdf",
"content_type": "application/pdf",
"size_bytes": 184213,
"download_url": "https://storage.zester.co.il/signed/f7K2mQ9vT4xB"
}
],
"external_ref": "DN-2026-4471",
"history": [
{
"at": "2026-09-14T06:12:04+03:00",
"action": "created",
"actor": {
"type": "api_client",
"id": "cl_01J9KQ7X4M",
"name": "סנכרון ERP"
}
},
{
"at": "2026-09-14T09:47:31+03:00",
"action": "received",
"actor": {
"type": "user",
"id": "u_58213",
"name": "דנה כהן"
},
"changes": {
"buyer_status": {
"from": "pending",
"to": "received_with_differences"
},
"lines[1].quantity_received": {
"from": null,
"to": "10"
}
}
}
],
"created_at": "2026-09-14T06:12:04+03:00",
"updated_at": "2026-09-14T09:47:31+03:00",
"deleted_at": null
}{
"type": "https://developers.zester.co.il/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "Document 5520931 does not exist or was not issued by supplier 72223.",
"request_id": "req_01J9KR3D5Q"
}