POST
Customer.Invoices.List
List this customer's invoices/receipts, same as Clientproject::invoices: documents where cust_id=token c_id AND type IN (invoice, receipt_tax_invoice). Adds paid_label and custom_status_name from invoices_status (dashboard Status column).
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
- Runs the Customer.Invoices.List function and returns JSON.
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.
- Requires Customer.Login token. Staff Documents.List is unchanged.
- Dashboard table columns: Type, Address, Price (final_amount+coin), Custom status (paid), Status (invoices_status name), dates.
Required Parameters
No body parameters are required for this function.
Optional Parameters
| Name | Type | Sample | What it gives |
|---|---|---|---|
searchpost | string | Tel Aviv | Optional search on address, type, id. |
startpost | int | 0 | Row offset. |
limitpost | int | 25 | Page size, capped at 25. |
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\/Customer.Invoices.List",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": {
"limit": "25"
},
"url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Invoices.List",
"url_domain": "https:\/\/{domain}\/app\/Customer.Invoices.List"
}Endpoint
POST /app/Customer.Invoices.List
POST https://{user}.bull36.com/app/Customer.Invoices.List
POST https://{domain}/app/Customer.Invoices.ListSample Output
{
"success": 1,
"count": 1,
"data": [
{
"id": 458,
"type": "invoice",
"address": "Main st",
"final_amount": 100,
"coin": "₪",
"paid": 0,
"paid_label": "Not PAID",
"custom_status_name": "Open"
}
]
}Count Only
Use the matching count route with the same filters when the UI only needs total rows for paging.
{
"url": "\/app\/Customer.Invoices.Count",
"url_user": "https:\/\/{user}.bull36.com\/app\/Customer.Invoices.Count",
"url_domain": "https:\/\/{domain}\/app\/Customer.Invoices.Count",
"method": "POST",
"headers": {
"Authorization": "Bearer YOUR TOKEN"
},
"body": [],
"sample_output": {
"success": 1,
"count": 123
},
"notes": {
"count": "Use the matching count route when available, or count returned rows.",
"max_limit": 25
}
}Count JavaScript
const token = 'YOUR TOKEN';
const body = new URLSearchParams();
const res = await fetch('https://{domain}/app/Customer.Invoices.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();
body.set('limit', '25');
const res = await fetch('/app/Customer.Invoices.List', {
method: 'POST',
headers: { Authorization: `Bearer ${token}` },
body
});
const data = await res.json();
console.log(data);Error Example
{
"success": 0,
"error": "customer_login_required"
}