crm.invoice.list

Scope: catalog Permissions to execute: for all

Returns list of invoices.

Use the following masks for selection:

• "*" - to select all fields (without user fields)
• "UF_*"- to select all user fields.

The method crm.invoice.list does not return properties and invoice product items.

Use the method crm.invoice.get to get properties and product items.

Parameters

See description of list method.

Parameter	Description
filter	Entry filter. All entries are passed by default, without filtering.
order	Entry sorting. Sorting by the same filters as in the filter is supported.

Example

The example below prints output to the console. If required to get the output differently, write your own formatting code to layout data returned by result.data() and 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();
			}
		}
	);	

The method returns the fields listed in the table below

Field	Description	Type	Notes
ID	Identifier	interger	Read only
ACCOUNT_NUMBER	Number	string	Required
COMMENTS	Manager comment	text
CREATED_BY	Created by user	integer	Read only
CURRENCY	Currency ID	crm_currency	Read only
DATE_BILL	Date when issued	date
DATE_INSERT	Date when created	datetime
DATE_MARKED	Date when declined	datetime	Specified when invoice was declined
DATE_PAY_BEFORE	Payment date	date
DATE_PAYED	Date when invoice status becomes "paid"	datetime	Read only
DATE_STATUS	Date when status is changed	datetime	Read only
DATE_UPDATE	Date when invoice is updated	datetime	Read only
EMP_PAYED_ID	User ID who was the last to change invoice into "paid" status	integer	Read only
EMP_STATUS_ID	User ID who was the last to change invoice status	integer	Read only
LID	Site ID	integer	Read only
IS_RECURRING	Recurring invoice flag (When set to Y, it is not deal, but a template)	char
XML_ID	External code	string
ORDER_TOPIC	Topic	string	Required
PAY_SYSTEM_ID	Print form ID	integer	Required
PAY_VOUCHER_DATE	Payment date	date	Specified when invoice is paid
PAY_VOUCHER_NUM	Payment document number	string	Specified when invoice is paid
PAYED	Paid attribute	char	Read only
PERSON_TYPE_ID	Payer type ID	integer	Required
PRICE	Total	double	Read only
REASON_MARKED	Status comment	string	Specified when invoice is paid or declined
RESPONSIBLE_EMAIL	Responsible user e-mail	string	Read only
RESPONSIBLE_ID	Responsible user ID	integer
RESPONSIBLE_LAST_NAME	Responsible user last name	string	Read only
RESPONSIBLE_LOGIN	Responsible user login	string	Read only
RESPONSIBLE_NAME	Responsible user name	string	Read only
RESPONSIBLE_PERSONAL_PHOTO	Responsible user photo ID	integer	Read only
RESPONSIBLE_SECOND_NAME	Responsible user middle name	string	Read only
RESPONSIBLE_WORK_POSITION	Responsible user work position	string	Read only
STATUS_ID	Status ID	crm_status	"INVOICE_STATUS" ID
TAX_VALUE	Tax amount	double	Read only
UF_COMPANY_ID	Company ID	integer	Specified, when the payer is "Legal entity"
UF_CONTACT_ID	Contact ID	integer	Specified, when the payer is "Private entity", or as the company contact person
UF_MYCOMPANY_ID	User company ID	integer	Specified as the company with invoice details (binding to details is specified separately)
UF_DEAL_ID	Binded deal ID	integer
UF_QUOTE_ID	Binded estimate ID	integer
USER_DESCRIPTION	Comment	string