Получить список счетов crm.invoice.list
Scope:
crmКто может выполнять метод: любой пользователь
DEPRECATED
Развитие метода остановлено. Используйте Универсальные методы для счетов.
Метод возвращает список счетов. Является реализацией списочного метода для счетов.
При выборке используйте маски:
- "*" — для выборки всех полей (без пользовательских)
- "UF_*" — для выборки всех пользовательских полей.
Свойства и товарные позиции счета метод не возвращает.
Для получения свойств и товарных позиций нужно использовать метод crm.invoice.get.
Параметры метода
См. описание списочных методов.
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter |
Фильтр записей. По умолчанию отдаются все записи, без фильтрации |
|
order |
Сортировка записей. Поддерживается сортировка по тем же полям, что и в фильтре |
Примеры кода
Как использовать примеры в документации
Пример выводит данные в консоль. Если нужно вывести данные по-другому, то реализуйте свою обработку данных, возвращенных вызовами result.data() и result.error().
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"DATE_INSERT":"ASC"},"filter":{">PRICE":100},"select":["ID","ACCOUNT_NUMBER","ORDER_TOPIC","DATE_INSERT","STATUS_ID","PRICE","CURRENCY_ID"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.invoice.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"DATE_INSERT":"ASC"},"filter":{">PRICE":100},"select":["ID","ACCOUNT_NUMBER","ORDER_TOPIC","DATE_INSERT","STATUS_ID","PRICE","CURRENCY_ID"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.invoice.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'crm.invoice.list',
{
"order": { "DATE_INSERT": "ASC" },
"filter": { ">PRICE": 100 },
"select": [ "ID", "ACCOUNT_NUMBER", "ORDER_TOPIC", "DATE_INSERT", "STATUS_ID", "PRICE", "CURRENCY_ID" ]
},
(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: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('crm.invoice.list', { "order": { "DATE_INSERT": "ASC" }, "filter": { ">PRICE": 100 }, "select": [ "ID", "ACCOUNT_NUMBER", "ORDER_TOPIC", "DATE_INSERT", "STATUS_ID", "PRICE", "CURRENCY_ID" ] }, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('crm.invoice.list', { "order": { "DATE_INSERT": "ASC" }, "filter": { ">PRICE": 100 }, "select": [ "ID", "ACCOUNT_NUMBER", "ORDER_TOPIC", "DATE_INSERT", "STATUS_ID", "PRICE", "CURRENCY_ID" ] }, 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.list',
[
'order' => ['DATE_INSERT' => 'ASC'],
'filter' => ['>PRICE' => 100],
'select' => ['ID', 'ACCOUNT_NUMBER', 'ORDER_TOPIC', 'DATE_INSERT', 'STATUS_ID', 'PRICE', 'CURRENCY_ID'],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
if ($result->more()) {
$result->next();
}
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching invoice list: ' . $e->getMessage();
}
BX24.callMethod(
"crm.invoice.list",
{
"order": { "DATE_INSERT": "ASC" },
"filter": { ">PRICE": 100 },
"select": [ "ID", "ACCOUNT_NUMBER", "ORDER_TOPIC", "DATE_INSERT", "STATUS_ID", "PRICE", "CURRENCY_ID" ]
},
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.list',
[
'order' => ['DATE_INSERT' => 'ASC'],
'filter' => ['>PRICE' => 100],
'select' => ['ID', 'ACCOUNT_NUMBER', 'ORDER_TOPIC', 'DATE_INSERT', 'STATUS_ID', 'PRICE', 'CURRENCY_ID']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Поля, возвращаемые методом
|
Поле / Тип |
Описание |
Примечание |
|
ID |
Идентификатор |
Только для чтения |
|
ACCOUNT_NUMBER |
Номер |
Обязательное |
|
COMMENTS |
Комментарий менеджера |
|
|
CREATED_BY |
Создано пользователем |
Только для чтения |
|
CURRENCY |
Идентификатор валюты |
Только для чтения |
|
DATE_BILL |
Дата выставления |
|
|
DATE_INSERT |
Дата создания |
|
|
DATE_MARKED |
Дата отклонения |
Указывается, если счёт отклонён |
|
DATE_PAY_BEFORE |
Срок оплаты |
|
|
DATE_PAYED |
Дата перевода в состояние оплаты |
Только для чтения |
|
DATE_STATUS |
Дата изменения статуса |
Только для чтения |
|
DATE_UPDATE |
Дата изменения |
Только для чтения |
|
EMP_PAYED_ID |
Идентификатор пользователя, который последним перевёл счёт в состояние "оплачен" |
Только для чтения |
|
EMP_STATUS_ID |
Идентификатор пользователя, который последним поменял статус счёта |
Только для чтения |
|
LID |
Идентификатор сайта |
Только для чтения |
|
IS_RECURRING |
Флаг шаблона регулярной сделки |
|
|
XML_ID |
Внешний код |
|
|
ORDER_TOPIC |
Тема |
Обязательное |
|
PAY_SYSTEM_ID |
Идентификатор печатной формы |
Обязательное |
|
PAY_VOUCHER_DATE |
Дата оплаты |
Указывается, если счёт оплачен |
|
PAY_VOUCHER_NUM |
Номер документа оплаты |
Указывается, если счёт оплачен |
|
PAYED |
Признак оплаченности |
Только для чтения |
|
PERSON_TYPE_ID |
Идентификатор типа плательщика |
Обязательное |
|
PRICE |
Сумма |
Только для чтения |
|
REASON_MARKED |
Комментарий статуса |
Указывается, если счёт оплачен или отклонён |
|
RESPONSIBLE_EMAIL |
E-mail ответственного |
Только для чтения |
|
RESPONSIBLE_ID |
Идентификатор ответственного |
|
|
RESPONSIBLE_LAST_NAME |
Фамилия ответственного |
Только для чтения |
|
RESPONSIBLE_LOGIN |
Логин ответственного |
Только для чтения |
|
RESPONSIBLE_NAME |
Имя ответственного |
Только для чтения |
|
RESPONSIBLE_PERSONAL_PHOTO |
Идентификатор фото ответственного |
Только для чтения |
|
RESPONSIBLE_SECOND_NAME |
Отчество ответственного |
Только для чтения |
|
RESPONSIBLE_WORK_POSITION |
Должность ответственного |
Только для чтения |
|
STATUS_ID |
Идентификатор статуса |
Идентификатор справочника "INVOICE_STATUS" |
|
TAX_VALUE |
Сумма налога |
Только для чтения |
|
UF_COMPANY_ID |
Идентификатор компании |
Указывается, если плательщик "Юридическое лицо" |
|
UF_CONTACT_ID |
Идентификатор контакта |
Указывается, если плательщик "Физическое лицо", либо в качестве контактного лица компании |
|
UF_MYCOMPANY_ID |
Идентификатор своей компании |
Указывается в качестве компании с реквизитами счёта (привязка к реквизитам устанавливается отдельно) |
|
UF_DEAL_ID |
Идентификатор связанной сделки |
|
|
UF_QUOTE_ID |
Идентификатор связанного коммерческого предложения |
|
|
USER_DESCRIPTION |
Комментарий |