POST
InvoiceSettings.List
Return invoice settings / companies for the account (Settings → Invoice settings table). Reads invoices_settings where user_id = owner and is_deleted = 0, same as dashboard listing_of_invoices_settings_table. Use returned id as invoice_setting_id on Documents.Add / Documents.Sum, or product_invoice_setting_id on products. Does not return auth tokens. Page size is capped at 25. Default order is id ASC.
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 InvoiceSettings 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
- Send the bearer token on protected calls with Authorization: Bearer YOUR TOKEN.
- Send parameters as POST body fields exactly as documented.
- For paging, do not request more than 25 rows.
- For total rows, call the matching Count function with the same filters.
Required Parameters
No body parameters are required for this function.
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
searchpost | string | kan | Search company_name, email, company_tax_id, company_type, phone. Aliases: filter_data, search[value], company_name, name. |
company_typepost | string | Company | Filter by company type (e.g. Company, Organization, Private) when stored. |
default_onlypost | int | 1 | When 1, return only the default company (default_settings=1). Alias: default_settings=1. |
startpost | int | 0 | First row offset for paging. Alias: offset. |
limitpost | int | 25 | Maximum rows to return. Values above 25 are capped. Aliases: length, per_page. |
order_bypost | string | id | Order column: id, company_name, email, company_tax_id, company_type, default_settings. Default id. |
order_dirpost | string | asc | Order direction: asc or desc. Default asc. |
Authentication
Send the bearer token returned by Login in the request header.
Authorization: Bearer YOUR TOKEN
Sample Request
{
"url": "\/app\/InvoiceSettings.List",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"limit": "25"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/InvoiceSettings.List",
"url_domain": "https:\/\/{domain}\/app\/InvoiceSettings.List"
}Endpoint
POST /app/InvoiceSettings.List
POST https://{user}.bull36.com/app/InvoiceSettings.List
POST https://{domain}/app/InvoiceSettings.ListSample Output
{
"success": 1,
"count": 2,
"recordsTotal": 2,
"recordsFiltered": 2,
"total_record": 2,
"start": 0,
"limit": 25,
"data": [
{
"id": 19,
"invoice_setting_id": 19,
"invoice_settings_id": 19,
"company_name": "kan*udo",
"name": "kan*udo",
"email": "[email protected]",
"company_tax_id": "032451296",
"company_type": "Company",
"logo": "biz1upload\/upload\/images\/logo.png",
"logo_url": "https:\/\/files.biz1.co.il\/biz1upload\/upload\/images\/logo.png",
"default_settings": 1,
"is_default": true
}
]
}Count Only
Use the matching count route with the same filters when the UI only needs total rows for paging.
{
"url": "\/app\/InvoiceSettings.Count",
"url_user": "https:\/\/{user}.bull36.com\/app\/InvoiceSettings.Count",
"url_domain": "https:\/\/{domain}\/app\/InvoiceSettings.Count",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": [],
"sample_output": {
"success": 1,
"count": 123
},
"notes": {
"route": "InvoiceSettings.Count",
"max_limit": 25
}
}Count JavaScript
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
const res = await fetch('https://{domain}/app/InvoiceSettings.Count', {
method: 'POST',
headers: { Authorization: `Bearer ${token}` },
body
});
const data = await res.json();
console.log(data.count);JavaScript Example
const token = 'YOUR TOKEN';
const body = new URLSearchParams({ limit: '25' });
const res = await fetch('/app/InvoiceSettings.List', {
method: 'POST',
headers: { Authorization: 'Bearer ' + token },
body
});
const data = await res.json();
console.log(data.count, data.data);
// Use data.data[i].id as invoice_setting_id on Documents.AddError Example
{
"success": "0",
"error": "bearer_token_required",
"message": "Authorization bearer token is required. Send header: Authorization: Bearer YOUR TOKEN"
}