crm.invoice.fields
Scope: catalog Permissions to execute: for all
crm.invoice.fields()
Returns field description for the invoice, including user fields.
Parameters
No parameters.
Example
BX24.callMethod(
"crm.invoice.fields",
{},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
Fields, returned by the method
| Field | Description | Тип | Note |
|---|---|---|---|
| ID | Identifier | integer | 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 of issue | date | |
| DATE_INSERT | Date of creation | datetime | |
| DATE_MARKED | Date of denial | datetime | Specified, if invoice is denied |
| DATE_PAY_BEFORE | Payment due date | date | |
| DATE_PAYED | .Date when transferred into paid status | datetime | Read only |
| DATE_STATUS | Date when status is updated | datetime | Read only |
| DATE_UPDATE | Date when updated | datetime | Read only |
| EMP_PAYED_ID | ID of the user who was the last to transfer invoice into the ''paid'' status | integer | Read only |
| EMP_STATUS_ID | ID of the user who was the last to change invoice status | integer | Read only |
| LID | Site ID | integer | Read only |
| XML_ID | External code | string | |
| ORDER_TOPIC | Topic | string | Required |
| PAY_SYSTEM_ID | Hard copy ID | integer | Required |
| PAY_VOUCHER_DATE | Payment date | date | Specified, if invoice is paid |
| PAY_VOUCHER_NUM | Payment document number | string | Specified, if invoice is paid |
| PAYED | Paid attribute | char | Read only |
| PERSON_TYPE_ID | Payer type ID | integer | Required |
| PRICE | Sum | double | Read only |
| REASON_MARKED | Status comment | string | Указывается, если счёт оплачен или отклонён |
| RESPONSIBLE_EMAIL | Responsible user e-mail | string | Read only |
| RESPONSIBLE_ID | Responsible e-mail | integer | |
| RESPONSIBLE_LAST_NAME | Responsible person last name | string | Read only |
| RESPONSIBLE_LOGIN | Responsible user login | string | Read only |
| RESPONSIBLE_NAME | Name of the responsible user | 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 position | string | Read only |
| STATUS_ID | Status ID | crm_status | "INVOICE_STATUS" selection list ID |
| TAX_VALUE | Tax amount | double | Read only |
| UF_COMPANY_ID | Company ID | integer | Specified, if the payer is a legal entity |
| UF_CONTACT_ID | Contact ID | integer | Specified, if the payer is a private individual, or as the company contact representative |
| UF_MYCOMPANY_ID | Your company ID | integer | Specified as the company with the invoice details (binding to details is specified separately) |
| UF_DEAL_ID | Binded deal ID | integer | |
| USER_DESCRIPTION | Comment | string | |
| PR_LOCATION | Location ID | integer | Required, if the tax document mode is used |
| INVOICE_PROPERTIES | Property list | array | If the client is a company, the following keys can be specified (all values have the string type):
COMPANY - Company name; COMPANY_ADR - Address; CONTACT_PERSON - Contact person; EMAIL - E-mail; PHONE - Phone number; INN - taxpayer reg.No.; KPP - tax registration reason code ; If client, the contact data: FIO - Full name; ADDRESS - Address; EMAIL - E-mail; PHONE - Phone; |
| PRODUCT_ROWS | List of product positions | array | Product position fields:
ID - Identifier (integer), specify zero for the new record; PRICE - price (double); DISCOUNT_PRICE - Discount per product item (double); PRODUCT_ID - Product ID in the catalog (integer), zero - if not included in the catalog; PRODUCT_NAME - Name of product position (string); VAT_RATE - VAT rate (double); VAT_INCLUDED - VAT is included into the price ('Y' or 'N') (char); MEASURE_CODE - Unit of measurement code (integer); MEASURE_NAME - Unit of measurement designation (string); CATALOG_XML_ID - Catalog external code (string), read only; PRODUCT_XML_ID - External code of product position (string), matches with the product external code, if it is from catalog. Read only. QUANTITY - Quantity. |