Accounting

Journal lines from ZesttBox, ready for your ERP. Pull the lines approved for export, then mark them as exported.

The endpoints in this group are not yet available. This page documents the contract as currently defined.

Endpoints

GET/accounting/journal-linesSoon
POST/accounting/exportsSoon
GET/accounting/exports/{export_batch_id}Soon

The Accounting export object

Attributes

idstringRequired

ID of the export batch. Exported journal lines carry it as export_batch_id.

line_countintegerRequired

targetstringNullable

external_refstringNullable

exported_atstring · date-timeRequired

exported_byobjectRequired

Show 2 child attributesHide child attributes

client_idstring

client_namestring

The Accounting export object

{
  "id": "aex_01J9KQ7X4M",
  "line_count": 3,
  "target": "meshek",
  "external_ref": "MSK-2026-09-013",
  "exported_at": "2026-09-15T21:40:12+03:00",
  "exported_by": {
    "client_id": "cl_01J9KQ7X4M",
    "client_name": "משק – ממשק הנה״ח"
  }
}

List journal lines

GET/accounting/journal-lines

Scopebuyer.accounting:read
Pro plan or higher
Not yet available

List ZesttBox journal lines (debit, credit and VAT) ready for your ERP, one row per line. Set status to approved_for_export to pull the lines that are ready, then mark them with POST /accounting/exports.

Query parameters

cursorstring

Opaque cursor returned as next_cursor in a previous response. Pass it to fetch the next page.

limitinteger

Default 50 · Min 1 · Max 200

updated_sincestring · date-time

Return only items whose updated_at is strictly after this timestamp. Use it for incremental sync.

periodstring

Accounting period, in YYYY-MM format.

statusstring

Possible valuesnot_readyapproved_for_exportexported

branch_idstring

sourcestring

Possible valuespurchaseexpensecardmigration

Responses

200A page of journal lines.

dataarray of JournalLineRequired

Show 27 child attributesHide child attributes

idstringRequired

document_idstringRequired

document_typestring

Type of the source document, either a document type or an expense doc_type value.

document_numberstring

sourcestringRequired

Possible valuespurchaseexpensecardmigration

sidestringRequired

Possible valuesdebitcreditvat

accountstringRequired

Account the line posts to: the expense account when side is debit, the vendor's credit account when side is credit, or the input VAT account when side is vat.

counter_accountstringNullable

amountstring · moneyRequired

Decimal amount as a string, with exactly 2 fraction digits. The currency is set by currency on the parent object.

currencystring

ISO 4217 currency code. Only ILS is currently supported.

Possible valuesILS

descriptionstring

vendor_idstring

vendor_tax_idstringNullable

branch_idstring

branch_tax_idstringNullable

purchase_typestringNullable

category_idstringNullable

referencestring

Number of the source document.

allocation_numberstringNullable

doc_datestring · date

accounting_periodstringRequired

Accounting period in YYYY-MM format, based on the value date.

movement_type_codestringNullable

batch_numberstringNullable

statusstringRequired

Possible valuesnot_readyapproved_for_exportexported

export_batch_idstringNullable

exported_atstring · date-timeNullable

updated_atstring · date-timeRequired

next_cursorstringNullable

has_morebooleanRequired

403The credential is valid but is not allowed to make this request. The code is scope_missing, plan_required, ip_not_allowed or client_suspended.

GET /accounting/journal-lines

curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/accounting/journal-lines?period=2026-09&status=approved_for_export&branch_id=71148-1&limit=200" \
  -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/accounting/journal-lines?period=2026-09&status=approved_for_export&branch_id=71148-1&limit=200", {
  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/accounting/journal-lines?period=2026-09&status=approved_for_export&branch_id=71148-1&limit=200",
    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/accounting/journal-lines?period=2026-09&status=approved_for_export&branch_id=71148-1&limit=200");
var data = await res.Content.ReadAsStringAsync();

Response

{
  "data": [
    {
      "id": "jl_90311",
      "document_id": "5520931",
      "document_type": "delivery_note",
      "document_number": "4471",
      "source": "purchase",
      "side": "debit",
      "account": "6100",
      "counter_account": "2001",
      "amount": "496.40",
      "currency": "ILS",
      "description": "מאפייה אחת עשרה, תעודת משלוח 4471 (הזמנה 2335619), מאפה",
      "vendor_id": "72223",
      "vendor_tax_id": "000000000",
      "branch_id": "71148-1",
      "branch_tax_id": "000000000",
      "purchase_type": "FC",
      "category_id": null,
      "reference": "4471",
      "allocation_number": null,
      "doc_date": "2026-09-14",
      "accounting_period": "2026-09",
      "movement_type_code": "חס",
      "batch_number": "1187",
      "status": "approved_for_export",
      "export_batch_id": null,
      "exported_at": null,
      "updated_at": "2026-09-15T09:12:37+03:00"
    },
    {
      "id": "jl_90312",
      "document_id": "5520931",
      "document_type": "delivery_note",
      "document_number": "4471",
      "source": "purchase",
      "side": "vat",
      "account": "1520",
      "counter_account": "2001",
      "amount": "89.35",
      "currency": "ILS",
      "description": "מאפייה אחת עשרה, תעודת משלוח 4471, מע״מ תשומות 18%",
      "vendor_id": "72223",
      "vendor_tax_id": "000000000",
      "branch_id": "71148-1",
      "branch_tax_id": "000000000",
      "purchase_type": "FC",
      "category_id": null,
      "reference": "4471",
      "allocation_number": null,
      "doc_date": "2026-09-14",
      "accounting_period": "2026-09",
      "movement_type_code": "חס",
      "batch_number": "1187",
      "status": "approved_for_export",
      "export_batch_id": null,
      "exported_at": null,
      "updated_at": "2026-09-15T09:12:37+03:00"
    },
    {
      "id": "jl_90313",
      "document_id": "5520931",
      "document_type": "delivery_note",
      "document_number": "4471",
      "source": "purchase",
      "side": "credit",
      "account": "2001",
      "counter_account": "6100",
      "amount": "585.75",
      "currency": "ILS",
      "description": "מאפייה אחת עשרה, תעודת משלוח 4471, זכות ספק",
      "vendor_id": "72223",
      "vendor_tax_id": "000000000",
      "branch_id": "71148-1",
      "branch_tax_id": "000000000",
      "purchase_type": "FC",
      "category_id": null,
      "reference": "4471",
      "allocation_number": null,
      "doc_date": "2026-09-14",
      "accounting_period": "2026-09",
      "movement_type_code": "חס",
      "batch_number": "1187",
      "status": "approved_for_export",
      "export_batch_id": null,
      "exported_at": null,
      "updated_at": "2026-09-15T09:12:37+03:00"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

{
  "type": "https://developers.zester.co.il/errors/scope_missing",
  "title": "Scope missing",
  "status": 403,
  "code": "scope_missing",
  "detail": "This API client does not have the buyer.accounting:read scope. Ask the account admin to grant it in Settings → Developers.",
  "instance": "/v2/accounting/journal-lines",
  "request_id": "req_01J9KR3B6T"
}

Mark journal lines as exported

POST/accounting/exports

Scopebuyer.accounting:write
Pro plan or higher
Not yet available

Set the given journal lines to exported and record the calling client as exported_by. The response returns the export batch with its export_batch_id.

Headers

Request body application/json

journal_line_idsarray of stringRequired

Up to 5000 items

targetstring

Free-text label for the destination system, for example meshek or hashavshevet.

external_refstring

Responses

201The recorded export batch.

idstringRequired

ID of the export batch. Exported journal lines carry it as export_batch_id.

line_countintegerRequired

targetstringNullable

external_refstringNullable

exported_atstring · date-timeRequired

exported_byobjectRequired

Show 2 child attributesHide child attributes

client_idstring

client_namestring

409One or more of the lines were already exported.

422The request body or query parameters failed validation. See errors[] for each invalid field.

POST /accounting/exports

curl -X POST "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/accounting/exports" \
  -H "Authorization: Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: meshek-export-2026-09-15-01" \
  -d '{
    "journal_line_ids": [
      "jl_90311",
      "jl_90312",
      "jl_90313"
    ],
    "target": "meshek",
    "external_ref": "MSK-2026-09-013"
  }'

const res = await fetch("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/accounting/exports", {
  method: "POST",
  headers: {
    Authorization: "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
    "Content-Type": "application/json",
    "Idempotency-Key": "meshek-export-2026-09-15-01",
  },
  body: JSON.stringify({
    "journal_line_ids": [
      "jl_90311",
      "jl_90312",
      "jl_90313"
    ],
    "target": "meshek",
    "external_ref": "MSK-2026-09-013"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/accounting/exports",
    headers={
        "Authorization": "Bearer zk_test_XXXXXXXX_…zk_live_XXXXXXXX_…",
        "Idempotency-Key": "meshek-export-2026-09-15-01",
    },
    json={
        "journal_line_ids": [
            "jl_90311",
            "jl_90312",
            "jl_90313"
        ],
        "target": "meshek",
        "external_ref": "MSK-2026-09-013"
    },
)
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", "meshek-export-2026-09-15-01");
var body = new StringContent("""
    {
      "journal_line_ids": [
        "jl_90311",
        "jl_90312",
        "jl_90313"
      ],
      "target": "meshek",
      "external_ref": "MSK-2026-09-013"
    }
    """, Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/accounting/exports", body);
var data = await res.Content.ReadAsStringAsync();

Response

{
  "id": "aex_01J9KQ7X4M",
  "line_count": 3,
  "target": "meshek",
  "external_ref": "MSK-2026-09-013",
  "exported_at": "2026-09-15T21:40:12+03:00",
  "exported_by": {
    "client_id": "cl_01J9KQ7X4M",
    "client_name": "משק – ממשק הנה״ח"
  }
}

{
  "type": "https://developers.zester.co.il/errors/conflict",
  "title": "Lines already exported",
  "status": 409,
  "code": "conflict",
  "detail": "3 of 3 journal lines were already exported in batch aex_01J9KQ7X4M on 2026-09-15. Pull status=approved_for_export again before marking.",
  "instance": "/v2/accounting/exports",
  "request_id": "req_01J9KR5D2W",
  "errors": [
    {
      "field": "journal_line_ids[0]",
      "code": "already_exported",
      "message": "jl_90311 was exported in batch aex_01J9KQ7X4M"
    },
    {
      "field": "journal_line_ids[1]",
      "code": "already_exported",
      "message": "jl_90312 was exported in batch aex_01J9KQ7X4M"
    },
    {
      "field": "journal_line_ids[2]",
      "code": "already_exported",
      "message": "jl_90313 was exported in batch aex_01J9KQ7X4M"
    }
  ]
}

{
  "type": "https://developers.zester.co.il/errors/validation_error",
  "title": "Validation failed",
  "status": 422,
  "code": "validation_error",
  "detail": "1 field is invalid",
  "instance": "/v2/accounting/exports",
  "request_id": "req_01J9KS0A7H",
  "errors": [
    {
      "field": "journal_line_ids[2]",
      "code": "not_approved_for_export",
      "message": "Journal line jl_90313 has status not_ready and cannot be marked as exported"
    }
  ]
}

Retrieve an export batch

GET/accounting/exports/{export_batch_id}

Scopebuyer.accounting:read
Pro plan or higher
Not yet available

Path parameters

export_batch_idstringRequired

Responses

200The export batch.

idstringRequired

ID of the export batch. Exported journal lines carry it as export_batch_id.

line_countintegerRequired

targetstringNullable

external_refstringNullable

exported_atstring · date-timeRequired

exported_byobjectRequired

Show 2 child attributesHide child attributes

client_idstring

client_namestring

404The resource does not exist or belongs to another account.

GET /accounting/exports/{export_batch_id}

curl "https://sandbox-api.zester.co.il/v2https://api.zester.co.il/v2/accounting/exports/aex_01J9KQ7X4M" \
  -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/accounting/exports/aex_01J9KQ7X4M", {
  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/accounting/exports/aex_01J9KQ7X4M",
    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/accounting/exports/aex_01J9KQ7X4M");
var data = await res.Content.ReadAsStringAsync();

Response

{
  "id": "aex_01J9KQ7X4M",
  "line_count": 3,
  "target": "meshek",
  "external_ref": "MSK-2026-09-013",
  "exported_at": "2026-09-15T21:40:12+03:00",
  "exported_by": {
    "client_id": "cl_01J9KQ7X4M",
    "client_name": "משק – ממשק הנה״ח"
  }
}

{
  "type": "https://developers.zester.co.il/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Export batch aex_01J9KQ7X4M does not exist or belongs to another account.",
  "instance": "/v2/accounting/exports/aex_01J9KQ7X4M",
  "request_id": "req_01J9KS8M3Q"
}