Документация для разработчиков
Темная тема

crm.invoice.list

Scope: crm Права на выполнение: для всех

Описание

Возвращает список счетов. Является реализацией списочного метода для счетов.

При выборке используйте маски:

  • "*" - для выборки всех полей (без пользовательских)
  • "UF_*"- для выборки всех пользовательских полей.

Свойства и товарные позиции счёта метод crm.invoice.list не возвращает.

Для получения свойств и товарных позиций нужно использовать метод crm.invoice.get.

Параметры

См. описание списочных методов.

Параметр Описание
filter Фильтр записей. По умолчанию отдаются все записи, без фильтрации.
order Сортировка записей. Поддерживается сортировка по тем же полям, что и в фильтре.

Пример

Пример выводит данные в консоль. Если нужно вывести данные по другому, то реализуйте свою обработку данных, возвращенных вызовами result.data() и result.error().

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();
		}
	}
);


Поля, возвращаемые методом

Поле ОписаниеТипПримечание
ID ИдентификаторintergerТолько для чтения
ACCOUNT_NUMBER НомерstringОбязательное
COMMENTS Комментарий менеджераtext
CREATED_BY Создано пользователемintegerТолько для чтения
CURRENCY Идентификатор валютыcrm_currencyТолько для чтения
DATE_BILL Дата выставленияdate
DATE_INSERT Дата созданияdatetime
DATE_MARKED Дата отклоненияdatetimeУказывается, если счёт отклонён
DATE_PAY_BEFORE Срок оплатыdate
DATE_PAYED Дата перевода в состояние оплатыdatetimeТолько для чтения
DATE_STATUS Дата изменения статусаdatetimeТолько для чтения
DATE_UPDATE Дата измененияdatetimeТолько для чтения
EMP_PAYED_ID Идентификатор пользователя, который последним перевёл счёт в состояние "оплачен"integerТолько для чтения
EMP_STATUS_ID Идентификатор пользователя, который последним поменял статус счётаintegerТолько для чтения
LID Идентификатор сайтаintegerТолько для чтения
IS_RECURRING Флаг шаблона регулярной сделки (если стоит Y, то это не сделка, а шаблон)char
XML_ID Внешний кодstring
ORDER_TOPIC ТемаstringОбязательное
PAY_SYSTEM_ID Идентификатор печатной формыintegerОбязательное
PAY_VOUCHER_DATE Дата оплатыdateУказывается, если счёт оплачен
PAY_VOUCHER_NUM Номер документа оплатыstringУказывается, если счёт оплачен
PAYED Признак оплаченностиcharТолько для чтения
PERSON_TYPE_ID Идентификатор типа плательщикаintegerОбязательное
PRICE СуммаdoubleТолько для чтения
REASON_MARKED Комментарий статусаstringУказывается, если счёт оплачен или отклонён
RESPONSIBLE_EMAIL E-mail ответственногоstringТолько для чтения
RESPONSIBLE_ID Идентификатор ответственногоinteger
RESPONSIBLE_LAST_NAME Фамилия ответственногоstringТолько для чтения
RESPONSIBLE_LOGIN Логин ответственногоstringТолько для чтения
RESPONSIBLE_NAME Имя ответственногоstringТолько для чтения
RESPONSIBLE_PERSONAL_PHOTO Идентификатор фото ответственногоintegerТолько для чтения
RESPONSIBLE_SECOND_NAME Отчество ответственногоstringТолько для чтения
RESPONSIBLE_WORK_POSITION Должность ответственногоstringТолько для чтения
STATUS_ID Идентификатор статусаcrm_statusИдентификатор справочника "INVOICE_STATUS"
TAX_VALUE Сумма налогаdoubleТолько для чтения
UF_COMPANY_ID Идентификатор компанииintegerУказывается, если плательщик "Юридическое лицо"
UF_CONTACT_ID Идентификатор контактаintegerУказывается, если плательщик "Физическое лицо", либо в качестве контактного лица компании
UF_MYCOMPANY_ID Идентификатор своей компанииintegerУказывается в качестве компании с реквизитами счёта (привязка к реквизитам устанавливается отдельно)
UF_DEAL_ID Идентификатор связанной сделкиinteger
UF_QUOTE_ID Идентификатор связанного коммерческого предложенияinteger
USER_DESCRIPTION Комментарийstring


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024