POST

Banks.List

List banks from bank_details for the organization localization (same source as the dashboard receipt check / masav / transfer bank dropdowns). For Israel this is the full local bank list with clearing codes — not a hard-coded subset. Use id for Documents.Add check_bank_details and payment_method=masav bank (dashboard value). code is the Israel bank number shown in labels.

Permissions

User must be logged in with a valid bearer token.
Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

Returns Banks rows as JSON.
Supports the documented filters and paging fields.
List responses are capped at 25 rows per call.

Push Service

No push is sent because this function only reads data or returns helper information.

Automation

No automation is run for this function.

Special Instructions

Standing order (הוראת קבע) on a receipt: Documents.Add with document_type=receipt, payment_method=masav (not cc). Send bank=<Banks.List id or code>, branch_no, acc_no, acc_name, tz. App resolves code→id.
Checks: payment_method=check with check_bank_details=<Banks.List id or code> (alias check_bank), plus check_branch_no, check_acc_number, check_number, check_date, check_sumamount.
Do not use payment_method=cc / c_type_pay=standing_order for masav standing order — that is credit-card standing order.

Required Parameters

No body parameters are required for this function.

Optional Parameters

Name	Type	Sample	What it gives
`limit` post	int	`100`	Maximum rows. Default/cap 100 (full Israel list fits).
`start` post	int	`0`	Offset for paging. Alias: offset.
`search` post	string	`Hapoalim`	Search bank_name, bank_name_he, and code.
`code` post	string	`12`	Exact bank clearing code filter. Alias: bank_code.
`order_by` post	string	`bank_name`	id, code, bank_name, bank_name_he.
`order_dir` post	string	`asc`	asc or desc.

Authentication

Send the bearer token returned by Login in the request header.

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Banks.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "limit": "100"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Banks.List",
    "url_domain": "https:\/\/{domain}\/app\/Banks.List"
}

Endpoint

POST /app/Banks.List
POST https://{user}.bull36.com/app/Banks.List
POST https://{domain}/app/Banks.List

Sample Output

{
    "success": 1,
    "count": 2,
    "recordsTotal": 2,
    "localization_id": 1,
    "source": "bank_details",
    "value_field": "id",
    "code_field": "code",
    "data": [
        {
            "id": 10,
            "bank_id": 10,
            "code": "12",
            "bank_code": "12",
            "bank_name": "Bank Hapoalim",
            "bank_name_he": "בנק הפועלים",
            "label": "Bank Hapoalim - 12",
            "label_he": "בנק הפועלים - 12"
        },
        {
            "id": 11,
            "bank_id": 11,
            "code": "10",
            "bank_code": "10",
            "bank_name": "Bank Leumi",
            "bank_name_he": "בנק לאומי",
            "label": "Bank Leumi - 10",
            "label_he": "בנק לאומי - 10"
        }
    ]
}

Count Only

Use the matching count route with the same filters when the UI only needs total rows for paging.

{
    "url": "\/app\/Banks.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Banks.Count",
    "url_domain": "https:\/\/{domain}\/app\/Banks.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": [],
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "count": "Use Banks.Count with the same filters, or read count\/recordsTotal from this response."
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();

const res = await fetch('https://{domain}/app/Banks.Count', {
  method: 'POST',
  headers: { Authorization: `Bearer ${token}` },
  body
});
const data = await res.json();
console.log(data.count);

JavaScript Example

const token = 'YOUR TOKEN';
const res = await fetch('/app/Banks.List', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body: new URLSearchParams({ limit: '100' }) });
const data = await res.json();
console.log(data.data);

Error Example

{
    "success": "0",
    "error": "bearer_token_required",
    "message": "Authorization bearer token is required. Send header: Authorization: Bearer YOUR TOKEN"
}