Get a List of Custom Fields by Filter crm.invoice.userfield.list
Scope:
crmWho can execute the method: any user
Warning
The method is deprecated. It is recommended to use Universal methods for invoices
The method returns a list of custom fields for invoices based on the filter.
Parameters
|
Name |
Description |
|
order |
Sorting fields |
|
filter |
Filter fields |
Code Examples
cURL (Webhook)
cURL (OAuth)
JS
PHP
BX24.js
PHP CRest
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"SORT":"ASC"},"filter":{"MANDATORY":"N"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.invoice.userfield.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"SORT":"ASC"},"filter":{"MANDATORY":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.invoice.userfield.list
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'crm.invoice.userfield.list',
{
order: {"SORT": "ASC"},
filter: {"MANDATORY": "N"}
},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const generator = $b24.fetchListMethod('crm.invoice.userfield.list', { order: {"SORT": "ASC"}, filter: {"MANDATORY": "N"} }, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
try {
const response = await $b24.callMethod('crm.invoice.userfield.list', { order: {"SORT": "ASC"}, filter: {"MANDATORY": "N"} }, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'crm.invoice.userfield.list',
[
'order' => ['SORT' => 'ASC'],
'filter' => ['MANDATORY' => 'N'],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
if ($response->getResponseData()->getMore()) {
$response->next();
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching invoice user fields: ' . $e->getMessage();
}
BX24.callMethod(
"crm.invoice.userfield.list",
{
order: {"SORT": "ASC"},
filter: {"MANDATORY": "N"}
},
function (result)
{
if (result.error())
console.error(result.error());
else
{
console.dir(result.data());
if (result.more())
result.next();
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.invoice.userfield.list',
[
'order' => ['SORT' => 'ASC'],
'filter' => ['MANDATORY' => 'N']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Copied