Expenses.List

Permissions

• User must be logged in with a valid bearer token.
• The user must be from the same company domain as the request Host (call the API on that account subdomain or allowed custom domain). A token from another company returns success=0, error user_not_in_company.
• Returned or changed records are limited by the user permissions, team access, folder access, and account settings.

Action

• Returns Expenses 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

• On a company subdomain (e.g. https://{user_domain}.bull36.com) the user must match that Host — Login and protected APIs reject another company with success=0, error user_not_in_company. On a main brand host (bull36.com, biz1.co.il, mastrocrm.com, …) the company domain gate is skipped.
• To get expenses for one customer (left customer list → Expenses tab), send customer_id = contactus.id.
• Aliases: cust_id, contactus_id. Omit customer_id to list all account expenses (existing behavior).
• Matches dashboard Expences::show_module_expences_js which filters expenses_new.customer_id.

Required Parameters

No body parameters are required for this function.

Optional Parameters

Authentication

Send the bearer token returned by Login in the request header. The user must be from the same company domain as this Host — a token from another company is rejected (user_not_in_company).

Authorization: Bearer YOUR TOKEN

Sample Request

{
    "url": "\/app\/Expenses.List",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "customer_id": "123",
        "limit": "25",
        "offset": "0"
    },
    "url_user": "https:\/\/{user}.bull36.com\/app\/Expenses.List",
    "url_domain": "https:\/\/{domain}\/app\/Expenses.List"
}

Endpoint

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

Sample Output

{
    "success": 1,
    "data": [
        {
            "id": "900",
            "expenses_name": "Office rent",
            "customer_id": "123",
            "amount": "224.00"
        }
    ],
    "limit": 25,
    "offset": 0
}

Count Only

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

{
    "url": "\/app\/Expenses.Count",
    "url_user": "https:\/\/{user}.bull36.com\/app\/Expenses.Count",
    "url_domain": "https:\/\/{domain}\/app\/Expenses.Count",
    "method": "POST",
    "headers": {
        "Authorization": "Bearer YOUR TOKEN"
    },
    "body": {
        "customer_id": "123"
    },
    "sample_output": {
        "success": 1,
        "count": 123
    },
    "notes": {
        "route": "Expenses.Count",
        "max_limit": 25
    }
}

Count JavaScript

const token = 'YOUR TOKEN';
const body = new URLSearchParams();
body.set('customer_id', '123');

const res = await fetch('https://{domain}/app/Expenses.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({ customer_id: '123', limit: '25' });
const res = await fetch('/app/Expenses.List', { method: 'POST', headers: { Authorization: 'Bearer ' + token }, body });
const data = await res.json();
console.log(data);

Error Example

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