Меасофт - Вклад участника [ru]

Руководство программиста

2026-04-28T08:53:39Z

OlegD: /* Объект TPicture */

== Основные положения ==

В систему «MEASOFT» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

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

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

'''SET($a, a)''' – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

'''IF(a,b,c)''' или '''IF(a,b)''' – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

'''WHILE(a, b)''' – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

'''FOR($a, b, c, d)''' – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

'''NEW(ClassName, InstanceName)''' – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

'''FREE(InstanceName)''' – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

'''ShowObjects''' – Возвращает список созданных объектов – названия классов и имена.

'''ERROR(message)''' – Вызывает ошибку с текстом message.

'''SHOWMESSAGE(message)''' – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

'''SimpleAskUser(Message)''' – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

'''TRY(a)''' – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

'''REM(….)''' – Код в скобках игнорируется (комментарий).

'''EXEC(FileName, Params, Wait, WindowState)''' – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

'''CASE''' - Оператор множественного выбора. Позволяет выполнить одно из нескольких действий в зависимости от условий. Синтаксис:
<source>
case(
when(условие1, действие1);
when(условие2, действие2);
...
else(действие_по_умолчанию);
);
</source>

Пример использования:
<source>

set($a, 10);
set($b, 50);

showmessage(
case(
when($a < 5, 50);
when($a < 10, 100);
when($a < 250, 200);
else($a*$b);
)
);
</source>

'''AttachDebugger''' - Команда позволяет подключить открытый [[Отладчик_встроенных_скриптов]] к текущему скрипту. Команда AttachDebugger должна быть '''первой командой''' в скрипте. Добавьте её в самое начало скрипта:

<source lang="json">
<?>
AttachDebugger;
set($a, 10);
set($b, 20);
set($sum, $a + $b);
showmessage($sum);
</source>

'''Как работает:'''
# При выполнении команды AttachDebugger скрипт останавливается.
# Отладчик автоматически подключается к выполняющемуся скрипту.
# Текст скрипта загружается в редактор отладчика.
# Можно ставить точки останова, просматривать переменные и продолжать отладку.

'''Важно:'''
* Отладчик должен быть в режиме отслеживания до того, как скрипт дойдёт до команды AttachDebugger.
* Если режим отслеживания не включён, команда `AttachDebugger` игнорируется.
* В режиме отслеживания может работать только один отладчик.
* Команда AttachDebugger должна быть первой командой в скрипте.

=== Строковые функции ===

'''UpCase(s)''' – возвращает строку s в верхнем регистре.

'''LCase(s)''' – возвращает строку s в нижнем регистре.

'''Len(s)''' – возвращает количество символов в строке s.

'''Pos(s, substr [,start])''' – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Параметр start - это позиция старта поиска, не обязательный параметр, по умолчанию равен 1. Поиск не чувствителен к регистру.

'''Param(s, i)''' – возвращает i-й элемент строки s, разделенной запятыми на элементы.

'''ParamsCount(s)''' - возвращает количество элементов строки s, разделенной запятыми на элементы.

'''SetParam(s, p, i)''' – заменяет на значение p i-й элемент строки s, разделенной запятыми на элементы.

'''Left(s, i [,full] )''' – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

'''Mid(s, i, j)''' - возвращает подстроку из s начиная с i символа и длиной j символов

'''Right(s, i [,full])''' – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

'''Reverse(s)''' - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

'''Char(i)''' – возвращает символ с кодом i.

'''Ord(s)''' – возвращает код первого символа строки s.

'''Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive])''' - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

'''RemSpace(s)''' – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

'''SumStr(f [, captions, language])''' – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

'''NumToStrSimple(f [, captions, language])''' – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

'''FullNameToShort(Name)''' – Возвращает фамилию и инициалы по полному ФИО Name.

'''MonthName1(m)''' – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

'''MonthName2(m)''' – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

'''StrForXML(s)''' - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

'''FixedIntToStr(i, len[, char])''' - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

'''Translate(format, [param1, param2, ...])''' - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

'''ExtractFileName(FilePath)''' - возвращает имя файла с расширением из полного пути к файлу FilePath.

====Функции перекодировки====
'''DecodeStr(s, charset)''' - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

'''EncodeStr(s, charset)''' - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

'''Translit(s)''' - транслитерация строки русского текста s латиницей

'''UnTranslit(s)''' - транслитерация строки s с латиницы на русский.

==== Экранирование ====

'''QUOTEDSTR(s)''' – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

'''SQLFloat(f)''' – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

'''FormatTextXML(s)''' - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

'''FormatTextJSON(s)''' - переводит строку в формат JSON, экранирует служебные символы.

'''FormatTextBlob(s)''' - строка s содержит файл, функция перекодирует переданную строку в байты, используется для заполнения полей формата blob.

====Хеширование ====

'''HMACHash256(key, text)''' - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

'''MD5Hash(text)''' - создаёт хеш по алгоритму MD5

'''SignatureUrl(url)''' - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

'''CurrTime''' – возвращает текущее время

'''CurrDate''' – возвращает текущую дату

'''CurrMillisecond''' - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

'''Today''' - возвращает текущую дату в числовом формате.

'''Day(dt)''' – возвращает день месяца даты dt.

'''Month(dt)''' – возвращает месяц года даты dt.

'''Year(dt)''' – возвращает год даты dt.

'''FirstDayOfMonth(dt)''' – Возвращает первый день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( FirstDayOfMonth( CurrDate() ) );
'''Полужирное начертание'''
'''LastDayOfMonth(dt)''' – Возвращает последний день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( LastDayOfMonth( CurrDate() ) );

'''DaysInMonth(month, year)''' – Возвращает количество дней в указанном месяце.

'''IncDay(dt, [count=1])''' – Возвращает дату, увеличенную на count дней.

'''SQLDate(dt)''' – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

'''SQLDateToDate(dt)''' – Переводит дату из SQL-формата в обычный.

'''DAYSBETWEEN(dt1, dt2)''' – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

'''TimeBetween(t1, t2)''' - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

'''WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0], [DefaultHolidayVarNum=1])''' - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней(по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

'''TimePeriod(time1, time2)''' - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

'''StrDateToFloat(s, [time=false])''' - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

'''IsAWorkDay(dt)''' - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

'''IncWorkDay(dt, [count=1],[DefaultHolidayVarNum=1])''' - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней (по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

'''Sleep'''(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

'''INT(v)''' – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

'''FLOAT(v)''' – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

'''STR(v)''' – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

'''Date(v)''' – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

'''Time(v)''' – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

'''ROUNDUP(f)''' – округляет число f до ближайшего большего по модулю целого числа.

'''ROUNDDN(f)''' – округляет число f до ближайшего меньшего по модулю целого числа.

'''Money(f, CouldBeEmpty, ZeroFill, MakeSpace)''' - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.
''Подсказка: для простого округления используется функция int()''

'''Abs(f)''' - возвращает модуль числа f.

'''Mod(x, y)''' - возвращает остаток от деления целочисленного числа x на целочисленное число y.

=== Константы ===

'''Null''' – Возвращает пустое значение.

'''Да''', '''True''', '''Нет''', '''False''' – константы, соответствующие булевым значениям.

=== Прочие функции ===

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding [, append])- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Если append = true, то производится дописывание данных в файл, а не перезаписывание (не обязательный, по умолчанию выключен).

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - Дополнительные заголовки HTTP запроса, передается в виде списка параметров через запятую и всегда образуют пару: 1 параметр - название заголовка, 2 параметр - значение. Если значение содержит запятую то его нужно экранировать в двойные кавычки. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в миллисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

LastHttpError - Выводит последний запрос выполненный с ошибкой в функции HttpPost. Содержит подробную информацию по запросу и ответу.

LastHttpResponse - Выводит последний запрос и ответ от сервера после выполнения Http-запроса в функции HttpPost.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel. Для работы без установленного MS Excel предусмотрен объект TDirectExcel.

'''''Ввод данных'''''

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Если TranslateHeader истинно, то заголовки таблицы будут автоматически переведены.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

Close – Закрывает текущий файл.

'''''Ячейки'''''

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

'''''Строки'''''

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

RowAutoFit([y1, y2]) - Устанавливает автоматическую высоту строк. Аргументы y1 и y2 необязательны и если не указаны, то процедура будет выполнена для всей страницы, в ином случае только для строк от y1 до y2.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

GetRowHeight(r) – Возвращает высоту строки r в пикселях.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

'''''Столбцы'''''

ColCount - Возвращает количество столбцов в листе.

AutoFit – Устанавливает автоматическую ширину столбцов.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SetColWidth (c, w) – Устанавливает ширину столбца c в w пикселей.

GetColWidth (c) – Возвращает ширину столбца c в пикселях.

'''''Листы'''''

SetSheet(No) – Устанавливает номер текущего листа. Если лист с таким номером не существует - он будет создан (и все листы до него). Нумерация начинается с 1.

SetSheetName(Name) - Устанавливает название текущего листа.

SheetsCount – Возвращает количество листов в книге.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

SheetDelete(i) - Удаляет лист с номером i.

'''''Форматирование'''''

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

NumberFormat(x1, y1, x2, y2, Format) - Устанавливает формат вывода чисел в указанном диапазоне ячеек. Например, если Format='0.00' - числа будут выводиться c обязательными 2 знаками после десятичного разделителя.

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

SaveValuesOnly - убирает формулы на текущей странице и оставляет лишь их результативные статичные значения.

'''''Цвета'''''

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

'''''Копи-паст'''''

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

'''''Изображения'''''

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0, width=0, height=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки, width, height (не работает для DirectExcel) - ширина и высота области рисунка в пойнтах-единицах Excel

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

'''''Вывод'''''

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр copies - количество копий, по умолчанию равен 1.

Save(filename) - Сохраняет в файл filename. Если файл существует, в основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

'''''Пример использования'''''

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{| class="wikitable"
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|-
|GetSQL
|Для отладки. Возвращает последний SQL запрос переданный в методы Open, Query, GetSQLValue
|-
|ExportExcel
|Для отладки. Выгружает в эксель содержимое датасета. Можно использовать в незнакомом окружении для понимания передаваемых полей в : шаблонах, печатных формах и т.д. Аналог команды %echo% в шаблонах, на случай если она не сработает.
|-
|OnGetText
|Функция подменяет текстовый вывод значения поля при выгрузке в эксель. Первый параметр это имя поля, которое надо подменить. Второй параметр это то что необходимо вывести. Работает только с текстовыми полями.
'''''Пример использования'''''
DB.OnGetText('Зона', IF((DB.FieldByName('-Lat') ! 0) * (DB.FieldByName('-Lon') ! 0),
GetPolygonByLatLon(DB.FieldByName('-Lat'), DB.FieldByName('-Lon'), 'TYPE = 1 AND IFNULL(zone, 0) > 0 AND PRICE = ' + DB.FieldByName('-price'), 'zone')
,
''
));
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

GetDefaultPrinter - Возвращает имя текущего активного принтера.

SetDefaultPrinter(Printer) – Запоминает предыдущий активный принтер и устанавливает новый текущий принтер. Printer - имя принтера. При необходимости нескольких последовательных вызовов SetDefaultPrinter рекомендуется между вызовами использовать RestoreDefaultPrinter.

RestoreDefaultPrinter - Устанавливает активным принтер, который был текущим перед последним вызовом SetDefaultPrinter.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Для кода DataMatrix можно установить режим для печати скрытых символов с кодами 29(GS) и 232(FCN1), которые требуются для формирования Честного Знака. Для этого необходимо в начале строки указать символ "[" и все разделители 01, 21, 91, 92 так же экранировать этими скобками. Должно получиться [01]02900002317701[21]k3LInNbH_oG0Q[91]EE06[92]YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= . При формировании кода, включится режим формирования штрих-кода DataMatrix GS1, в начале будет добавлен символ с кодом 232 (FCN1), а потом будут добавлены разделители с кодом 29 (GS)
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Crop - функция, которая вырезает часть изображения и оставляет только вырезанную часть. Есть две формы функции: Crop(X, Y, Width, Height) - вырезает прямоугольник шириной Width и высотой Height начиная с координат X, Y.
Crop([Brightness]) - вырезает прямоугольную часть изображения, где есть пиксели темнее фона (Brightness). Фон задается числом от 1 до 255, по умолчанию 255. Функция возвращает true, если операция прошла успешно или false,
если операцию выполнить невозможно.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «MEASOFT». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator][,Correction])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1.
Поле Correction позволяет указать данные для корректировочного чека, используется в системе Штрих-М. По умолчанию пустая строка. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [DeliveryDateMode=0, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; DeliveryDateMode: 0 - установить план. дату доставки текущим рабочим днем, 1 - установить план. дату доставки следующим рабочим днем, 2 - установить план. дату доставки равной планируемой дате оплаты АПД; Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД). Работа функции может быть изменена системной доп. возможностью OnCreateAddressForActDelivery.

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''GetRouteCode(AddressText, TownCode, LatLon[, Lon])''' - для адреса AddressText в городе с кодом TownCode (из таблицы Town) по географическим координатам lat, lon возвращает код роута (записи, хранящей координаты адреса в городе). Если роут не найден (для адреса в городе не найдено записи с указанными координатами) - создает новый роут и возвращает его код, если роут найден (был создан ранее) - обновляет у роута координаты. Если параметр Lon задан, то параметр LatLon должен содержать одну координату, иначе LatLon должен содержать строку вида 'lat, lon'.
В случае ошибки возвращает Null.

Пример:<br>
Set($res, GetRouteCode(address, townto, '55.114034, 36.592397'));<br>
Set($res, GetRouteCode('Троицк, Полковника милиции Курочкина ул., 11', 1, '37.467446, 55.740537'));<br>
Set($res, GetRouteCode('Обнинск, Маркса пр., 20', TownByName('Обнинск'), 55.114034, 36.592397));

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''CalcClientCnt(client_code, date, is_intown [, date_put=CurrDate(), skipajust=false])''' - функция расчета количество доставленных корреспонденций у клиента с кодом client_code за предыдущий месяц от даты date (Или за текущий месяц, подробнее смотри переменную UseCurrentMonthCount) среди внутригородских (is_intown = true) либо междугородних (is_intown = false) корреспонденций, date_put - дата доставки (для альтернативного способа подсчета, включаемого переменной UseDatePutForCalcCnt), skipajust - не учитывать принудительно введенные количества (таблица priceclientadjust типы записей 0 и 1).

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcTownPrice''' - возвращает базовую стоимость междугородней доставки, посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов, типа, срочности, массы, расстояния.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset.self".

*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*tp - тип корреспонденции;
*mode - режим доставки;
*mass - масса отправления;
*TownFrom - код города отправителя;
*TownTo - код города получателя.

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FromEmailStr''' - строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber,Print,[printer]) - Выполняет указанную печатную форму в объекте excel. Excel объект можно не указывать, тогда функция сама создаст объект экселя и разрушит его, полезно когда книгу
нужно распечатать или отправить по email (на листе данных в ячейке 1,1 укажите ключевое слово email). Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Print - печатает книгу на принтере, после печати объект excel разрушается, при использовании параметра не указываете объект excel. Printer - имя принтера, на котором печатать (по умолчанию пустая строка, что означает "печатать на принтере по умолчанию"). Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

'''SelDistAddr(s)''' – Возвращает строку для вставки в select запрос, для вывода поля с упрощенным адресом. Принимает один необязательный строковый параметр - алиас таблицы из которой будет упрощаться поле address, по умолчанию "a"

'''VoiceReadStr(str)''' – Озвучивает фразу str голосовым уведомлением доступными словами из базы. Может содержать тег "{break_off}" для того, чтобы сделать эту фразу не пропускаемой в очереди воспроизведения.

'''CalcStorageCost(ClientCodes, DateFrom, DateTo, NeedReport[, Store])''' – рассчитывает стоимость хранения на складе для выбранных клиентов (ClientCodes - коды клиентов через запятую), в период дат с DateFrom до DateTo, с прикреплением к корреспонденции отчета в зависимости от выставленного параметра NeedReport. Может содержать параметр Store - код филиала, по умолчанию пустой (расчет выполняется для всех филиалов). Возвращает коды созданных корреспонденций через запятую.

'''WriteOut(DocId, ItemId, Date, Cnt[, BC])''' – производит списание товара со склада. DocId - код (docs.code) документа списания, ItemId - код товара (item.code), Date - дата операции, Cnt - количество списываемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер. Если указан BC, то параметр ItemId игнорируется и поиск номенклатуры происходит исключительно по штрих-коду. В случае успеха, функция возвращает строку вида: код номенклатуры, списанное кол-во.

'''IncomePurch(DocId, ItemId, Date, Cnt[, BC, Location = CurrentLocation])''' – производит приход товара на склад. DocId - код (docs.code) приходной накладной, ItemId - код товара (item.code), Date - дата операции, Cnt - количество приходуемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер, Location - код склада (store.code). В случае успеха, функция возвращает строку вида: код номенклатуры, введенное кол-во.

'''CreateLedgerDoc(Date, Client, UserCode, Type[, ExtNumber, Message])''' - создает складской документ и возвращает код этого документа. Date - дата документа. Client - код клиента. UserCode - код пользователя, создавшего документ. Type - тип документа (statetype = 13). ExtNumber - номер у поставщика для документов прихода и расхода. Message - комментарий к документу. Последние два аргумента не обязательные и могут быть пустыми.

'''SendManifestToIntegration(Codes)''' - отправляет манифесты с кодами Codes по интеграции. Возвращает ошибки каждая с новой строки если они есть и пустоту если ошибок нет.

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID (для провайдера iVoice - идентификатор сценария (кампании)). Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдеров BitCall и iVoice. Для BitCall по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием). Для iVoice по умолчанию подразумевается параметр 'response', при этом будет возвращен JSON с ответами абонента на заданные вопросы (в зависимости от сценария)

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, ZipPath) - Добавляет файл SrcPath в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл из строки Data в архив и располагает его по пути ZipPath. -ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

'''Функции общего назначения''':

'''ExecSimpleScript(Caption, Text)''' - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

'''FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns,ShowAll])''' - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. ShowAll - показать все дополнительные услуги, по умолчанию false и показывает только услуги с начислениями. Функция возвращает количество использованных столбцов.

'''PrintSticker(Codes, [ToBoxes=False])'''

'''PrintBlanc(Codes, BlancNumber)''' - печатать форму из раздела "Заполнить бланк". Codes - коды корреспонденций, BlancNumber - номер формы из раздела "Бланки для корреспонденции" (3)

'''GetItemByName(Name)'''

'''GetA4Printer([GetPrinterPort=False])''' - возвращает имя принтера выбранного для печати документов. GetPrinterPort - попытаться по имени принтера найти порт принтера.

'''GetStickerPrinter([GetPrinterPort=False])''' - возвращает имя принтера выбранного для печати стикеров. GetPrinterPort - попытаться по имени принтера найти порт принтера.

'''GetDuplexPrinter([GetPrinterPort=False])''' - возвращает имя принтера выбранного для двусторонней печати, если принтер не выбран, возвращает пустую строку.

'''PrintAttachPDFPage(Code, FileName, Page, Printer)''' - печатает страницу из вложенного файла PDF. Code - код вложения (attachment) или путь к файлу, Page - номер страницы, Printer - 0 = принтер A4, 1 = принтер этикеток.

'''AttachPDFToText(Code, [TextFileName])''' - преобразует файл PDF из вложений в текст. Code - код вложения (attachment) или путь к файлу, TextFileName - имя текстового файла, в который записывается результат (если не указан, используется временный файл). Возвращает текст в виде строки.

'''GhostScript(GScript, Code)''' — функция для выполнения консольных команд утилиты [https://ghostscript.readthedocs.io/en/latest/Use.html ghostscript]. Где, GScript — строка с командами Ghostscript; Code — код вложения или путь к PDF-файлу, предназначенному для обработки. В командах доступен специальный тег %MeasoftInFile%, который автоматически заменяется на путь к предварительно загруженному файлу (Code). Если в команде необходимо указать путь для сохранения результата обработки, используйте тег %MeasoftOutFile%. В этом случае функция на основании параметра Code автоматически сформирует имя временного выходного файла. После успешного выполнения команд функция возвращает путь к сгенерированному выходному файлу - %MeasoftOutFile%.

'''GetActiveForm([SkipFormName])''' - возвращает код активной формы в программе где происходит сканирование. SkipFormName - не обязательны параметр, имя формы которую нужно пропустить при определении интерфейса.
'''Список интерфейсов''':
0 - неопределенный;
1 - прием корреспонденции на склад;
2 - АПД;
3 - комплектация адресов (ShelfingForm);
4 - доска приема;
9 - вкладка «Манифесты»;
10 - Инвентаризация корреспонденции;
11 - АПК;
12 - вкладка «Адреса»;
13 - вкладка «Выдача»;
14 - вкладка «Склад»;
15 - Список номенклатуры;
16 - Инвентаризация склада;
17 - Приходная накладная;
18 - Списание товара;
19 - Карточка корреспонденции.

'''AddAddressScanLog(Code[, StrBarCode, IsManual, FromInterface, ExtraInfo])''' - добавляет событие сканирование для корреспонденции с кодом Code. Необязательные параметры: StrBarCode - сканируемый ШК корреспонденции (по умолчанию пустой), IsManual - галка ручного сканирования (по умолчанию false), FromInterface - код интерфейса сканирования (StateType=81, по умолчанию 0 - неопределенный), ExtraInfo - текстовый комментарий события.

'''RuleName(alias)''' - Выдает полный путь в дерева прав по псевдониму права.

'''ShowText(Caption:string, Value:string)''' - показывает пользователю окно с заголовком Caption и с многострочным полем со значением Value. Может быть полезен при отображении логов выполненной операции.

'''ShowScanError(msg [, Speek, Color, Abort])''' - выдает пользователю окно с текстом msg блокируя последующие действия сканирования. Если Speek - истинно, то сообщение проговаривается голосовым движком, по умолчанию выключено. Color - целочисленное число цвета, в который будет окрашен фон сообщения (по умолчанию = -1, стандартный). Abort - прервать выполнение скрипта, не показывая ошибку.

'''CheckRule(alias)''' - функция проверки разрешения у текущего пользователя системы, alias - псевдоним права. Возвращает 1, если право есть и 0, если права нет.
Пример: if(CheckRule('RSE'), ShowMessage('У пользователя есть право изменять счета'), ShowMessage('У пользователя нет права изменять счета'));

'''GetKurierMoney(KurierCode, DateEnd, NonCash)''' - возвращает баланс курьера с кодом KurierCode на дату DateEnd. NonCash - булевый флаг, если истинно, то будет рассчитан безнальный баланс;

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

ClientTown - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

== Объект TFieldObject ==
Создается только автоматически. Объект для доступа к записям, используется в картах и дополнительных услугах (addressrecord) и событиях карточки корреспонденции (fieldlist). Методы объекта:

'''_GetTableInfo''' - возвращает данные о полях и примеры данных объекта.

'''_Self''' - возвращает ссылку на объект.

'''_Set(fieldname, fieldvalue [, DoUpdateForm])''' - Если базовый объект строка. Устаналивает для поля fieldname значение fieldvalue. DoUpdateForm по уолчанию false, если указать true то обновление поля будет не только в объекте но и пользовательском интерфейсе. Обновление работает только в карточке корреспнденции для ограниченного набора полей: vlog, mode, type, date_put, time_put, message, kurier, state1.

'''_Set(keyfield, keyvalue, filed, value)''' - Если базовый объект таблица (addressrecord.boxes). Работает перегруженная версия метода _set, cначала происходит поиск строки по ключу, далее меняется значение указанного столбца. keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Пример, отключение услуги база:

addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

== Объект TMessage ==
Создается только автоматически. Объект используется для скриптовой обработки письма в [https://wiki.courierexe.ru/index.php/%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8F_%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8#.D0.98.D0.BC.D0.BF.D0.BE.D1.80.D1.82_.D0.B4.D0.B0.D0.BD.D0.BD.D1.8B.D1.85| заданиях импорта данных]. В себе содержит текст письма в очищенном формате и оригинальном формате HTML, отправитель письма, тему письма, дата получения и список прикрепленных файлов.

'''Message.Text''' - возвращает очищенный от HTML-тегов текст письма.

'''Message.HTMLText''' - возвращает оригинальный текст письма со всеми HTML-тегами.

'''Message.Sender''' - возвращает email-адрес отправителя письма.

'''Message.AttachmentsCount''' - возвращает количество вложенных файлов.

'''Message.DateTime''' - возвращает дату и время получения письма.

'''Message.Subject''' - возвращает тему письма.

'''Message.GetAttachmentDataString(Number)''' - возвращает вложенный файл под номером Number в виде строки.

'''Message.GetAttachmentName(Number)''' - возвращает имя вложенного файла под номером Number.

== Объект TStringList ==
Может использоваться для построчной обработки многостраничных файлов либо для организации текстовых данных. Номер строк начинается с 0.
Имеет следующий функционал:

'''Count''' - возвращает количество строк в списке.

'''Add(Value:string)''' - добавляет значение Value в конец списка.

'''SetText(Value:string)''' - устанавливает значение списка в значение Value.

'''Insert(Number:integer, Value:string)''' - добавляет строку Value в позицию Number.

'''Delete(Number:integer)''' - удаляет строку из списка в позиции Number.

'''Clear''' - очищает элементы списка.

'''LoadFromFile(Path:string)''' - загружает текстовый файл по пути Path.

'''Strings(Number:integer)''' - возвращает строку с номером Number.

'''SetString(Number:integer, Value:string)''' - устанавливает значение строки с номером Number в значение Value.

'''Text''' - возвращает полный список строк в виде текста.

'''CommaText([Quoted:boolean])''' - возвращает список значений через запятую. Если Quoted = true, то квотирует элементы списка. По умолчанию равен false.

'''SetCommaText(Value: string)''' - разбивает значение Value на отдельные строки и кладет в список. Разделитель - запятые.

'''IndexOf(Value:string)''' - ищет значение Value среди элементов списка и если находит, то возвращает номер строки. Возвращает -1 если значение не было найдено.

'''Sorted(Value:boolean)''' - устанавливает флаг отсортированности списка в Value. Если Value = true, то сразу же его сортирует. По умолчанию Value = false.

'''Exchange(Pos1:integer, Pos2:integer)''' - меняет элементы списка с позициями Pos1 и Pos2 местами.

'''Duplicates(Value:integer)''' - изменяет параметр управления дубликатами в списке. Если Value = 0 (значение по умолчанию), то список не реагирует на дубликаты. Если Value = 1, то список при добавлении будет игнорировать дубликаты. Если Value = 2, то список будет выдавать исключение, при добавлении дубликата в список.

'''ParamName(Number:integer[, Delimiter:string])''' - возвращает текст до первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает пустоту.

'''ParamValue(Number:integer[, Delimiter:string])''' - возвращает текст после первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает всю строку.

== Объект TFunc ==
Объект реализует создание и использование функций в скриптовом языке. Позволяет определять переиспользуемые блоки кода с параметрами.
Важно учитывать, что внтури функции создается свой инстанс интерпретатора и от туда не доступны никакие переменные\объекты кроме переданных в функцию.

Основные методы:

'''New'''(FuncName, Param1, Param2, ..., Body) — создание новой функции.Функция возвращает результат выполнения последней команды в теле функции. Аргументы:
* `FuncName` — имя функции (строка)
* `Param1, Param2, ...` — имена параметров функции (переменные начинаются с `$`, объекты — без префикса)
* `Body` — тело функции (скрипт, выполняемый при вызове)

'''FuncName'''(Arg1, Arg2, ...) — вызов созданной функции по имени. Если в объявлении была указана тип переменная, то и подставлять в аргумент надо обязательно переменную. Будет передано значение этой переменной (переменные словарине поддерживаются!). Если был объявлен объект, то указатель на объект должен быть получен через метод '''_self'''. C функциями поддерживают работу следующие классы: TExcel, TDirectExcel, TCSVFile, TADO, TSelfADO, TPrinter, TCanvas, TPicture, TTable, TINIFile, TSMS, TXML, TJSON, TZip, TStringList, TBaseUtils, а также объект addressrecord (TFieldObject). Результатом работы функции может быть число или строка.

Пример 1, обработка результатов функции:
<source>
<?>
new('TFunc', 'calc');
calc.new('Sum', '$a', '$b',
$a + $b
);

set($x, 10);
set($y, 20);
showmessage(calc.Sum($x, $y));
</source>

Пример 2, передача объекта в функцию:
<source>
<?>
new('TFunc', 'utils');
utils.new('ProcessDB', 'dbConn', '$value',
showmessage($value);
dbConn.open('SELECT * FROM address limit 3 ');
if(dbConn.recordcount > 0,
showmessage('Найдено записей: ' + dbConn.recordcount);
dbConn.first;
while(dbConn.eof = 0,
showmessage(dbConn.fieldbyname('code'));
dbConn.next
)
,0)
);

new('TSelfADO', 'db');
utils.ProcessDB(db._self,'test!');
</source>

== Применение языка формул ==
'''в различных контекстах системы «MEASOFT» и сопутствующих проектах'''

=== MEASOFT ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с уровнем (pricelevel) меньше текущего.

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===
{|
||'''Изменено:'''
|2026.0.0.550 Доработка функций интерпретатора GetA4Printer, GetStickerPrinter, GetDuplexPrinter.
|-
||'''Изменено:'''
|2026.0.0.547 Доработка функций ATTACHPDFTOTEXT и PRINTATTACHPDFPAGE, добавлена возможность указать путь к файлу
|-
||'''Добавлено:'''
|2025.0.0.539 Добавлена поддержка отладчика AttachDebugger
|-
||'''Добавлено:'''
|2025.0.0.534 Добавлена поддержка оператора CASE и класса TFunc
|-
|}

=== Версия 2021.0.0.57 от 18.06.2019 ===
{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-

API

2026-03-23T05:40:28Z

OlegD: /* Описание полей ответа статусов */

<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Изменения для 54-ФЗ'''

Для передачи ставки НДС при оформлении заказа добавлен атрибут items > item > VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС.

'''ВНИМАНИЕ'''

В ближайшем будущем при подключенной услуге кассового обслуживания система '''перестанет''' принимать заказы без состава вложений.

</div>

<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API Documentation|HERE!]]'''
</div>

Вы можете настроить интеграцию с MeaSoft средствами XML API по протоколу HTTP POST.

API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft].

Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим.

При написании этой документации мы предполагаем, что ее читатель обладает необходимой для понимания квалификацией программиста, владеет XML и средой разработки, в которой он делает интеграцию. Если вы не программист, вам необходимо привлечь к проекту профессионального программиста.

Если у вас после прочтения документации остались вопросы, задайте их по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите ваши контактные данные (телефон, скайп) и название компании, с которой вы хотите интегрироваться.

== Готовые интеграции ==
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.

'''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''
Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.

Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.

{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;" | [https://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 20.5.0 и выше. Подробнее см. [[1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше. Подробнее см. [[PrestaShop|описание]].
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[https://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[https://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[https://courierexe.ru/download/api/measoft_oc3.ocmod.zip Скачать для версии 3.0]
|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[OpenCart|описание]].
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа. Инструкции есть в маркете, а также см. [[Webasyst|описание]].
|-

|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[InSales|Инструкция по настройке]]
|-
|[[Файл:iiko.jpg|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Iiko|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[https://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]
|[[LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков (1 версия)]

[https://infostart.ru/public/1531484/ Альтернативный модуль сторонних разработчиков (2 версия)]
|-
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart. Инструкция в архиве
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/measoft Описание на сайте amoCRM]
|Подробное описание настроек читайте [[amoCRM|тут]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|
|[[МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|Интеграция МойСклад с курьерскими службами от сторонних разработчиков
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[https://courierexe.ru/wordpress/wordpress.php Скачать]
|[[Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[CS-Cart|Инструкция]]
|-
|[[Файл:webhooks.jpg|center|x100px]]
|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]
|Передача информации о статусах и заказах в вашу систему
|-
|[[Файл:Logo_tilda_black.png|center|x100px]]
|style="text-align: center;"|Читайте описание [[Tilda|на этой странице]]
|Работает только на платных тарифах
|-
|}

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]

Для отображения списка пунктов выдачи есть [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь].

== Тестовый аккаунт ==
Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.

На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.

Для упрощения интеграции можно скачать [https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

== Рабочий аккаунт для подключения ==
Строка подключения выглядит следующим образом:

<source lang=xml>
<auth extra="8" login="login" pass="pass"></auth>
</source>

Описание параметров:
* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.
* '''login''' — логин клиента;
* '''pass''' — пароль клиента;
* '''measoftid''' — системная переменная, используемая системой.

Запросите эти данные у курьерской службы, к которой вы подключаетесь. Курьерская служба передает временный пароль, его нужно сменить после первого входа в [[Личный кабинет клиента|ЛК клиента]].

== Авторизация курьерской службы ==
Если курьерской службе требуется подключение под своими учетным данными, используйте строку вида:

<source lang=xml>
<auth extra="8" login="login" pass="pass" clientcode="123"></auth>
</source>

Описание:
* '''extra''' — уникальный идентификатор компании;
* '''login''' — логин курьерской службы;
* '''pass''' — пароль курьерской службы;
* '''clientcode''' — внутренний код клиента (вкладка '''Клиенты''', столбец «Внутренний код»).

Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Личный кабинет курьерской службы#Подключение|Подключение]]».

== Общие понятия ==
На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК и прочее, в попытке глубокого анализа могут повреждать трафик на стандартный порт 443. Сделано по тикету 10964.</rspoiler> Обратите внимание на символ '''«/»''' (slash) в конце адреса.

Тестовые авторизационные данные: логин: login пароль: pass, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.

Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''.

Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.
Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM.

В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp; < на &lt; > на &gt; " на &quot;

Наше API принципиально работает только по HTTPS, так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.php
где <IP> — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.
Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>:8080</spoiler>
Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].

== Ограничения ==
С целью защиты от нецелевого использования сервисов и DDoS-атак действуют следующие ограничения:
* 30 запросов tracking с одного IP-адреса за 1 минуту (используйте statusreq!);
* 150 запросов с одного IP-адреса/акаунта за 1 минуту;
* 1500 запросов с одного IP-адреса/акаунта за 20 минут;
* 3000 запросов с одного аккаунта за 1 час;
* 200 Мб скачанных текстовых данных за 3 часа.
* Превышение количества запросов статусов несуществующих заказов над существующими

В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.

Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами «tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].
* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.
* нужно проверять с каким ответом возвращаются ваши АПИ-запросы. Если мы отвечаем ошибкой, то даже запрос на создание нового заказа учитывается в количестве запросов.

Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти рамки — спросите у нас, мы обязательно поможем!

== Оформление заказа ==

=== Пример оформления заказа ===
<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<neworder newfolder="NO">
<auth extra="8" login="login" pass="pass"></auth>
<order orderno="111111">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<inn>1112223335</inn>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<deliveryPIN>1234</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<deliveryprice VATrate="20">150</deliveryprice>
<discount>120</discount>
<paytype>CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>1</return_service>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<courier>22</courier>
<receiverpays>NO</receiverpays>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<respstore>4</respstore>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО "Рога и копыта"" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message="" quantity="3"></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000" VATrate="10">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
<advprices>
<advprice>
<code>1</code>
<value>123</value>
</advprice>
<advprice>
<code>2</code>
<value>10.5</value>
</advprice>
<advprice>
<code>3</code>
<value>true</value>
</advprice>
</advprices>
<extrafields>
<extrafield>
<name>courier_car</name>
<value>ВАЗ 2106, бежевый</value>
</extrafield>
</extrafields>
<overall_volume>81</overall_volume>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</neworder>
</source>

=== Описание элементов для оформления заказа ===
'''Обязательные поля'''

Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.
<spoiler text="Пример минимально возможного заказа">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="login" pass="pass" />
<order>
<receiver>
<company>МВД</company>
<phone>(495)123-45-67</phone>
<address>Петровка, 38</address>
</receiver>
</order>
</neworder>
</source>
</spoiler>

'''Описание полей'''

* '''neworder''' — Корневой контейнер, обязательный элемент.

:* '''''newfolder''''' — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

* '''order''' — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.

:* '''''orderno''''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет '''у клиента''' наличие заказов с указанным номером в '''пределах текущего календарного года''', которые '''не являются недоставленными''', и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists».
Если не указан штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).

* '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13.

<spoiler text="Заполнение номера заказа (шифра) и штрих-кода">
Шифр и штрих-код заполняются исходя из начальных значений:

# Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)
# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется
# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется
# Если оба непустые - валидируется ШК, шифр не проверяется

Корректный (валидный) ШК отвечает следующим требованиям:
* длина не меньше 5 символов
* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>
* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы)

Если ШК не прошел проверку, то:
* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)
* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)
</spoiler>

В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>
''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрихкода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT — префикс клиента, 00123 — номер заказа, 01-03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми и будут отражать штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрихкодом, то указанный штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах.

* '''sender''' — Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
<company>Название компании отправителя</company>
<person>Контактное лицо отправителя</person>
<phone>Телефон, Email отправителя</phone>
<town>Город отправителя в формате "Москва город"</town>
<address>Адрес отправителя</address>
<date>Дата забора в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время забора в формате "HH:MM"</time_min>
<time_max>Желаемое время забора в формате "HH:MM"</time_max>
</sender>
</source>

* '''receiver''' — Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
<company>Название компании получателя</company>
<person>Контактное лицо получателя</person>
<phone>Телефон, Email получателя</phone>
<town regioncode="Код региона">Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<inn>ИНН получателя</inn>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
</source>

* '''company''' — Компания-получатель.
* '''person''' — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей — company или person!''
* '''phone''' — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
* '''town''' — Город.
* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде:
:* код ПВЗ в нашей системе
:* код ПВЗ в системе подрядчика
:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ».

При указании ПВЗ в поле адреса необходимо проверять значение поля город получателя (он должен соответствовать данным ПВЗ) либо не передавать его вообще.

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.

Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.

Поле '''Город''' контейнеров '''sender''' и '''receiver''' можно указать одним из следующих способов:
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)

* '''coords''' — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно.

* '''zipcode''' — Почтовый индекс.
* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.
* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.
* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».
:* '''''VATrate''''' — Ставка НДС — целое число процентов.
* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.
* '''paytype''' — Тип оплаты заказа получателем. Принимает значения:
:* CASH — Наличными при получении (по-умолчанию)
:* CARD — Картой при получении
:* NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.
:* OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т. д.)
:* OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.
* '''weight''' — Общий вес заказа в килограммах.
* '''quantity''' — Количество мест.
* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Виды срочности|Виды срочности]]».
* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».
* '''return''' — Признак необходимости возврата. Принимает значения:
:* NO — Возврат не требуется
:* YES — Требуется возврат, например, документов
:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»).
* '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».
* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».
* '''return_weight''' — Общий вес возврата заказа в килограммах.
* '''enclosure''' — Вложение.
* '''instruction''' — Поручение — Примечание.
* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.
* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.
* '''department''' — Подразделение, в котором оформляется заказ.
* '''costcode''' — Кост-код сотрудника.
* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"
* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара
* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.
* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки.

* '''items''' — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты:
:* '''''item''''' — Название вложения.
:* '''''quantity''''' — Количество единиц товара.
:* '''''mass''''' — Масса единицы товара в килограммах.
:* '''''volume''''' — Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' — Длина единицы товара (в сантиметрах).
:* '''''width''''' — Ширина единицы товара (в сантиметрах).
:* '''''height''''' — Высота единицы товара (в сантиметрах).
:* '''''retprice''''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. 
:* '''''inshprice''''' — Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.
:* '''''VATrate''''' — Ставка НДС — целое число процентов. Если товар хранится в КС (смотрите '''article''' ниже), значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - значение из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.
:* '''''barcode''''' — Штрихкод вложения.
:* '''''article''''' — Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.
:* '''''type''''' — Тип вложения. Принимает значения:
:: 1 — Товар. По-умолчанию.
:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice
:: 3 — Услуга
:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.
:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе.
:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.
:* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.
:* '''''origincountry''''' — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.
:* '''''GTD''''' — Номер ГТД.
:* '''''excise''''' — Сумма акциза.
:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.
:* '''''suppphone''''' — Номер телефона компании поставщика, если отличается от заказчика.
:* '''''suppINN''''' — ИНН компании поставщика, если отличается от заказчика.
:* '''''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. При этом, если указано значение «?» или «!» и quantity больше 1, то такое вложение растиражируется quantity раз.
:* '''''govType''''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки:
:: 1 — Честный знак. По-умолчанию.
:: 2 — ГИИС ДМДК.
:: 3 — Серийный номер.
:* '''''message''''' — Строка сообщения.
:* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД.

:: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки

:: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа)

:: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа)

:: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа)

:: Тэг 1212 - Признак предмета расчета

:: Пример:

<source lang="json">
"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},
"tag1212": "1"
</source>

Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:
<source lang="json">
"ikpu":"123123123","packageCode":"123456"
</source>

* '''packages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' — Название места.
:* '''''code''''' — Внутренний код строки.
:* '''''strbarcode''''' — Штрихкод места.
:* '''''mass''''' — Масса места в килограммах.
:* '''''message''''' — Строка сообщения.
:* '''''length''''' — Длина товарного места (в сантиметрах).
:* '''''width''''' — Ширина товарного места (в сантиметрах).
:* '''''height''''' — Высота товарного места (в сантиметрах).
:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.

* '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]]. Атрибуты:
:* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum)
:* '''''return_price''''' — стоимость в случае возврата заказа
:* '''''VATrate''''' — Ставка НДС — целое число процентов.

* '''below''' — граница стоимости настроек
:* '''''below_sum''''' — граница стоимости выкупаемого заказа
:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы

* '''advprices''' — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>
:* '''''code''''' — код услуги.
:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true.

* '''extrafields''' — Контейнер для описания расширенных полей. Необязательный элемент. Может содержать несколько элементов extrafield
* '''extrafield''' — Контейнер для описания расширенного поля.
:* '''''name''''' — наименование переменной. Может содержать только латинские буквы, цифры и знак подчеркивания "_", но начинаться может только с буквы. Максимальная длина - 20 символов.
:* '''''value''''' — значение переменной. Максимальная длина - 250 символов.

* '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины.

* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.

* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и т. д.) — их нужно указать в том же контейнере items как товары, без артикула.

=== Примеры ответов ===
При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.
В атрибут orderno помещается номер заказа, в атрибут barcode — штрихкод заказа.

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />
<createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />
<createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" />
</neworder>
</source>

'''Пример ответа с ошибкой'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
<createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." />
<createorder orderno="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
</neworder>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Коды и описание ошибок ===
{|class=wikitable
!Код ошибки
!Английское описание
!Русское описание
|-
|0||Success||Успешно
|-
|1||Wrong XML||Некорректный файл XML.
|-
|2||Lat is empty||Укажите широту.
|-
|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма».
|-
|4||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес».
|-
|5||Recepient city/town not found.||Город назначения не найден.
|-
|6||Sender city/town not found.||Город отправления не найден.
|-
|7||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».
|-
|8||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».
|-
|9||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».
|-
|10||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество».
|-
|11||Specify a valid «Declared value» field value.||Укажите корректное значение поля «Объявленная ценность».
|-
|12||Supplier SKU ID not found.||Артикул не найден.
|-
|17||Order number already exists in the database.||Такой номер заказа уже есть в базе.
|-
|18||Order code already exists in the database.||Такой код заказа уже есть в базе.
|-
|19||The delivery date format is not valid. Specify a date in YYYY-MM-DD format.||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.
|-
|20||Specify a valid «Delivery mode» field value.||Укажите корректное значение поля «Режим доставки».
|-
|21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата».
|-
|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки».
|-
|23||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата».
|-
|30||Specify the «Order number» field value.||Укажите значение поля «Номер заказа».
|-
|31||Specify the «Barcode» field value.||Укажите значение поля «Штрихкод».
|-
|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель».
|-
|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».
|-
|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».
|-
|35||Specify the «Sender city/town» field value.||Укажите значение поля «Город отправителя».
|-
|36||Specify the «Sender address» field value.||Укажите значение поля «Адрес отправителя».
|-
|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».
|-
|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».
|-
|39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».
|-
|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель».
|-
|41||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».
|-
|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».
|-
|43||Specify the «Recipient city/town» field value.||Укажите значение поля «Город получателя».
|-
|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».
|-
|45||Specify the «Delivery date» field value.||Укажите значение поля «Дата доставки».
|-
|46||Specify the «Delivery time from» field value.||Укажите значение поля «Время доставки с».
|-
|47||Specify the «Delivery time to» field value.||Укажите значение поля «Время доставки до».
|-
|48||Specify the «Recipient postcode» field value.||Укажите значение поля «Индекс получателя».
|-
|49||Specify the «Weight» field value.||Укажите значение поля «Вес».
|-
|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».
|-
|51||Specify the «Quantity» field value.||Укажите значение поля «Количество».
|-
|52||Specify the «Amount» field value.||Укажите значение поля «Сумма».
|-
|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость».
|-
|54||Specify the «Description» field value.||Укажите значение поля «Описание».
|-
|55||Specify the «Instruction» field value.||Укажите значение поля «Поручение».
|-
|56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки».
|-
|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления».
|-
|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата».
|-
|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата»
|-
|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».
|-
|61||Specify barcode.||Укажите штрихкод.
|-
|62||Specify item weight.||Укажите массу единицы товара.
|-
|63||Specify item quantity.||Укажите количество товара.
|-
|64||Specify item price.||Укажите цену единицы товара.
|-
|65||Specify item name.||Укажите название товара.
|-
|66||Wrong XLS file||Некорректный файл XLS.
|-
|67||Order barcode already exists in the database.||Такой штрихкод заказа уже есть в базе.
|-
|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».
|-
|69||Specify department.||Укажите отдел.
|-
|70||Specify service partner code.||Укажите значение поля «Код подрядчика».
|-
|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра.
|-
|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.
|-
|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня.
|-
|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.
|-
|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».
|-
|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара».
|-
|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».
|-
|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».
|-
|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».
|-
|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».
|-
|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».
|-
|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».
|-
|83||Duplicate number in the registry.||Дублирование номера в реестре.
|-
|84||Duplicate barcode in the registry.||Дублирование штрихкода в реестре.
|-
|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».
|-
|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».
|-
|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.
|-
|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.
|-
|89||Specify a later delivery date.||Укажите более позднюю дату доставки.
|-
|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.
|-
|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.
|-
|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.
|-
|93||Add items.||Добавьте товары.
|-
|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.
|-
|96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов).
|-
|97||The pickup date format is not valid. Specify a date in YYYY-MM-DD format.||Укажите значение поля «Дата забора» в формате гггг-мм-дд.
|-
|98||Specify the cost code.||Укажите значение поля «Кост-код».
|-
|99||The item is not in stock.||Товар отсутствует на складе.
|-
|100||Set the quantity of the item marked with Chestny ZNAK to one.||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.
|-
|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1.
|-
|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.
|-
|103||Order not found.||Заказ не найден.
|-
|104||Cannot edit order in the current status.||Невозможно изменить заказ в текущем статусе.
|-
|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.
|-
|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.
|-
|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value].
|-
|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги».
|-
|110||Specify the correct TIN.||Укажите корректный ИНН.
|-
|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).
|-
|112||Specify the overall volume.||Укажите общий объем.
|-
|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.
|-
|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.
|-
|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.
|-
|116||Specify recipient PIN code.||Укажите пин-код получателя.
|-
|117||Order date cannot be earlier than {0}. Specify another date.||Дата заказа не может быть раньше {0}. Укажите другую дату.
|-
|118||Pickup date cannot be earlier than {0}. Specify another date.||Дата забора не может быть раньше {0}. Укажите другую дату.
|-
|119||Specify the correct item type.||Укажите корректный тип вложения.
|-
|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается.
|-
|121||Invalid item code format||Неверный формат кода товарной номенклатуры
|-
|122||Pickup time cannot be earlier than {0} hours.||Время забора не может быть раньше чем через {0} часа.
|-
|123||Pickup interval cannot be less than {0} minutes.||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.
|-
|124||Specify a valid "Payment type" field value.||Укажите корректное значение поля «Тип оплаты».
|-
|125||Recepient city/town by postcode not found.||Город получателя по его индексу не найден.
|-
|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».
|-
|127||Package limit exceeded||Превышен лимит количества мест
|-
|128||Quantity of item Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.
|-
|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.
|-
|130||Specify a valid respstore code.||Укажите код ответственного филиала.
|-
|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.
|-
|132||Specify a valid "Recipient city/town" field value.||Укажите город получателя
|-
|133||Specify a valid "weight" for the town.||Укажите корректный вес для города
|-
|134||Specify a valid "paytype" for the town.||Укажите тип оплаты для города
|-
|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения
|-
|136||Specify warehouse goods in the order.||Укажите вложения в заказе
|-
|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад
|-
|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места
|-
|139||Wrong type of XML query||Ошибка запроса
|-
|140||Duplicate item code in the order.||Дублирование кода вложения в заказе
|-
|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе
|-
|144||Incorrect extrafields.||Некорректные расширенные поля.
|-
|}

=== Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===
Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]]

== Запрос статуса заказов ==

=== Пример запроса статуса заказа ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<orderno>1234</orderno>
<orderno2>5678</orderno2>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<conditions>
<namecontains/>
<namestarts/>
</conditions>
<limit>500</limit>
</statusreq>
</source>

=== Описание полей запроса статуса ===
'''statusreq''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''client''' — Признак клиента или агента. Необязательный элемент.
:* CLIENT — Признак клиента, значение по умолчанию
:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.
* '''ordercode''' — Внутренний код заказа. Необязательный элемент.
* '''orderno2''' — Номер заказа из срочных. Необязательный элемент.
* '''uid''' — Уникальный идентификатор, если он был добавлен при создании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа
* '''datefrom''' — Дата заказа «с». Необязательный элемент.
* '''dateto''' — Дата заказа «по». Необязательный элемент.
* '''target''' — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.
* '''done''' — Может принимать значения:
:* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен''')
:* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян''')
:* ONLY_NEW — Только новые
:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.
:* ''Пусто'' — все корреспонденции

* '''changes''' — может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

* '''conditions''' — Задает условия фильтрации по «orderno». Все вложенные элементы одновременно накладывают условие «И». Минимум 5 символов!
:* '''namecontains''' — Поиск по номеру заказа(шифр), который содержит «orderno».
:* '''namestarts''' — Поиск по номеру заказа(шифр), который начинается с «orderno».

* '''limit''' — Необязательный параметр. Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После каждой итерации нужно вызывать commitlaststatus с контейнером списка обработанных кодов, [[#Лимитирование запросов|читать подробнее]]

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'''.
# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.
# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.
# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.
# Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов
</div>
<br>

=== Примеры ответов ===
'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<contacts>
<phone>+74951234567</phone>
</contacts>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67 - Иван (916)234.45.21 Петр,mvd@mail.ru</phone>
<contacts>
<phone>+74951234567</phone>
<phone>+79162344521</phone>
<email>mvd@mail.ru</email>
</contacts>
<inn>1112223335</inn>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<area>Район 1</area>
<pvz>
<code>126</code>
<clientcode>QWERTY</clientcode>
</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<coords lat="55.680327" lon="37.604456"></coords>
<deliveryPIN>1234</deliveryPIN>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<paytype code="1">CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</service>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<return_message>Доставлено в целости</return_message>
<return_date>2026-01-19</return_date>
<return_time>13:18:00</return_time>
<pickup>NO</pickup>
<print_check>YES</print_check>
<waittime>12</waittime>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords>
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<deliveryprice total="158.6" delivery="100.00" return="58.6">
<advprice code="1" price="150">База</advprice>
<advprice code="2" price="0">% от объявленной стоимости</advprice>
<advprice code="3" price="8.6">Топливный сбор</advprice>
<advprice code="4" price="0">Округление</advprice>
</deliveryprice>
<receiverpays>NO</receiverpays>
<acceptpartially>NO</acceptpartially>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Новый" eventtown="Москва город" country="RU">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44"
message="филиал в Санкт-Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44"
message="филиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU">COMPLETE</status>
</statushistory>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<department>Отдел</department>
<costcode>cc12345</costcode>
<outstrbarcode>EXT123456</outstrbarcode>
<respstore>14</respstore>
<partner>Офис на Ленина</partner>
<arrival>2016-05-02 23:21</arrival>
<receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt>
<items>
<item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" govType="1" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="" govType="1">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="" govType="1">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package>
</packages>
<extrafields>
<extrafield>
<name>courier_car</name>
<value>ВАЗ 2106, бежевый</value>
</extrafield>
</extrafields>
</order>
</statusreq>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<statusreq count="0">
</statusreq>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Описание полей ответа статусов ===
Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

* Атрибуты контейнера '''order''':
:* '''''awb''''' — Номер накладной в системе курьерской службы.
:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.
:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:: CASH - Наличными при получении (по-умолчанию)
:: CARD - Картой при получении
:: NO - Без оплаты.
:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
* Атрибуты контейнера '''paytype''':
** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.

* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO.
:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* '''''area''''' в контейнере '''receiver''' — район/метро получателя.
* '''''coords''''' в контейнере '''receiver''' — координаты получателя.
* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.
* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.
* '''currcoords''' — текущие координаты заказа. Атрибуты:
:* '''''lat''''' — широта
:* '''''lon''''' — долгота
:* '''''accuracy''''' — точность в метрах
:* '''''RequestDateTime''''' — дата/время последнего обновления координат.

* '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.
* '''waittime ''' — Время ожидания курьера.
* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты:
:* '''''total''''' — общая стоимость услуг
:* '''''delivery''''' — стоимость доставки «Туда»
:* '''''return''''' — стоимость доставки «Обратно» (если order->return=YES)
Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»):
:* '''''advprice''''' — наименование дополнительной услуги
:* '''''code''''' — код дополнительной услуги
:* '''''price''''' — стоимость дополнительной услуги

* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' — филиал, к которому относится текущий статус
:* '''''eventtime''''' — время события по часовому поясу места его наступления.
:* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>
:* '''''message''''' — наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' — русское наименование статуса

* '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.
* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).
* '''delivereddate''' — дата вручения.
* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым.
* '''arrival''' — плановая дата прибытия в формате гггг-мм-дд чч: мм: сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.
* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.
* '''partner''' — текущий филиал/подрядчик.
* '''return_message''' — информация о возврате
* '''return_date''' - дата возврата
* '''return_time''' - время возврата
* '''department''' — Подразделение, в котором оформляется заказ.

Контейнер '''status''' может принимать следующие значения:
: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.
: '''NEW''' — Успешно создан, передан в службу доставки.
: NEWPICKUP — Создан забор.
: PICKUP — Забран у отправителя.
: WMSASSEMBLED — Скомплектован на складе фулфилмента.
: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.
: '''ACCEPTED''' — Получен складом.
: CUSTOMSPROCESS — Производится таможенный контроль.
: CUSTOMSFINISHED — Таможенный контроль произведен.
: CONFIRM — Согласована доставка.
: UNCONFIRM — Не удалось согласовать доставку.
: DEPARTURING — Планируется отправка со склада на другой склад.
: DEPARTURE — Отправлено со склада на другой склад.
: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.
: PICKUPREADY — Готов к выдаче в ПВЗ.
: '''DELIVERY''' — Выдан курьеру на доставку.
: COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).
: COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).
: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).
: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).
: DATECHANGE — Перенос даты доставки.

: '''COMPLETE''' — Доставлен.
: '''PARTIALLY''' — Доставлен частично.
: '''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED

: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.

: PARTLYRETURNING — Планируется возврат остатков.
: PARTLYRETURNED — Остаток возвращен.
: TRANSACCEPTED — Прибыл на склад перевозчика.
: PICKUPTRANS — Забран у перевозчика.
: WITHDRAWN_FROM_PICKUP_POINT - Изъят.
: CUSTOMSDELAY - Задержка отправления таможенным органом.
: DEPARTUREDELAY - Задержка отправления перевозчиком.
: STORETAKE - Принят в работу на складе.

'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Контейнер '''packages''' не возвращает более 1000 элементов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br>

=== Передача только изменившихся статусов ===
В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами.

Для получения только изменившихся статусов отправьте запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<streamid>1234</streamid>
</statusreq>
</source>

Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<streamid>1234</streamid>
</commitlaststatus>
</source>

'''Описание полей запроса'''

* '''auth''' — авторизация. Обязательный элемент.
* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.
* '''client''' — признак клиента или агента. Необязательный элемент.
:* CLIENT — признак клиента, значение по умолчанию
:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

В случае успеха вы получите ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus error="0">OK</commitlaststatus>
</source>

Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
# При этом способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее, изменение статуса по нему не попадет в результат выполнения запроса.
# Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки).
# Система не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br>

=== Лимитирование запросов ===
Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После успешной обработки получнных заказов, '''обязательно''' нужно вызвать commitlaststatus с кодами обработанных заказов.

'''Пример'''

Для получения ограниченного числа изменившихся заказов отправьте запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<limit>5</limit>
</statusreq>
</source>

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<acs>
<ac>11111</ac>
<ac>22222</ac>
<ac>33333</ac>
<ac>44444</ac>
<ac>55555</ac>
</acs>
</commitlaststatus>
</source>

* '''acs''' — контейнер. Обязательный элемент.
* '''ac''' — атрибут''' ordercode''' контейнера '''order''' полученного на этапе запроса '''statusreq'''.

Помимо приведенных в примере параметров, вы также можете передавать и остальные, описанные ранее, например '''streamid'''.

== Трекинг заказа по номеру ==
Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST!

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<order orderno="111111" ordercode="12345">
<barcode>111111</barcode>
<AWB>111111</AWB>
<sender>
<town code="1" country="RU">Москва город</town>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<zipcode>125480</zipcode>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<paytype>CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</return_service>
<return_date></return_date>
<return_time></return_time>
<return_message></return_message>
<waittime>12</waittime>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<deliveryprice total="158.6" delivery="100.00" return="58.6" />
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<outstrbarcode>EXT123456</outstrbarcode>
<items>
<item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
<acquirers>
<acquirer code="2" name="Ibox"/>
<acquirer code="5" name="Payme"/>
<acquirer code="6" name="Click"/>
</acquirers>
</order>
</tracking>
</source>

где,
* '''acquirers''' / '''acquirer''' - эквайринг, доступный для получения ссылки на оплату заказа
** '''acquirers''' / '''acquirer''' / ''code'' - внутренний код эквайринга
** '''acquirers''' / '''acquirer''' / ''name'' - наименование эквайринга

'''Получение информации в формате 17 TRACK'''

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking17>
<extra>8</extra>
<orderno>1234</orderno>
</tracking17>
</source>

'''Пример ответа:'''
<pre>{
"number":"ExtNumber",
"oriNumber":"1234",
"oriCountry":"RU",
"destCountry":"RU",
"status":"Complete",
"events":[
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Complete"
},
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Courierdelivered"
},
{
"time":"2016-06-02 09:17:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Delivery"
},
{
"time":"2016-06-02 07:41:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Accepted"
},
{
"time":"2016-06-01 19:53:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"Departure"
},
{
"time":"2016-06-01 17:38:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"Departuring"
},
{
"time":"2016-05-30 10:20:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"New"
}
]
}</pre>

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<br>
Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]].

=== Получение ссылки для оплаты заказа ===

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
Этим методом вы можете только получить ссылку на оплату. Фискализация этого платежа идет отдельным процессом. По его возможности уточняйте в службе поддержки.
</div>

Заказ доступен для оплаты, если:
* тип оплаты заказа не наличными, а например картой или по договору, альтернативой может стать установка параметра "Спрашивать тип оплаты" в карточке клиента.
* заказ имеет наложенный платеж
* не оплачен
* активен (не доставлен, не возвращен в т.ч. курьером)

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<acqlink>
<extra>8</extra>
<acq>
<code>2</code>
</acq>
<order>
<code>12345</code>
</order>
</acqlink>
</source>

где
*'''extra''' - код экстраклиента в системе Measoft.
*acq.'''code''' - внутренний код платформы эквайринга в системе Measoft. (известен в МП из [https://wiki.courierexe.ru/index.php/API#.D0.A2.D1.80.D0.B5.D0.BA.D0.B8.D0.BD.D0.B3_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0_.D0.BF.D0.BE_.D0.BD.D0.BE.D0.BC.D0.B5.D1.80.D1.83 Трекинга])
*order.'''ordercode''' - внутренний код заказа, типа ''int'', уникальный в пределах экстраклиента

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<acqlink error="0" amount="2000" extid="161083231">https://qr.nspk.ru/AD10001A7GLVGA9YDO2I0789SIOPV3?type=02&bank=1000011&sum=2000&cur=RUB&crc=7E9C</acqlink>
</source>

где
*'''acqlink''' - ссылка на оплату заказа
*acqlink.'''amount''' - тип integer сумма платежа в копейках в общем случае, в других случаях в соответствии с типом валюты
*acqlink.'''extid''' - идентификатор счета на стороне платежной системы
*acqlink.'''error'' - код ошибки, если отличается от 0, означает невозможность получения ссылки на оплату, в этом случае ссылки на оплату не будет и ответ будет выглядеть так:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<acqlink error="2" message="Ошибка авторизации: Invalid token" amount="2000" extid=""/>
</source>

где
*acqlink.'''message''' - текст ошибки возвращаемой эквайрингом

Возможные типы ошибок получения ссылки:
* '''1''' - не настроен эквайринг, либо не найден заказ
* '''2''' - ошибка на стороне эквайринга
* '''3''' - запрещающий статус курьера (заказ доставлен, частично доставлен)
* '''4''' - оплата заказа не разрешена

== Изменение заказа ==
Запрос предназначен для изменения заказов.

Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый»

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.
</div>

При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Автоматически устанавливать заплан. курьера по району''':
* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется;
* '''Район''' — если изменен адрес доставки, курьер сбрасывается;
* '''Район или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается.

=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:

* значение '''orderno''' данным методом изменить нельзя.
* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.
* вместо корневого тэга '''neworder''' указывается '''editorder''';
* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.
* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

Необходимо иметь в виду, что:

# Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)
# Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-офисом (для записей указываются метки Удалено)

=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==
Запрос предназначен для отмены заказов.

Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Изменение заказов'''

При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

'''Пример запроса отмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<auth extra="8" login="login" pass="pass" />
<order orderno="" ordercode="123456" />
<order orderno="123aaa" ordercode="" />
</cancelorder>
</source>

'''Описание полей:'''

'''cancelorder''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты:
:* '''''orderno''''' — Шифр заказа.
:* '''''ordercode''''' — Внутренний код заказа.
Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
<order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" />
</cancelorder>
</source>

== Добавление вложений к накладной ==

Метод позволяет прикрепить файлы к корреспонденции.
Размер загружаемого файла не должен превышать 1 Мб.

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<addattachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
<attachments>
<item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</addattachments>
</source>

'''Описание полей:'''

'''addattachments''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''orderno''' — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.
* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.
** '''item''' — Бинарные данные (файл), закодированные в base64. Обязательный элемент.
*** '''name''' — Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachments>
<attachments>
<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
</attachments>
</addattachments>
</source>

== Получение вложений к накладной ==
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
</attachments>
</source>

'''Описание полей:'''

'''attachments''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''orderno''' — Номер/код заказа. Обязательный элемент.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachments>
<item name="doc1.docx" timestamp="2025-01-01 12:00:00" size="35654">JVBERixLjMN
UwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS
5/+8PsL/sXb0+aoper/9kL/4Ov/YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG
eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t
sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/dDjHMbMW/EW4fiB1pvWmV2ONWIl1Xdub
Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/OtHwXcW0FWui1z7
6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd
Ibsb7r+j9bff/unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/5r
vnMt9uesu21Me1bjeNJGlVfAaCtw+/jfenJ/fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O
ip7xJmmNESMxrgu/dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp
wwbFph29g4fTaxnvn/3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg
km7/HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4
MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT
q/xd+3fd3/USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc
Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w
TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1
7EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/ivm7qleHK5o790w8ejXchI
vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</item>
</attachments>
</source>

В тегах item возвращаются бинарные данные (файлы), закодированные в base64.

== Изменение статуса агентом ==
Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)».

Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.

При необходимости к заказу можно прикрепить изображения.

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456">
<message>Получил Иванов</message>
<outstrbarcode>7654312</outstrbarcode>
</order>
<order ordercode="234567">
<status>PICKUPREADY</status>
<eventtime>2016-05-30 10:20:00</eventtime>
<message>Клиент отказался от покупки</message>
<paytype>CASH</paytype>
<storeprice>123</storeprice>
<items>
<item code="34533" quantity="1" reason="0" governmentCode="11223311" />
<item code="34456" quantity="0" reason="0" />
<item code="34421" quantity="2" reason="0" />
</items>
<attachments>
<attachment filename="filename1.jpg"> /9j/4AAQSkZJRgA
BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
PT09PT0//wAARCAYACAADAS IA</attachment>
<attachment filename="filename2.jpg"> /9j/4AAQSkZJRgA
BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
PT09PT0//wAARCAYACAADAS IA</attachment>
</attachments>
</order>
</setorderinfo>
</source>

'''Описание полей запроса статуса:'''

'''setorderinfo''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа.
* '''status''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.
* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.
* '''message''' — Текст сообщения ''Инфо о доставке''.
* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.
* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.
* '''storeprice''' — Агентское вознаграждение.
* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты:
:* '''''code''''' — Код вложения.
:* '''''quantity''''' — Количество доставленных единиц вложения.
:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.
:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.
* '''attachments''' — Контейнер прикрепляемых изображений. Может содержать несколько контейнеров '''attachment'''
:* '''attachment''' — Контейнер изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Атрибут:
::* '''''filename''''' — Имя файла.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo>
<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />
</setorderinfo>
</source>

== Получение документов для печати ==
'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybill>
<auth extra="8" login="login" pass="pass" />
<client>CLIENT</client>
<orders>
<order orderno="1234567" ordercode="33331" />
<order orderno="1234568" ordercode="33332" />
</orders>
<form>1</form>
<start>5</start>
<integration>21</integration>
</waybill>
</source>

'''Описание полей:'''

'''waybill''' — Корневой контейнер. Обязательный элемент
* '''auth''' — Авторизация. Обязательный элемент
* '''client''' — Признак клиента или агента. Необязательный элемент.
:* CLIENT — Признак клиента, значение по умолчанию
:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами:
:* '''''orderno''''' — шифр заказа
:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''
* '''form''' — Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 — Подробная накладная (по-умолчанию)
:* 2 — Наклейки Zebra
:* 3 — Наклейки на страницу формата А4
:* 4 — Акты приема-передачи
* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.
* '''integration''' - Получение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа. Принимает значение:
:* 21 - подрядчик GTD

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<integration code="21">
<order code="33331">
<content>JVBERi0xLjYNJeLjz9MNC...</content>
</order>
<order code="33332">
<content>JVBERi0xLjYNJeLjz9MNC...</content>
</order>
</integration>
<content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw
IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG
mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM
4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00
79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q
mqqvp9p2E7T0/wiFemv8uG6 OM</content>
</waybill>
</source>

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.
При записи в файл необходимо использовать двоичный формат записи!

Блок integration содержит отдельные наклейки для заказов, предоставленные подрядчиком, так же закодированные в base64.

'''Обратите внимание''' Лимит количества при единовременном получении печатных форм - 1000 штук. Если нужно получить больше - делайте это несколькими запросами.

'''Обратите внимание''' Печатные формы для заборов не формируются.

'''Пример ответа с ошибкой:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<error>Текст ошибки</error>
</waybill>
</source>

== Справочник городов ==
'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<auth extra="8" />
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namecontainsparts>молоково моск</namecontainsparts>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

* '''auth''' — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.

* '''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.
:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.
:* '''kladrcode''' — Поиск по 13-ти значному коду КЛАДР.
:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).
:* '''code''' — Поиск по коду в системе.

* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''city''' — Поиск по всем населенным пунктам региона.
:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.
:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.
:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.
:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.
:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России.

* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.
:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.
:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>
<kladrcode>2300000700000</kladrcode>
<shortname /> (not yet supported)
<typename /> (not yet supported)
<coords lat="43.5855" lon="39.7231" />
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>
<kladrcode>3201900011100</kladrcode>
<shortname />
<typename />
<coords lat="52.6407" lon="33.1724" />
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>
<kladrcode>6001900015400</kladrcode>
<shortname />
<typename />
<coords lat="56.6003" lon="29.3542" />
</town>
</townlist>
</source>

В ответе города сортируются по популярности, важности (районные центры и т. д.), и только затем — по алфавиту.

== Справочник регионов ==
'''Пример запроса справочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist>
<codesearch>
<code>77</code>
</codesearch>
<conditions>
<namecontains>край</namecontains>
<namestarts>Моск</namestarts>
<fullname>Московская область</fullname>
<country>RU</country>
</conditions>
</regionlist>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2">
<city>
<code>80</code>
<country>
<code>1</code>
<name>Россия</name>
<id>643</id>
<ShortName1>RU</ShortName1>
<ShortName2>RUS</ShortName2>
</country>
<name>Агинский Бурятский автономный округ</name>
</city>
<city>
<code>1</code>
<country>
<code>1</code>
<name>Россия</name>
<id>643</id>
<ShortName1>RU</ShortName1>
<ShortName2>RUS</ShortName2>
</country>
<name>Адыгея республика</name>
</city>
</regionlist>
</source>

== Справочник улиц ==
'''Пример запроса справочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist>
<conditions>
<town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!
<namecontains>Хохло</namecontains>
<namestarts>Академика Х</namestarts>
<name>Академика Хохлова</name>
<fullname>Академика Хохлова ул.</fullname>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</streetlist>
</source>

* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''town''' — Обязательное поле. Название или код населенного пункта.
:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст.
:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.
:* '''name''' — Поиск улиц, название которых соответствует указанному тексту.
:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту.

* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.
:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.
:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist count="1" page="1" totalcount="3" totalpages="1">
<street>
<code>124</code>
<name>Академика Хохлова ул.</name>
<shortname>Академика Хохлова</shortname>
<typename>ул.</typename>
</street>
</streetlist>
</source>

В ответе улицы сортируются по алфавиту.

== Справочник номенклатуры ==
'''Пример запроса справочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlist>
<auth extra="8" login="login" pass="pass"></auth>
<codesearch>
<code>123456</code>
<article>FD343</article>
<barcode>2345625213125</barcode>
</codesearch>
<conditions>
<namecontains>телевизор</namecontains>
<namestarts>sony</namestarts>
<name>Sony KDL-55W905 ЖК-телевизор</name>
<quantity>EXISTING_ONLY</quantity>
<store>2</store>
</conditions>
<except>
<code>123478</code>
</except>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</itemlist>
</source>

Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.
* '''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.
:* '''code''' — Поиск по внутреннему коду системы.
:* '''article''' — Поиск по артикулу.
:* '''barcode''' — Поиск по штрихкоду.

* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''namecontains''' — Поиск товаров, название которых содержит указанный текст.
:* '''namestarts''' — Поиск товаров, название которых начинается с указанного текста.
:* '''name''' — Поиск товаров, название которых соответствует указанному тексту.
:* '''quantity''' — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. ''Это поле может быть недоступным в некоторых установках.''
:* '''store''' — Поиск товаров по определенному складу.

* '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.
:* '''code''' — Код заказа.

* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.
:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1">
<item>
<code>123456</code>
<article>FD343</article>
<barcode>2345625213125</barcode>
<name>Sony KDL-55W905 ЖК-телевизор</name>
<retprice>65000</retprice>
<purchprice>50000</purchprice>
<weight>5.1</weight>
<length>50</length>
<width>30</width>
<height>40</height>
<VATrate>20</VATrate>
<CountInPallet>30</CountInPallet>
<CountInBox>2</CountInBox>
<HasSerials>1</HasSerials>
<CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported)
<Message>Хороший телевизор</Message>
<Message2>Снова хороший телевизор</Message2>
<quantity>12</quantity>
<reserved>3</reserved>
<item>
...
</itemlist>
</source>

'''Описание полей:'''
* '''code''' — Внутренний идентификатор, присвоенный системой.
* '''article''' — Артикул, назначенный клиентом (поставщиком).
* '''barcode''' — Штрихкод производителя.
* '''name''' — Наименование.
* '''retprice''' — Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.
* '''purchprice''' — Закупочная цена.
* '''weight''' — Масса в килограммах.
* '''length''' — Длина в сантиметрах.
* '''width''' — Ширина в сантиметрах.
* '''height''' — Высота в сантиметрах.
* '''VATrate''' — Ставка НДС, целое число процентов.
* '''CountInPallet''' — Количество штук в паллете.
* '''CountInBox''' — Количество штук в упаковке.
* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.
* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.
* '''Message''' — Комментарий.
* '''Message2''' — Дополнительный комментарий.
* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''
* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.''

== Движение номенклатуры ==
'''Пример запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements>
<auth extra="8" login="login" pass="pass"></auth>
<code>4259</code>
<datefrom>2020-10-01</datefrom>
<dateto>2020-10-02</dateto>
</itemmovements>
</source>

* '''code''' — внутренний код товара в справочнике номенклатуры.
* '''datefrom''' — дата начала периода.
* '''dateto''' — дата окончания периода.
Может быть указан или код, или период, или код и период одновременно.

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements count="16">
<itemmovement>
<code>151500</code>
<date>2017-05-26</date>
<retprice>0</retprice>
<quantity>1</quantity>
<delivered>0</delivered>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
</item>
<status>
<code>5</code>
<name>Возврат от покупателя</name>
</status>
<store>
<code>1</code>
<name>офис в Москве</name>
</store>
<order>
<ordercode>3374830</ordercode>
<number>123660-0</number>
<date>2017-05-24</date>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<company>ТОВАР</company>
<address>Кравченко ул., 1</address>
<delivereddate>2017-05-29</delivereddate>
<deliveredtime>12:00:00</deliveredtime>
<deliveredto />
</order>
<document>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
</document>
<serials>
<serial>123456789</serial>
</serials>
</itemmovements>
</itemlist>
</source>

''' Описание полей ответа '''
* '''code''' — внутренний код операции движения
* '''date''' — дата операции
* '''retprice''' — цена товара
* '''quantity''' — количество товара операции
* '''delivered''' — количество доставленного товара

* '''item''' — контейнер товара
:* '''code''' — внутренний код товара
:* '''name''' — наименование товара

* '''status''' — контейнер статуса операции
:* '''code''' — код статуса
:* '''name''' — наименование

* '''store''' — контейнер филиала, к которому относится операция
:* '''code''' — код филиала
:* '''name''' — наименование филиала

* '''order''' — контейнер корреспонденции
:* '''ordercode''' — внутренний код заказа
:* '''number''' — номер заказа
:* '''date''' — дата заказа
:* '''orderno''' — шифр
:* '''barcode''' — штрихкод
:* '''company''' — компания
:* '''address''' — адрес
:* '''delivereddate''' — дата вручения
:* '''deliveredtime''' — время вручения
:* '''deliveredto''' — данные о вручении, либо причина недоставки

* '''document''' — контейнер документа операции
:* '''code''' — внутренний код документа
:* '''number''' — номер документа
:* '''extnumber''' — внешний номер документа
:* '''date''' — дата документа
:* '''message''' — комментарий

* '''serials''' — контейнер серийных номеров
:* '''serial''' — серийный номер единицы номенклатуры, участвующей в движении

== Серийные номера ==
'''Пример запроса движения номенклатуры с серийным номером:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<serialmovements>
<auth extra="8" login="login" pass="pass"></auth>
<serial>123456789</serial>
</serialmovements>
</source>

* '''serial''' — серийный номер единицы номенклатуры.

'''Пример ответа движения номенклатуры с серийным номером:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<serialmovements count="16">
<serialmovement>
<code>151500</code>
<serial>123456789</serial>
<date>2017-05-26</date>
<delivered>0</delivered>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
</item>
<status>
<code>5</code>
<name>Возврат от покупателя</name>
</status>
<order>
<ordercode>3374830</ordercode>
<number>123660-0</number>
<date>2017-05-24</date>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<company>ТОВАР</company>
<address>Кравченко ул., 1</address>
<delivereddate>2017-05-29</delivereddate>
<deliveredtime>12:00:00</deliveredtime>
<deliveredto />
</order>
<document>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
</document>
</serialmovement>
</serialmovements>
</source>

''' Описание полей ответа '''

Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]]

== Серийные номера по заказу ==
'''Пример запроса движения серийных номеров заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<orderserials>
<auth extra="8" login="login" pass="pass"></auth>
<ordercode>123456789</ordercode>
<orderno>123456789</orderno>
<barcode>123456789</barcode>
</orderserials>
</source>

* '''ordercode''' — внутренний код заказа.
* '''orderno''' — шифр заказа.
* '''barcode''' — штрих-код заказа.
Указывать необходимо один из идентификаторов заказа.

'''Пример ответа движения серийных номеров заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<orderserials>
<order>
<code>3374830</code>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<delivereddate>2024-07-20</delivereddate>
<deliveredtime>10:04:00</deliveredtime>
<assemblydate>2024-07-19 07:05:34</assemblydate>
</order>
<items>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
<article>123000</article>
<state>Delivered</state>
<serials>
<serial>123456789</serial>
</serials>
</item>
</items>
</orderserials>
</source>

''' Описание полей ответа '''

* '''order''' — блок заказа:
:* '''code''' — код
:* '''orderno''' — шифр
:* '''barcode''' — штрих-код
:* '''delivereddate''' — дата доставки факт
:* '''deliveredtime''' — время доставки факт
:* '''assemblydate''' — дата сборки

* '''item''' — блок товара:
:* '''code''' — код
:* '''name''' — наименование
:* '''article''' — артикул
:* '''state''' — статус Доставлено (Delivered) или Возвращено (Returned)
:* '''serials''' — блок серийных номеров по заказу

== Получение справочника тарифов по городам ==

'''Пример запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs>
<auth extra="8" login="login" pass="pass" />
<townfrom>Москва</townfrom>
<service>1</service>
<mainonly>1</mainonly>
</tariffs>
</source>

* '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.
* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».
* '''service''' — режим доставки. Обязательный элемент.
* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.

Важно понимать, что в ответе отдаются только тарифы, указанные в разделе "Тарифы по зонам" раздела "Межгород" в офисной системе курьерской службы, т.е. считающихся междугородними.
Доставка до городов, рассчитываемая по внутригородским тарифам, в ответе НЕ ОТДАЕТСЯ!

'''Пример ответа справочника тарифов по городам'''
<source lang="json">
{
"townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"service": 1,
"tariffs": [
{
"towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"towntocode": 1,
"towntoname": "Москва город",
"townregion": "Город Москва",
"distance": 0,
"pricedistance": 0,
"pricesnew": {
"before": [
{
"price": 100,
"every": 0,
"mass": 1
},
{
"price": 150,
"every": 0,
"mass": 5
}
],
"after": [
{
"price": 0,
"every": 1,
"mass": 38.01
},
{
"price": 15,
"every": 1,
"mass": 51.01
}
]
},
"deliveryPeriodMin": 1,
"deliveryPeriodMax": 2
}
]
}
</source>

''' Описание полей ответа '''
* '''townfrom''' — код ФИАС города-отправителя.
* '''service''' — режим доставки.
* '''tariffs''' — cписок тарифов по городу.
:* '''townregion''' — регион города-получателя.
:* '''towntofias''' — код ФИАС города-получателя.
:* '''towntocode''' — внутренний код города-получателя.
:* '''towntoname''' — наименование города-получателя.
:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.
:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.
:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.
::* '''before/after''' — контейнеры ДО/ОТ.
:::* '''price''' — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance
:::* '''every''' — за каждые.
:::* '''mass''' — масса.
:* '''prices''' — устаревший элемент, не используется.
:* '''deliveryPeriodMin''' — минимальный срок доставки.
:* '''deliveryPeriodMax''' — максимальный срок доставки.

== Номенклатура приходной накладной ==
'''Пример запроса номенклатуры приходной накладной:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
<auth extra="8" login="login" pass="pass"></auth>
<code>21991</code>
</itemdoc>
</source>

* '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос).

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
<items>
<item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item>
</items>
</itemdoc>
</source>

''' Описание полей ответа '''
* '''code''' — внутренний код приходной накладной
* '''number''' — номер документа
* '''date''' — дата документа
* '''message''' — комментарий

* '''item''' — контейнер товара
:* '''code''' — внутренний код товара
:* '''barcode''' — штрихкод товара
:* '''article''' — артикул товара
:* '''quantity''' — количество поступившего товара

== Справочник филиалов ==
'''Пример запроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist>
<auth extra="8"></auth>
<json>YES</json>
<client_code>7890</client_code>
</storelist>
</source>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба
* '''json''' — Признак вывода ответа в виде JSON YES/NO
* '''client_code''' — Код клиента курьерской службы

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist count="2">
<store>
<code>123</code>
<name>ABC</name>
</store>
<store>
<code>456</code>
<name>Филиал 2</name>
</store>
</storelist>
</source>

* '''code''' — Код филиала.
* '''name''' — Наименование филиала.

== Справочник пунктов самовывоза ==
Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь]

Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим.

Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''.

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<code>1234</code>
<client_code>7890</client_code>
<city>Свердловская область</city>
<town regioncode="66" country="RU">Нижний Тагил</town>
<address>Щёлковское шоссе</address>
<house>77</house>
<advanced_search>Строка поиска</advanced_search>
<parentcode>6</parentcode>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<maxweight>30</maxweight>
<acceptindividuals>YES</acceptindividuals>
<respstores>YES</respstores>
<lt>57.924737</lt>
<lg>59.940019</lg>
<rt>57.905682</rt>
<rg>59.984669</rg>
<json>YES</json>
<with_coords>YES</with_coords>
<limit>
<limitfrom>30</limitfrom>
<limitcount>2</limitcount>
<countall>YES</countall>
</limit>
</pvzlist>
</source>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.
* '''code''' — Внутренний код, целое число.
* '''client_code''' — Код клиента курьерской службы.
* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].
* '''town''' — Город получателя.
Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.
Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу.

* '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу
* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу
* '''advanced_search''' — Фильтр по коду агента, наименованию, телефону или комментарию
* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]
* '''acceptcash''' — Фильтр по приему наличных YES/NO
* '''acceptcard''' — Фильтр по приему банковских карт YES/NO
* '''acceptfitting''' — Фильтр по наличию примерки YES/NO
* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ
* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO
* '''respstores''' - Признак вывода ответственных филиалов при значении YES
* '''lt''' — Широта левого верхнего угла
* '''lg''' — Долгота левого верхнего угла
* '''rt''' — Широта правого нижнего угла
* '''rg''' — Долгота правого нижнего угла
* '''json''' — Признак вывода ответа в виде JSON YES/NO
* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO
* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.
:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.
:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2" totalcount="40465">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Новый пункт доставки</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>
<maxweight>10</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93457</latitude>
<longitude>59.95131</longitude>
<uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Возможность примерки отсутствует</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Напротив ТЦ Пирамида</traveldescription>
<maxweight>20</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>NO</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93468</latitude>
<longitude>60.55476</longitude>
<uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid>
</pvz>
</pvzlist>
</source>

* '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.
* '''name''' — Наименование ПВЗ.
* '''parentcode''' — Код родительского элемента.
* '''parentname''' — Наименование родительского элемента.
* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.
* '''address''' — Адрес ПВЗ.
* '''phone''' — Телефоны ПВЗ.
* '''comment''' — Дополнительная информация.
* '''worktime''' — Режим работы ПВЗ.
* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.
* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.
* '''acceptcash''' — Признак приема наличных
* '''acceptcard''' — Признак приема банковских карт
* '''acceptfitting''' — Наличие примерки
* '''latitude''' — Широта
* '''longitude''' — Долгота
* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft. Создается автоматически при получении данных о ПВЗ от агентов.
* '''count''' — Количество записей в ответе
* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса

== Получение фискальных данных заказа ==
'''Пример запроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="123456" />
<order orderno="890111C" />
</orders>
</receiptdata>

</source>

'''Пример ответа получения фискальных данных:'''
<source lang="xml">

<?xml version="1.0" encoding="UTF-8"?>
<receipts count="1">
<receipt>
<orderno>123456</orderno>
<fdDatetime>2020-06-07 12:14:00</fdDatetime>
<fdValue>123</fdValue>
<fdNum>456</fdNum>
<fnSn>789</fnSn>
<kktNum>100</kktNum>
<inn>222</inn>
<ofdUrl>gate.ofd.ru</ofdUrl>
<fullUrl>https://check.ofd.ru/123</fullUrl>
<price>12345</price>
<payType>2</payType>
<lines count="1">
<line>
<item>1111764</item>
<name>Сапоги</name>
<extcode>27113415</extcode>
<qty>1</qty>
<price>1000</price>
<vatRate>20</vatRate>
<governmentCode>Z16513LK2</governmentCode>
<itemType>1</itemType>
</line>
</lines>
</receipt>
</receipts>
</source>

Параметры ответа:
* '''orderno''' — Номер заказа
* '''fdDatetime''' — Дата и время пробития фискального чека
* '''fdValue''' — ФПД (фискальный признак документа)
* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)
* '''fnSn''' — ФН (номер фискального накопителя)
* '''kktNum''' — РН (регистрационный номер кассы)
* '''inn''' — ИНН
* '''ofdUrl''' — URL адрес (доменное имя) ОФД
* '''price''' — Сумма чека
* '''paytype''' — Тип оплаты чека. Принимает значения:
:* CASH — Наличными (по-умолчанию)
:* CARD — Безналичным способом
* '''fullUrl''' — URL чека для просмотра онлайн
* '''lines''' — Позиции чека
:* '''item''' — код товара
:* '''name''' — наименование товара
:* '''extcode''' — код товара во внешних системах
:* '''qty''' — количество товара
:* '''price''' — цена товара
:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162
:* '''vatRate''' — НДС товара
:* '''itemType''' — тип товара (товар, доставка и т. д.)

== Справочник Виды срочности ==
'''Пример запроса видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>
</source>

'''Пример ответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2">
<service>
<code>1</code>
<name>Эконом</name>
</service>
<service>
<code>2</code>
<name>Срочно</name>
</service>
</services>
</source>

== Справочник дополнительных услуг ==
'''Пример запроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<advprices>
<auth extra="8" login="login" pass="pass" />
</advprices>
</source>

'''advprices''' — Корневой контейнер. Обязательный элемент.

'''Пример ответа справочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advprices>
<advprice>
<code>1</code>
<name>Этажей в доме</name>
<type>int</type>
</advprice>
<advprice>
<code>2</code>
<name>Коэффициент надбавки</name>
<type>float</type>
</advprice>
<advprice>
<code>3</code>
<name>Расписаться на упаковке</name>
<type>bool</type>
</advprice>
</advprices>
</source>

Параметры:
* '''code''' — внутренний код услуги
* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».
* '''hine''' — подсказка по доп услуге для пользователя
* '''type''' — тип услуги. Может иметь значения:
:* '''bool''' — для услуг вида «чекбокс», «Да»
:* '''float''' — для числа с плавающей точкой
:* '''int''' — для целого числа

== Расчет стоимости доставки ==
'''Пример запроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<order>
<pricetype>CUSTOMER</pricetype>
<sender>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<coords lat="55.680327" lon="37.604456"></coords>
</sender>
<receiver>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<weight>5.1</weight>
<service>2</service>
<paytype>CASH</paytype>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<inshprice>387.5</inshprice>
<packages>
<package mass="1" quantity="5"></package>
<package mass="2.5" length="10" width="20" height="30"></package>
</packages>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</calculator>
</source>

Параметры:
Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]].

Дополнительные поля:
* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.
* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.
* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.

Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм.

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>
Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>
В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).

'''Пример ответа стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculator>
<calc>
<townfrom code="1">Москва город</townfrom>
<townto code="56603">Иркутск город</townto>
<mass>3.7</mass>
<service name="Экспресс">1</service>
<zone>2</zone>
<price>1113</price>
<mindeliverydays>1</mindeliverydays>
<maxdeliverydays>3</maxdeliverydays>
<mindeliverydate>2020-05-13</mindeliverydate>
<intervals>
<workdays>
<interval>10:00-16:00</interval>
<interval>16:00-22:00</interval>
</workdays>
<holidays>
<interval>12:00-16:00</interval>
</holidays>
</intervals>
<deliveryprice>
<advprice code="1" price="1000">База</advprice>
<advprice code="4" price="100">Процент от суммы руб</advprice>
<advprice code="5" price="63">Процент от объявленной стоимости</advprice>
<advprice code="6" price="-50">Скидка при доставке</advprice>
</deliveryprice>
</calc>
</calculator>
</source>

Параметры:
* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.
* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.
* '''mass''' — Масса в килограммах
* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).
* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.
* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.
* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.
* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.
* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.
* '''deliveryprice''' — Данные по составляющим ценам доставки

'''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price.

=== Коды и описание ошибок ===
{|class=wikitable
!Код ошибки
!Английское описание
!Русское описание
!Примечание
|-
|15||tarif not found||Тариф не найден||Ошибка получения тарифов: для клиента не указан тариф
|-
|19||field [town to] cannot be empty||Поле [город получателя] не может быть пустым||Необходимо указать город получателя или ПВЗ
|-
|20||field [weight] is incorrect||Некорректное значение [масса]||Значение массы некорректное, например, не является числом. Его необходимо исправить
|-
|21||town from not found||Город отправителя не найден||Системе не удалось найти указанный населенный пункт отправителя
|-
|22||town to not found||Город получателя не найден||Системе не удалось найти указанный населенный пункт отправителя
|-
|23||field [weight] cannot be empty||Поле [масса] не может быть пустым||Необходимо указать значение массы отправления, поле [weight]
|-
|36||subtown not found||Город в регионе не найден||Не настроено направление доставки до города в регионе: не добавлен регион или указанный город отсутствует в списке региона
|-
|37||zoneprice not found||Тариф зоны не найден||Отсутствуют зоны тарификации или для них не указаны стоимости
|-
|38||tarif not found - 1||Тариф не найден 1||Результаты расчета отсутствуют: общая ошибка в случае, если других ошибок нет, но результат пустой
|-
|39||tarif not found - 2||Тариф не найден 2||Ошибка получения тарифов: для клиента не настроен тариф или тарификация от количества заказов
|-
|82||field [weight] exceeded limit PVZ||Значение [weight] превышает ограничение ПВЗ||Указанное значение массы больше, чем максимально допустимое для указанного ПВЗ
|-
|83||attribute [paytype] not allowed PVZ||Значение [paytype] не допустимо для ПВЗ||В ПВЗ не допустим указанный тип оплаты
|-
|}

== Получение информации о клиенте ==
'''Пример запроса получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<auth extra="8" login="login" pass="pass" />
</client>
</source>

'''client''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.

'''Пример ответа на запрос получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<code>1082</code>
</client>
</source>

* '''code''' — Код клиента

== Список актов передачи денег ==
'''Пример запроса списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalist>
<auth extra="8" login="login" pass="pass" />
<datefrom>2016-02-10</datefrom>
<dateto>2016-03-10</dateto>
</smalist>
</source>

'''smalist''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''datefrom''' — Дата «с». Необязательный элемент.
* '''dateto''' — Дата «по». Необязательный элемент.
Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.

'''Пример ответа на запрос списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smalist count="1">
<sma>
<code>6278</code>
<number>3992</number>
<actdate>2016-02-12</actdate>
<datepay></datepay>
<dateto>2016-02-12</dateto>
<promiseddatepay></promiseddatepay>
<price>637.00</price>
<pricecorr>113.00</pricecorr>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
<signedcopyreceived>NO</signedcopyreceived>
</sma>
</smalist>
</source>

* '''code''' — Код акта
* '''number''' — Номер акта в системе
* '''actdate''' — Дата акта
* '''datepay''' — Дата оплаты по акту
* '''dateto''' — Дата конечного периода для формирования АПД
* '''promiseddatepay''' — Плановая дата оплаты
* '''price''' — Стоимость услуг
* '''pricecorr''' — Сумма корректировки
* '''rur''' — Сумма заказа
* '''pricekur''' — Стоимость курьерской доставки
* '''priceag''' — Агентское вознаграждение
* '''payno''' — Номер платежного поручения
* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту
* '''paytypename''' — Строковое представление типа оплаты
* '''signedcopyreceived''' — Признак факта возврата акта YES/NO

== Детализация актов передачи денег ==
'''Пример запроса детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetail>
<auth extra="8" login="login" pass="pass" />
<code>6278</code>
</smadetail>
</source>

'''smadetail''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент.

'''Пример ответа на запрос детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smadetail count="2">
<specialsma>
<code>42494</code>
<ordercode>14424</ordercode>
<orderno>11111</orderno>
<orderdate>2018-01-01</orderdate>
<delivereddate>2018-10-01</delivereddate>
<company>Компания</company>
<price>314.00</price>
<rur>8800.00</rur>
<inshprice>314.00</inshprice>
<pricekur>270.00</pricekur>
<priceag>44.00</priceag>
<pricecalc>8486.00</pricecalc>
<paytype>2</paytype>
<paytypename>наличными курьером</paytypename>
<weight>0.400</weight>
<distance>0.0</distance>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

* '''code''' — Код записи.
* '''ordercode''' — Код заказа.
* '''orderno''' — Шифр заказа.
* '''orderdate''' — Дата заказа.
* '''delivereddate''' — Дата доставки.
* '''company''' — Получатель.
* '''price''' — Стоимость услуг.
* '''rur''' — Сумма заказа.
* '''inshprice''' — Стоимость заказа.
* '''pricekur''' — Стоимость курьерской доставки.
* '''priceag''' — Агентское вознаграждение.
* '''pricecalc''' — Сумма для передачи агенту.
* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.
* '''paytypename''' — Строковое представление типа оплаты
* '''weight''' — Вес заказа.
* '''distance''' — Дистанция по заказу
* '''status''' — Статус заказа.

== Установка статуса согласования заказа ==
Для возможности клиентом установки статуса согласования заказа необходимо включить переменную [[Личный кабинет курьерской службы#Заказы|Разрешить менять статус согласования]]

'''Пример запроса установки статуса согласования заказа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setapprovalstatus>
<auth extra="8" login="login" pass="pass" />
<order ordercode="1234561">
<confirmstate>1</confirmstate>
<message>Сообщение статуса</message>
</order>
<order ordercode="1234562">
<confirmstate>2</confirmstate>
<message>Согласовано</message>
</order>
<order ordercode="1234563">
<confirmstate>3</confirmstate>
<message>Не согласовано</message>
</order>
</setapprovalstatus>
</source>

* '''order''' — Контейнер заказа. Обязателен как минимум один элемент.
:* '''ordercode''' — Внутренний код заказа.
* '''confirmstate''' — Код статуса заказа. Все статусы с кодами можно получить запросом [[#Получение списка статусов согласования заказа|Получение списка статусов согласования заказа]]
* '''message''' — Дополнительный комментарий, который отобразится в поле ''Инфо о доставке''.

== Получение списка статусов согласования заказа ==
'''Пример запроса списка статусов согласования заказа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<approvalstatuses>
<auth extra="8" login="login" pass="pass" />
</approvalstatuses>
</source>

'''Пример ответа списка статусов согласования заказа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<approvalstatuses count="6">
<status>
<code>1</code>
<name>Неизвестно</name>
</status>
<status>
<code>2</code>
<name>Согласование запрошено</name>
</status>
<status>
<code>3</code>
<name>Доставка полностью согласована</name>
</status>
<status>
<code>4</code>
<name>Согласовано с изменением времени</name>
</status>
<status>
<code>5</code>
<name>Перенос на другую дату</name>
</status>
<status>
<code>6</code>
<name>Отказ</name>
</status>
</approvalstatuses>
</source>

== Генерация коротких ссылок ==
В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.
Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки.

'''Пример запроса генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<shortlink>
<link short="0"> https://home.courierexe.ru/8/site/orders </link>
</shortlink>
</source>

'''shortlink''' — Корневой контейнер. Обязательный элемент.
* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код.

'''Пример ответа на запрос генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
<hash>35AF350C</hash>
</shortlink>
</source>

* '''hash''' — Хэш-код ссылки.

Далее, можно использовать ссылку на ЛК:

<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>

'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft.

== Проверка надежности покупателя ==
Проверка надежности работает только для тарифа «Максимум» личного кабинета.

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<auth extra="8" login="login" pass="pass" />
<phones>
<phone>89161147992</phone>
</phones>
</mcheck>
</source>

Ответ:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<phones>
<phone rate="90">89161147992</phone>
</phones>
</mcheck>
</source>

== Размещение страниц на своем сайте (iframe) ==

В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте.

Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''.

[https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора:

<source lang="html">
<iframe id="frame" src="https://home.courierexe.ru/8/calculator">
Здесь должен отобразиться калькулятор
</iframe>
</source>

Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''':

<source lang="html">
<iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2">
Здесь должен отобразиться калькулятор
</iframe>
</source>

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# При использовании iFrame могут не работать некоторые функции, например, подписка на push-уведомления на странице трекинга или отслеживания.
# Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отображается.

Поддерживаемые языки и их коды:
:'''1''' — русский
:'''2''' — английский
:'''4''' — узбекский
</div>

== Оформление манифеста ==

'''Пример запроса на создание манифеста:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<manifest>
<auth extra="8" login="login" pass="pass" />
<store_from>1</store_from>
<store_to>2</store_to>
<trn_code>3</trn_code>
<sentdate>2024-11-07</sentdate>
<places>
<place>
<number>1</number>
<seal>7890AABBB</seal>
</place>
<place>
<number>2</number>
<seal>123456ABC</seal>
</place>
</places>
<addresses>
<address>
<code>12345</code>
<place>1</place>
</address>
<address>
<code>67890</code>
<place>2</place>
</address>
</addresses>
</manifest>
</source>

'''manifest''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''store_from''' - код филиала отправителя. Обязательный элемент.
*'''store_to''' - код филиала получателя. Обязательный элемент.
*'''trn_code''' - код перевозчика. Обязательный элемент.
*'''sentdate''' - дата отправки манифеста. Не обязательный элемент.
*'''addresses''' - корневой элемент для списка заказов.
*:'''address''' - корневой элемент для заказа.
*::'''code''' - наш внутренний номер заказа. Обязательный элемент.
*::'''place''' - номер места заказа. Обязательный элемент, если переданы места.
*'''places''' - корневой элемент для списка мест.
*::'''place''' - корневой элемент для места.
*::'''number''' - номер места. Обязательный элемент.
*::'''seal''' - номер пломбы. Необязательный элемент.

'''Пример успешного ответа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<result>OK</result>
</manifest>
</source>

'''Пример ответа с ошибкой'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<result error="Текст ошибки">ERROR</result>
</manifest>
</source>

'''manifest''' - Корневой контейнер. Обязательный элемент.
*'''result ''' - Результат. Принимает значения OK или ERROR.
*'''error''' - атрибут с текстом ошибки, если она была.

API

2026-03-20T14:04:50Z

OlegD: /* Описание полей ответа статусов */

<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Изменения для 54-ФЗ'''

Для передачи ставки НДС при оформлении заказа добавлен атрибут items > item > VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС.

'''ВНИМАНИЕ'''

В ближайшем будущем при подключенной услуге кассового обслуживания система '''перестанет''' принимать заказы без состава вложений.

</div>

<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API Documentation|HERE!]]'''
</div>

Вы можете настроить интеграцию с MeaSoft средствами XML API по протоколу HTTP POST.

API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с [http://courierexe.ru/our_clients.htm курьерскими службами], работающими под управлением системы [https://curie.ru/ MeaSoft].

Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим.

При написании этой документации мы предполагаем, что ее читатель обладает необходимой для понимания квалификацией программиста, владеет XML и средой разработки, в которой он делает интеграцию. Если вы не программист, вам необходимо привлечь к проекту профессионального программиста.

Если у вас после прочтения документации остались вопросы, задайте их по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите ваши контактные данные (телефон, скайп) и название компании, с которой вы хотите интегрироваться.

== Готовые интеграции ==
Для работы с популярными CMS и CRM-системами разработаны модули интеграции, перечисленные в таблице ниже.

'''Модули распространяются бесплатно, без гарантий со стороны разработчика''', и не являются средством полной автоматизации взаимодействия с курьерской службой. Модули — это помощь разработчикам интернет-магазинов в построении интеграции с курьерскими службами. '''Ответственность за корректность передачи данных лежит на интернет-магазине.'''
Модули сторонних разработчиков обслуживаются и разрабатываются сторонними компаниями. Все вопросы по их приобретению и поддержке необходимо задавать им.

Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.

{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;" | [https://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 20.5.0 и выше. Подробнее см. [[1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше. Подробнее см. [[PrestaShop|описание]].
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/opencart.zip Скачать для версии 1.5.5.1]<br>[https://courierexe.ru/download/api/measoft_oc2.ocmod.zip Скачать для версии 2.0]<br>[https://courierexe.ru/download/api/measoft_oc2.3.ocmod.zip Скачать для версии 2.3]<br>[https://courierexe.ru/download/api/measoft_oc3.ocmod.zip Скачать для версии 3.0]
|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[OpenCart|описание]].
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа. Инструкции есть в маркете, а также см. [[Webasyst|описание]].
|-

|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[InSales|Инструкция по настройке]]
|-
|[[Файл:iiko.jpg|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Iiko|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[https://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]
|[[LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[[RetailCRM|Настраивается]] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков (1 версия)]

[https://infostart.ru/public/1531484/ Альтернативный модуль сторонних разработчиков (2 версия)]
|-
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart. Инструкция в архиве
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/measoft Описание на сайте amoCRM]
|Подробное описание настроек читайте [[amoCRM|тут]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|
|[[МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|Интеграция МойСклад с курьерскими службами от сторонних разработчиков
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[https://courierexe.ru/wordpress/wordpress.php Скачать]
|[[Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[CS-Cart|Инструкция]]
|-
|[[Файл:webhooks.jpg|center|x100px]]
|style="text-align: center;"|Читайте описание [[Webhook|на этой странице]]
|Передача информации о статусах и заказах в вашу систему
|-
|[[Файл:Logo_tilda_black.png|center|x100px]]
|style="text-align: center;"|Читайте описание [[Tilda|на этой странице]]
|Работает только на платных тарифах
|-
|}

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]

Для отображения списка пунктов выдачи есть [https://home.courierexe.ru/js/measoft_map.js JavaScript модуль]. Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html здесь].

== Тестовый аккаунт ==
Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.

На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.

Для упрощения интеграции можно скачать [https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

== Рабочий аккаунт для подключения ==
Строка подключения выглядит следующим образом:

<source lang=xml>
<auth extra="8" login="login" pass="pass"></auth>
</source>

Описание параметров:
* '''extra''' — экстра-код, уникальный идентификатор компании, с которой вы интегрируетесь.
* '''login''' — логин клиента;
* '''pass''' — пароль клиента;
* '''measoftid''' — системная переменная, используемая системой.

Запросите эти данные у курьерской службы, к которой вы подключаетесь. Курьерская служба передает временный пароль, его нужно сменить после первого входа в [[Личный кабинет клиента|ЛК клиента]].

== Авторизация курьерской службы ==
Если курьерской службе требуется подключение под своими учетным данными, используйте строку вида:

<source lang=xml>
<auth extra="8" login="login" pass="pass" clientcode="123"></auth>
</source>

Описание:
* '''extra''' — уникальный идентификатор компании;
* '''login''' — логин курьерской службы;
* '''pass''' — пароль курьерской службы;
* '''clientcode''' — внутренний код клиента (вкладка '''Клиенты''', столбец «Внутренний код»).

Вы можете узнать код экстра, логин и пароль курьерской службы в офисном приложении MeaSoft в справочнике '''Дополнительные возможности'''. Подробнее см. раздел «[[Личный кабинет курьерской службы#Подключение|Подключение]]».

== Общие понятия ==
На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. <rspoiler text="Еще есть порт 8443.">Некоторые маршрутизаторы, используемые провайдерами, РНК и прочее, в попытке глубокого анализа могут повреждать трафик на стандартный порт 443. Сделано по тикету 10964.</rspoiler> Обратите внимание на символ '''«/»''' (slash) в конце адреса.

Тестовые авторизационные данные: логин: login пароль: pass, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.

Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''.

Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.
Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM.

В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp; < на &lt; > на &gt; " на &quot;

Наше API принципиально работает только по HTTPS, так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.php
где <IP> — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.
Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>:8080</spoiler>
Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].

== Ограничения ==
С целью защиты от нецелевого использования сервисов и DDoS-атак действуют следующие ограничения:
* 30 запросов tracking с одного IP-адреса за 1 минуту (используйте statusreq!);
* 150 запросов с одного IP-адреса/акаунта за 1 минуту;
* 1500 запросов с одного IP-адреса/акаунта за 20 минут;
* 3000 запросов с одного аккаунта за 1 час;
* 200 Мб скачанных текстовых данных за 3 часа.
* Превышение количества запросов статусов несуществующих заказов над существующими

В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.

Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами «tracking», они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].
* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.
* нужно проверять с каким ответом возвращаются ваши АПИ-запросы. Если мы отвечаем ошибкой, то даже запрос на создание нового заказа учитывается в количестве запросов.

Мы абсолютно уверены, что данные ограничения на порядки превосходят необходимые объемы предоставления сервиса для решения любых задач. Если у вас возникают проблемы, вы не знаете, как уложиться в эти рамки — спросите у нас, мы обязательно поможем!

== Оформление заказа ==

=== Пример оформления заказа ===
<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<neworder newfolder="NO">
<auth extra="8" login="login" pass="pass"></auth>
<order orderno="111111">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<inn>1112223335</inn>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<deliveryPIN>1234</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<deliveryprice VATrate="20">150</deliveryprice>
<discount>120</discount>
<paytype>CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>1</return_service>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<courier>22</courier>
<receiverpays>NO</receiverpays>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<respstore>4</respstore>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<items>
<item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" textArticle="1" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО "Рога и копыта"" suppphone="79161234567" suppINN="1112223334" govType="2" governmentCode="11223311" extraTags="">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message="" quantity="3"></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000" VATrate="10">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
<advprices>
<advprice>
<code>1</code>
<value>123</value>
</advprice>
<advprice>
<code>2</code>
<value>10.5</value>
</advprice>
<advprice>
<code>3</code>
<value>true</value>
</advprice>
</advprices>
<extrafields>
<extrafield>
<name>courier_car</name>
<value>ВАЗ 2106, бежевый</value>
</extrafield>
</extrafields>
<overall_volume>81</overall_volume>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</neworder>
</source>

=== Описание элементов для оформления заказа ===
'''Обязательные поля'''

Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.
<spoiler text="Пример минимально возможного заказа">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="login" pass="pass" />
<order>
<receiver>
<company>МВД</company>
<phone>(495)123-45-67</phone>
<address>Петровка, 38</address>
</receiver>
</order>
</neworder>
</source>
</spoiler>

'''Описание полей'''

* '''neworder''' — Корневой контейнер, обязательный элемент.

:* '''''newfolder''''' — Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

* '''order''' — Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.

:* '''''orderno''''' — Номер заказа. Если присваивается клиентом — указывается здесь. Если не присваивается — можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе. Система проверяет '''у клиента''' наличие заказов с указанным номером в '''пределах текущего календарного года''', которые '''не являются недоставленными''', и в случае их существования — заказ создан не будет, а в ответе вернется ошибка 17 «Such number exists».
Если не указан штрихкод (поле barcode), и значение поля подходит для использования его в качестве штрихкода, данное значение будет скопировано в поле «Штрихкод». Это накладывает ограничения в частности, на длину указанного поля (25 знаков, чтобы работали стандартные печатные формы).

* '''barcode''' — Штрихкод заказа. Если клиент штрихкодирует свои отправления и штрихкод отличается от номера заказа, в этом поле указывается штрихкод. Если ШК содержит кириллицу или малое количество символов, то формируется ШК в формате EAN13.

<spoiler text="Заполнение номера заказа (шифра) и штрих-кода">
Шифр и штрих-код заполняются исходя из начальных значений:

# Если шифр и ШК пустые - оба поля заполняются автоматически значением вида XXX#YYY, а после ШК проверяется на корректность (валидируется)
# Если ШК пустой, а шифр заполнен - ШК заполняется значением из шифра и валидируется
# Если шифр пустой, а ШК заполнен - шифр заполняется значением из ШК, после чего ШК валидируется
# Если оба непустые - валидируется ШК, шифр не проверяется

Корректный (валидный) ШК отвечает следующим требованиям:
* длина не меньше 5 символов
* значение не меньше значения переменной <mparam code="MinPrePrintedNum"/>
* содержит символы, которые можно использовать для формирования штрих-код а формате Code128 (т.е.все печатные символы, кроме кириллицы)

Если ШК не прошел проверку, то:
* если переменная <mparam code="StoreInvLength"/> равна 0, ШК заполняются автоматически значением вида XXX#YYY (или приравнивается шифру в том же формате)
* если переменная <mparam code="StoreInvLength"/> больше 0, ШК заполняются автоматически сквозным номером (если шифр в формате XXX#YYY, то шифр приравнивается ШК)
</spoiler>

В случае наличия нескольких мест и раздельной их маркировки в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрихкода, переменных для разных мест в рамках одного заказа.<br>
''Например'': В заказе номер 123 имеется 20 товарных вложений, которые упакованы в 3 транспортных места. Клиент формирует 3 штрихкода на транспортные места: CLNT0012301, CLNT0012302, CLNT0012303, где CLNT — префикс клиента, 00123 — номер заказа, 01-03 — номер транспортного места в заказе. В поле barcode нужно указать CLNT00123__ (система поймет, что 2 последних символа могут быть любыми и будут отражать штрихкоды к одному заказу). Если вы не сами печатаете накладные с указанным штрихкодом, то указанный штрихкод не должен быть длиннее 25 знаков, иначе он не поместится на стандартных печатных формах.

* '''sender''' — Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
<company>Название компании отправителя</company>
<person>Контактное лицо отправителя</person>
<phone>Телефон, Email отправителя</phone>
<town>Город отправителя в формате "Москва город"</town>
<address>Адрес отправителя</address>
<date>Дата забора в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время забора в формате "HH:MM"</time_min>
<time_max>Желаемое время забора в формате "HH:MM"</time_max>
</sender>
</source>

* '''receiver''' — Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
<company>Название компании получателя</company>
<person>Контактное лицо получателя</person>
<phone>Телефон, Email получателя</phone>
<town regioncode="Код региона">Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<inn>ИНН получателя</inn>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
</source>

* '''company''' — Компания-получатель.
* '''person''' — Контактное лицо. ''Должно быть заполнено хотя бы одно из полей — company или person!''
* '''phone''' — Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
* '''town''' — Город.
* '''pvz''' — Код пункта самовывоза по справочнику. Кроме того, ПВЗ можно указать в строке '''''address''''' в виде:
:* код ПВЗ в нашей системе
:* код ПВЗ в системе подрядчика
:* наименование ПВЗ в виде строки "ПВЗ " + «Наименование ПВЗ».

При указании ПВЗ в поле адреса необходимо проверять значение поля город получателя (он должен соответствовать данным ПВЗ) либо не передавать его вообще.

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.

Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.

Поле '''Город''' контейнеров '''sender''' и '''receiver''' можно указать одним из следующих способов:
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)

* '''coords''' — Координаты получателя. Если не указаны, система будет геокодировать самостоятельно.

* '''zipcode''' — Почтовый индекс.
* '''price''' — Сумма заказа (наложенный платеж) - денежные средства, которые курьер должен забрать у получателя в пользу заказчика. В случае наличия контейнера items значение этого параметра будет проигнорировано и рассчитано автоматически.
* '''inshprice''' — Объявленная ценность. Если явно не указана сумма — автоматически считается как сумма по товарам.
* '''deliveryprice''' — Стоимость доставки, которая устанавливается заказчиком и будет взиматься с получателя в пользу заказчика. Не имеет отношения к стоимости доставки самой курьерской службы, которая рассчитывается в соответствии с тарифамии, не указывается при оформлении заказа и добавляется в заказ автоматически при его обработке курьерской службой. В случае наличия контейнера items в него будет добавлено вложение «Доставка».
:* '''''VATrate''''' — Ставка НДС — целое число процентов.
* '''discount''' — Сумма скидки. Скидка «размазывается» по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.
* '''paytype''' — Тип оплаты заказа получателем. Принимает значения:
:* CASH — Наличными при получении (по-умолчанию)
:* CARD — Картой при получении
:* NO — Без оплаты. Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации. API добавит к товарам строку предоплаты в сумму заказа, чтобы общая сумма была 0, однако в кассовом чеке будут все товары с ценами, и оплата предоплатой, как того требует 54-ФЗ.
:* OTHER — Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты — таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т. д.)
:* OPTION — На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.
* '''weight''' — Общий вес заказа в килограммах.
* '''quantity''' — Количество мест.
* '''service''' — Режим доставки (тип услуги) передается код из справочника «[[#Справочник Виды срочности|Виды срочности]]».
* '''type''' — Тип корреспонденции (отправления) передается код из справочника «Типы корреспонденции».
* '''return''' — Признак необходимости возврата. Принимает значения:
:* NO — Возврат не требуется
:* YES — Требуется возврат, например, документов
:* ONLY — Требуется забрать отправление у поставщика (см. раздел «[[Личный_кабинет_клиента#Привезти ко мне|Привезти ко мне]]»).
* '''return_service''' — Режим возврата (тип услуги) передается код из справочника «Виды срочности».
* '''return_type''' — Тип возвратной корреспонденции (отправления) передается код из справочника «Типы корреспонденции».
* '''return_weight''' — Общий вес возврата заказа в килограммах.
* '''enclosure''' — Вложение.
* '''instruction''' — Поручение — Примечание.
* '''courier''' — Запланированный курьер. Согласно коду курьера в КС2008.
* '''receiverpays''' — Признак оплаты стоимости доставки — услуг службы доставки получателем, а не заказчиком YES/NO.
* '''department''' — Подразделение, в котором оформляется заказ.
* '''costcode''' — Кост-код сотрудника.
* '''respstore''' — Код ответственного филиала. Для ответственного филиала в который передается заказ, требуется включение параметра "Разрешить клиенту передавать заказы в этот филиал"
* '''pickup''' — Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений. ''Внимание!'' при добавлении в забор складских товаров, их тип '''''type''''' всегда должен быть установлен как [7] Забор товара, если будет указан другой тип, то он будет исправлен в момент добавления заказа на [7] Забор товара
* '''acceptpartially''' — Признак возможности частичного выкупа товаров отправления YES/NO.
* '''uid''' - Универсальный идентификатор заказа на стороне отправителя. Не обязательный параметр, ограниченного по времени действия. Время хранения в системе, - сутки.

* '''items''' — Контейнер для описания вложений. <rspoiler text="Необязательный контейнер">Если для поставщика товара в системе MeaSoft не указаны полное наименование компании и ИНН в карточке клиента, заполните параметры <code>suppcompany</code> и <code>suppINN</code> в этом контейнере. Отсутствие информации о поставщике приведет к [[Настройка модуля печати кассовых чеков#Ошибка фискализации (ошибка программирования реквизита 1226)|ошибке фискализации]].</rspoiler>. Атрибуты:
:* '''''item''''' — Название вложения.
:* '''''quantity''''' — Количество единиц товара.
:* '''''mass''''' — Масса единицы товара в килограммах.
:* '''''volume''''' — Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
:* '''''length''''' — Длина единицы товара (в сантиметрах).
:* '''''width''''' — Ширина единицы товара (в сантиметрах).
:* '''''height''''' — Высота единицы товара (в сантиметрах).
:* '''''retprice''''' — Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной. 
:* '''''inshprice''''' — Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной '''''retprice'''''.
:* '''''VATrate''''' — Ставка НДС — целое число процентов. Если товар хранится в КС (смотрите '''article''' ниже), значение берется из номенклатуры. Иначе, если значение указано, берется указанное значение, если нет - значение из настроек фирмы КС. Значение «0» означает ставку «Без НДС», ставка «0%» на данный момент не поддерживается.
:* '''''barcode''''' — Штрихкод вложения.
:* '''''article''''' — Артикул вложения. ''Внимание!'' Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров — система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении — артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
:* '''''itemcode''''' — Внутренний код товара, может использоваться вместо артикула. ''Внимание!'' Указание кода товара используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к [[API#Справочник номенклатуры|справочнику номенклатуры]]. Если товар в справочнике не найден — система выдаст соответствующую ошибку. Если товар НЕ на ответственном хранении — код товара указывать НЕ нужно.
:* '''''type''''' — Тип вложения. Принимает значения:
:: 1 — Товар. По-умолчанию.
:: 2 — Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice
:: 3 — Услуга
:: 4 — Предоплата. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.
:: 6 — Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда «1». В заказе сумма будет отрицательной независимо от знака в запросе.
:: 7 — Забор товара. Если товар нужно у получателя забрать, возможно — вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.
:* '''''extcode''''' — Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.
:* '''''origincountry''''' — Код страны-производителя в соответствии со [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.
:* '''''GTD''''' — Номер ГТД.
:* '''''excise''''' — Сумма акциза.
:* '''''suppcompany''''' — Наименование компании поставщика, если отличается от заказчика.
:* '''''suppphone''''' — Номер телефона компании поставщика, если отличается от заказчика.
:* '''''suppINN''''' — ИНН компании поставщика, если отличается от заказчика.
:* '''''governmentCode''''' — Код товарной номенклатуры. Используется для [[Маркировка|маркированных товаров, например («Честный знак»)]]. Для кода '''Честный знак''' Нужно указывать все данные из нанесенного QR-кода кроме не читаемых символов (#29). Если код не известен — укажите знак вопроса «?», тогда курьер отсканирует код фактически передаваемого покупателю товара. Для некоторых процессов может использоваться значение «!» — в этом случае курьер сканирует серийный номер товара, но это не считается кодом маркировки. При этом, если указано значение «?» или «!» и quantity больше 1, то такое вложение растиражируется quantity раз.
:* '''''govType''''' — Тип маркировки товара. В данный момент существуют следующие типы маркировки:
:: 1 — Честный знак. По-умолчанию.
:: 2 — ГИИС ДМДК.
:: 3 — Серийный номер.
:* '''''message''''' — Строка сообщения.
:* '''''extraTags''''' — Строка в формате JSON для отправки в ОФД.

:: Тэг 1265 - значение отраслевого реквизита = код места деятельности аптеки

:: Тэг 1262 – идентификатор ФОИВ = "020" (константа ФОИВ МИНЗДРАВа)

:: Тэг 1263 - дата нормативного акта федерального органа исполнительной власти = "14.12.2018" (константа)

:: Тэг 1264 - номер нормативного акта федерального органа исполнительной власти = "1556"(константа)

:: Тэг 1212 - Признак предмета расчета

:: Пример:

<source lang="json">
"item_industry_props":{"tag1262":"020","tag1263":"14.12.2018","tag1264":"1556","tag1265":"tm=mdlp&sid=00000000XXXXXX"},
"tag1212": "1"
</source>

Для клиентов из '''Узбекистана''' необходимо указывать код ИКПУ и код упаковки в следующем формате:
<source lang="json">
"ikpu":"123123123","packageCode":"123456"
</source>

* '''packages''' — Контейнер для описания мест. Необязательный контейнер. Атрибуты:
:* '''''package''''' — Название места.
:* '''''code''''' — Внутренний код строки.
:* '''''strbarcode''''' — Штрихкод места.
:* '''''mass''''' — Масса места в килограммах.
:* '''''message''''' — Строка сообщения.
:* '''''length''''' — Длина товарного места (в сантиметрах).
:* '''''width''''' — Ширина товарного места (в сантиметрах).
:* '''''height''''' — Высота товарного места (в сантиметрах).
:* '''''quantity''''' — Количество мест с данным набором параметров. Действует ограничение на общее количество мест в заказе. Общее количество мест в заказе не может быть больше 1000.

* '''deliveryset''' — настройка [[Дифференцированная стоимость доставки|дифференцированной стоимости доставки]]. Атрибуты:
:* '''''above_price''''' — стоимость в случае полного выкупа заказа (действует как «сумма от» последней границы, указанной в теге below_sum)
:* '''''return_price''''' — стоимость в случае возврата заказа
:* '''''VATrate''''' — Ставка НДС — целое число процентов.

* '''below''' — граница стоимости настроек
:* '''''below_sum''''' — граница стоимости выкупаемого заказа
:* '''''price''''' — стоимость выкупаемого заказа до соответствующей границы

* '''advprices''' — Контейнер для описания дополнительных услуг. Необязательный элемент. <span style="color: red;>Для обработки в API включите дополнительные услуги в настройках полей [[Личный кабинет курьерской службы#Настройка личного кабинета клиента|заказов и заборов]]</span>
:* '''''code''''' — код услуги.
:* '''''value''''' — значение услуги. Если тип услуги bool, то в значении передаем true.

* '''extrafields''' — Контейнер для описания расширенных полей. Необязательный элемент. Может содержать несколько элементов extrafield
* '''extrafield''' — Контейнер для описания расширенного поля.
:* '''''name''''' — наименование переменной. Может содержать только латинские буквы, цифры и знак подчеркивания "_", но начинаться может только с буквы. Максимальная длина - 20 символов.
:* '''''value''''' — значение переменной. Максимальная длина - 250 символов.

* '''overall_volume''' — Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины.

* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.

* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный кабинет курьерской службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и т. д.) — их нужно указать в том же контейнере items как товары, без артикула.

=== Примеры ответов ===
При успешном выполнении запроса, создании заказа, возвращается сумма заказа в атрибуте orderprice, а также ошибка 0. При не успешном — номер ошибки и текст ее на английском языке в атрибуте errormsg, для некоторых ошибок выводится перевод на русский в атрибуте errormsgru.
В атрибут orderno помещается номер заказа, в атрибут barcode — штрихкод заказа.

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />
<createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />
<createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" />
</neworder>
</source>

'''Пример ответа с ошибкой'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
<createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." />
<createorder orderno="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
</neworder>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Коды и описание ошибок ===
{|class=wikitable
!Код ошибки
!Английское описание
!Русское описание
|-
|0||Success||Успешно
|-
|1||Wrong XML||Некорректный файл XML.
|-
|2||Lat is empty||Укажите широту.
|-
|3||Specify a valid «Price» field value.||Укажите корректное значение поля «Сумма».
|-
|4||Specify a valid «Weight» field value.||Укажите корректное значение поля «Вес».
|-
|5||Recepient city/town not found.||Город назначения не найден.
|-
|6||Sender city/town not found.||Город отправления не найден.
|-
|7||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».
|-
|8||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».
|-
|9||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».
|-
|10||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество».
|-
|11||Specify a valid «Declared value» field value.||Укажите корректное значение поля «Объявленная ценность».
|-
|12||Supplier SKU ID not found.||Артикул не найден.
|-
|17||Order number already exists in the database.||Такой номер заказа уже есть в базе.
|-
|18||Order code already exists in the database.||Такой код заказа уже есть в базе.
|-
|19||The delivery date format is not valid. Specify a date in YYYY-MM-DD format.||Укажите значение поля «Дата доставки» в формате гггг-мм-дд.
|-
|20||Specify a valid «Delivery mode» field value.||Укажите корректное значение поля «Режим доставки».
|-
|21||Specify a valid «Return trip mode» field value.||Укажите корректное значение поля «Режим возврата».
|-
|22||Specify a valid «Delivery type» field value.||Укажите корректное значение поля «Тип доставки».
|-
|23||Specify a valid «Return shipment type» field value.||Укажите корректное значение поля «Тип возврата».
|-
|30||Specify the «Order number» field value.||Укажите значение поля «Номер заказа».
|-
|31||Specify the «Barcode» field value.||Укажите значение поля «Штрихкод».
|-
|32||Specify the «Sender company» field value.||Укажите значение поля «Компания-отправитель».
|-
|33||Specify the «Sender name» field value.||Укажите значение поля «ФИО отправителя».
|-
|34||Specify the «Sender phone» field value.||Укажите значение поля «Телефон отправителя».
|-
|35||Specify the «Sender city/town» field value.||Укажите значение поля «Город отправителя».
|-
|36||Specify the «Sender address» field value.||Укажите значение поля «Адрес отправителя».
|-
|37||Specify the «Pickup date» field value.||Укажите значение поля «Дата забора».
|-
|38||Specify the «Pickup time from» field value.||Укажите значение поля «Время забора с».
|-
|39||Specify the «Pickup time to» field value.||Укажите значение поля «Время забора до».
|-
|40||Specify the «Recipient company» field value.||Укажите значение поля «Компания-получатель».
|-
|41||Specify the «Recipient name» field value.||Укажите значение поля «ФИО получателя».
|-
|42||Specify the «Recipient phone» field value.||Укажите значение поля «Телефон получателя».
|-
|43||Specify the «Recipient city/town» field value.||Укажите значение поля «Город получателя».
|-
|44||Specify the «Recipient address» field value.||Укажите значение поля «Адрес получателя».
|-
|45||Specify the «Delivery date» field value.||Укажите значение поля «Дата доставки».
|-
|46||Specify the «Delivery time from» field value.||Укажите значение поля «Время доставки с».
|-
|47||Specify the «Delivery time to» field value.||Укажите значение поля «Время доставки до».
|-
|48||Specify the «Recipient postcode» field value.||Укажите значение поля «Индекс получателя».
|-
|49||Specify the «Weight» field value.||Укажите значение поля «Вес».
|-
|50||Specify the «Payment type» field value.||Укажите значение поля «Тип оплаты».
|-
|51||Specify the «Quantity» field value.||Укажите значение поля «Количество».
|-
|52||Specify the «Amount» field value.||Укажите значение поля «Сумма».
|-
|53||Specify the «Declared value» field value.||Укажите значение поля «Объявленная стоимость».
|-
|54||Specify the «Description» field value.||Укажите значение поля «Описание».
|-
|55||Specify the «Instruction» field value.||Укажите значение поля «Поручение».
|-
|56||Specify the «Delivery mode» field value.||Укажите значение поля «Режим доставки».
|-
|57||Specify the «Shipment type» field value.||Укажите значение поля «Тип отправления».
|-
|58||Specify whether return trip is required.||Укажите значение поля «Необходимость возврата».
|-
|59||Specify the «Return trip mode» field value.||Укажите значение поля «Режим возврата»
|-
|60||Specify the «Return shipment type» field value.||Укажите значение поля «Тип возврата».
|-
|61||Specify barcode.||Укажите штрихкод.
|-
|62||Specify item weight.||Укажите массу единицы товара.
|-
|63||Specify item quantity.||Укажите количество товара.
|-
|64||Specify item price.||Укажите цену единицы товара.
|-
|65||Specify item name.||Укажите название товара.
|-
|66||Wrong XLS file||Некорректный файл XLS.
|-
|67||Order barcode already exists in the database.||Такой штрихкод заказа уже есть в базе.
|-
|68||Select the «Payment by recipient» field value.||Укажите значение поля «Оплата получателем».
|-
|69||Specify department.||Укажите отдел.
|-
|70||Specify service partner code.||Укажите значение поля «Код подрядчика».
|-
|71||Date cannot be earlier than tomorrow.||Дата не может быть раньше чем завтра.
|-
|72||Date cannot be later than 15 days from now.||Дата не может быть позже чем через 15 дней.
|-
|73||Date cannot be earlier than today.||Дата не может быть раньше чем сегодня.
|-
|74||Date cannot be later than {0} days from now.||Дата не может быть позже, чем через {0} дней.
|-
|75||Specify a valid «Item weight» field value.||Укажите корректное значение поля «Масса единицы товара».
|-
|76||Specify a valid «Quantity» field value.||Укажите корректное значение поля «Количество товара».
|-
|77||Specify a valid «Item price» field value.||Укажите корректное значение поля «Цена единицы товара».
|-
|78||Specify a valid «Delivery time from» field value.||Укажите корректное значение поля «Время доставки с».
|-
|79||Specify a valid «Delivery time to» field value.||Укажите корректное значение поля «Время доставки до».
|-
|80||Specify a valid «Pickup time from» field value.||Укажите корректное значение поля «Время забора с».
|-
|81||Specify a valid «Pickup time to» field value.||Укажите корректное значение поля «Время забора до».
|-
|82||Specify a valid «Pickup point» field value.||Укажите корректное значение поля «ПВЗ».
|-
|83||Duplicate number in the registry.||Дублирование номера в реестре.
|-
|84||Duplicate barcode in the registry.||Дублирование штрихкода в реестре.
|-
|85||Specify a valid «Weight at return trip» field value.||Укажите корректное значение поля «Вес возврата».
|-
|86||Specify the «Weight at return trip» field value.||Укажите значение поля «Вес возврата».
|-
|87||Order weight exceeds the allowed maximum for the pickup point.||Вес превышает допустимое значение для этого ПВЗ.
|-
|88||Pickup date cannot be earlier than today.||Дата забора не может быть раньше чем сегодня.
|-
|89||Specify a later delivery date.||Укажите более позднюю дату доставки.
|-
|90||Inappropriate «Weight» or «Pay type» field value for the selected city or town. Please review and correct the values.||Значение поля «Масса» или «Тип оплаты» для выбранного города указано некорректно или отсутствует. Проверьте значения и исправьте.
|-
|91||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.
|-
|92||{deliverytype} {deliverydate} is {holidaytype}. Select another date.||{deliverytype} {deliverydate} является {holidaytype}. Выберите другую дату.
|-
|93||Add items.||Добавьте товары.
|-
|95||The selected pickup point only allows paid orders.||Выбранный ПВЗ выдает только предоплаченные заказы.
|-
|96||Order barcode exceeds the allowed maximum (25) symbols.||Длина штрихкода заказа превышает максимально допустимую (25 символов).
|-
|97||The pickup date format is not valid. Specify a date in YYYY-MM-DD format.||Укажите значение поля «Дата забора» в формате гггг-мм-дд.
|-
|98||Specify the cost code.||Укажите значение поля «Кост-код».
|-
|99||The item is not in stock.||Товар отсутствует на складе.
|-
|100||Set the quantity of the item marked with Chestny ZNAK to one.||Укажите количество товара, маркированного кодом «Честный ЗНАК», равным единице.
|-
|101||Quantity of item Delivery cannot be greater than 1||Количество вложений типа «Доставка» не может быть более 1.
|-
|102||А database error occurred. Please try later again.||Ошибка базы данных. Попробуйте позже.
|-
|103||Order not found.||Заказ не найден.
|-
|104||Cannot edit order in the current status.||Невозможно изменить заказ в текущем статусе.
|-
|105||Discount cannot be greater than the order amount. Specify a smaller value.||Размер скидки не может превышать сумму заказа. Укажите меньшее значение скидки.
|-
|106||Specify the correct additional service code.||Укажите корректный код дополнительной услуги.
|-
|107||Specify the correct additional service name.||Укажите корректное значение поля [advprice][value].
|-
|108||Specify the «Additional services» field value.||Укажите значение поля «Дополнительные услуги».
|-
|110||Specify the correct TIN.||Укажите корректный ИНН.
|-
|111||Specify the correct IIN (KZ).||Укажите корректный ИИН (КЗ).
|-
|112||Specify the overall volume.||Укажите общий объем.
|-
|113||Cannot apply the delivery mode. Select another delivery mode.||Режим доставки не подходит для заказа. Выберите другой режим.
|-
|114||The pickup point does not support the selected delivery mode. Specify another pickup point.||ПВЗ не подходит для выбранного режима доставки. Укажите другой ПВЗ.
|-
|115||Specify a valid recipient phone number.||Укажите корректный телефон получателя.
|-
|116||Specify recipient PIN code.||Укажите пин-код получателя.
|-
|117||Order date cannot be earlier than {0}. Specify another date.||Дата заказа не может быть раньше {0}. Укажите другую дату.
|-
|118||Pickup date cannot be earlier than {0}. Specify another date.||Дата забора не может быть раньше {0}. Укажите другую дату.
|-
|119||Specify the correct item type.||Укажите корректный тип вложения.
|-
|120||The pickup point does not accept payment by card.||В выбранном ПВЗ оплата картой не принимается.
|-
|121||Invalid item code format||Неверный формат кода товарной номенклатуры
|-
|122||Pickup time cannot be earlier than {0} hours.||Время забора не может быть раньше чем через {0} часа.
|-
|123||Pickup interval cannot be less than {0} minutes.||Интервал времени забора не может быть менее {0} минут. Укажите корректный интервал.
|-
|124||Specify a valid "Payment type" field value.||Укажите корректное значение поля «Тип оплаты».
|-
|125||Recepient city/town by postcode not found.||Город получателя по его индексу не найден.
|-
|126||Incorrect items prepayment and pickup.||Заказ не может содержать только вложения «Предоплата» и «Забор».
|-
|127||Package limit exceeded||Превышен лимит количества мест
|-
|128||Quantity of item Prepayment cannot be greater than 1||Количество вложений типа «Предоплата» не может быть больше 1.
|-
|129||Sum of cod must be equal sum of items||Объявленная стоимость должна быть равна сумме вложений.
|-
|130||Specify a valid respstore code.||Укажите код ответственного филиала.
|-
|131||Cannot edit, order has not been synchronized.||Невозможно изменить заказ пока он не синхронизирован.
|-
|132||Specify a valid "Recipient city/town" field value.||Укажите город получателя
|-
|133||Specify a valid "weight" for the town.||Укажите корректный вес для города
|-
|134||Specify a valid "paytype" for the town.||Укажите тип оплаты для города
|-
|135||Specify the correct SKU ID/code for item.||Укажите артикул/код вложения
|-
|136||Specify warehouse goods in the order.||Укажите вложения в заказе
|-
|137||The order's date of creation is more than 60 days ago.||Заказ создан более 60 дней назад
|-
|138||Specify a valid "Package dimension" field value.||Укажите корректные габариты места
|-
|139||Wrong type of XML query||Ошибка запроса
|-
|140||Duplicate item code in the order.||Дублирование кода вложения в заказе
|-
|141||Duplicate additional service in the order.||Дублирование кода дополнительной услуги в заказе
|-
|144||Incorrect extrafields.||Некорректные расширенные поля.
|-
|}

=== Передача значений полей в форме создания заказа в Личном Кабинете через GET параметры ===
Если вам требуется передавать значения полей в форме создания заказа в Личном Кабинете через GET параметры, то вы можете подробно ознакомиться с этим на данной странице - [[Личный_кабинет_клиента#Передача и подстановка значений полей формы создания заказа через GET параметры]]

== Запрос статуса заказов ==

=== Пример запроса статуса заказа ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<orderno>1234</orderno>
<orderno2>5678</orderno2>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<uid>af11c7c6-6645-4a20-9604-be911a75722d</uid>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
<conditions>
<namecontains/>
<namestarts/>
</conditions>
<limit>500</limit>
</statusreq>
</source>

=== Описание полей запроса статуса ===
'''statusreq''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''client''' — Признак клиента или агента. Необязательный элемент.
:* CLIENT — Признак клиента, значение по умолчанию
:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
* '''orderno''' — Идентификатор заказа у клиента (шифр). Необязательный элемент.
* '''ordercode''' — Внутренний код заказа. Необязательный элемент.
* '''orderno2''' — Номер заказа из срочных. Необязательный элемент.
* '''uid''' — Уникальный идентификатор, если он был добавлен при создании заказа. Необязательный элемент. Запрос информации по uid возможен в течении суток после создания заказа
* '''datefrom''' — Дата заказа «с». Необязательный элемент.
* '''dateto''' — Дата заказа «по». Необязательный элемент.
* '''target''' — Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.
* '''done''' — Может принимать значения:
:* ONLY_DONE — Только доставленные (имеются в виду успешные статусы, например, '''Доставлен''' или '''Частично доставлен''')
:* ONLY_NOT_DONE — Только не доставленные (заказы, которые не являются доставленными, например, '''Не доставлен''' или '''Утерян''')
:* ONLY_NEW — Только новые
:* ONLY_DELIVERY — Только заказы в обработке — заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т. д.
:* ''Пусто'' — все корреспонденции

* '''changes''' — может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

* '''conditions''' — Задает условия фильтрации по «orderno». Все вложенные элементы одновременно накладывают условие «И». Минимум 5 символов!
:* '''namecontains''' — Поиск по номеру заказа(шифр), который содержит «orderno».
:* '''namestarts''' — Поиск по номеру заказа(шифр), который начинается с «orderno».

* '''limit''' — Необязательный параметр. Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После каждой итерации нужно вызывать commitlaststatus с контейнером списка обработанных кодов, [[#Лимитирование запросов|читать подробнее]]

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''«по»'''.
# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.
# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.
# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.
# Поиск по '''conditions''' работает только для «Номер заказа(шифр)» и только от 4 символов
</div>
<br>

=== Примеры ответов ===
'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<contacts>
<phone>+74951234567</phone>
</contacts>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67 - Иван (916)234.45.21 Петр,mvd@mail.ru</phone>
<contacts>
<phone>+74951234567</phone>
<phone>+79162344521</phone>
<email>mvd@mail.ru</email>
</contacts>
<inn>1112223335</inn>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<area>Район 1</area>
<pvz>
<code>126</code>
<clientcode>QWERTY</clientcode>
</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<coords lat="55.680327" lon="37.604456"></coords>
<deliveryPIN>1234</deliveryPIN>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<paytype code="1">CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</service>
<return_type>3</return_type>
<return_weight>5.1</return_weight>
<return_message>Доставлено в целости</return_message>
<return_date>2026-01-19</return_date>
<return_time>13:18:00</return_time>
<pickup>NO</pickup>
<print_check>YES</print_check>
<waittime>12</waittime>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords>
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<deliveryprice total="158.6" delivery="100.00" return="58.6">
<advprice code="1" price="150">База</advprice>
<advprice code="2" price="0">% от объявленной стоимости</advprice>
<advprice code="3" price="8.6">Топливный сбор</advprice>
<advprice code="4" price="0">Округление</advprice>
</deliveryprice>
<receiverpays>NO</receiverpays>
<acceptpartially>NO</acceptpartially>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен" eventtown="Санкт-Петербург город" color="16777215">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Новый" eventtown="Москва город" country="RU">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44"
message="филиал в Санкт-Петербурге" title="Планируется отправка" eventtown="Москва город" country="RU">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44"
message="филиал в Санкт-Петербурге" title="Отправлено со склада" eventtown="Москва город" country="RU">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Получен складом" eventtown="Санкт-Петербург город" country="RU">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Выдан курьеру на доставку" eventtown="Санкт-Петербург город" country="RU">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Доставлен (предварительно)" eventtown="Санкт-Петербург город" country="RU">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44"
message="" title="Доставлен" eventtown="Санкт-Петербург город" country="RU">COMPLETE</status>
</statushistory>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<department>Отдел</department>
<costcode>cc12345</costcode>
<outstrbarcode>EXT123456</outstrbarcode>
<respstore>14</respstore>
<partner>Офис на Ленина</partner>
<arrival>2016-05-02 23:21</arrival>
<receipt fdNum="124555" fnSn="9289000100295555" kktNum="0001611984048555" inn="7722756555" fdValue="2899551555" summ="387.5" ofdUrl="gate.ofd.ru">https://ofd.ru/rec/7722756555/0001611984048555/9289000100295555/124555/2899551555</receipt>
<items>
<item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" govType="1" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="" govType="1">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="" govType="1">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package>
</packages>
<extrafields>
<extrafield>
<name>courier_car</name>
<value>ВАЗ 2106, бежевый</value>
</extrafield>
</extrafields>
</order>
</statusreq>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<statusreq count="0">
</statusreq>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Описание полей ответа статусов ===
Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

* Атрибуты контейнера '''order''':
:* '''''awb''''' — Номер накладной в системе курьерской службы.
:* '''''orderno2''''' — Номер накладной в подсистеме срочной доставки курьерской службы.
:* '''''ordercode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.
:* '''''givencode''''' — внутренний код заказа в системе, применяется для некоторых внутренних операций.

*'''paytype''' - Тип оплаты заказа получателем. Принимает значения:
:: CASH - Наличными при получении (по-умолчанию)
:: CARD - Картой при получении
:: NO - Без оплаты.
:: OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
* Атрибуты контейнера '''paytype''':
** '''''code''''' - (integer) внутренний код типа оплаты заказа в системном справочнике "Типы оплаты корреспонденции". Не обязательный элемент.

* атрибут '''''code''''' контейнера '''item''' — внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* атрибут '''''got''''' контейнера '''package''' — признак принятого места YES / NO.
:* '''''returns''''' — количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

* '''''area''''' в контейнере '''receiver''' — район/метро получателя.
* '''''coords''''' в контейнере '''receiver''' — координаты получателя.
* '''''deliveryPIN''''' в контейнере '''receiver''' — Пин-код.
* '''pickup''' — признак оформления забора, возможные значения: '''YES''', '''NO'''. Если указано '''YES''', то весь заказ считается заданием на забор груза, а не на доставку.
* '''currcoords''' — текущие координаты заказа. Атрибуты:
:* '''''lat''''' — широта
:* '''''lon''''' — долгота
:* '''''accuracy''''' — точность в метрах
:* '''''RequestDateTime''''' — дата/время последнего обновления координат.

* '''courier''' — Данные курьера, которому выдан заказ. Если заказ не выдан, то выводятся данные запланированного курьера.
* '''waittime ''' — Время ожидания курьера.
* '''deliveryprice''' — Стоимость услуг в валюте расчетов с клиентом. Атрибуты:
:* '''''total''''' — общая стоимость услуг
:* '''''delivery''''' — стоимость доставки «Туда»
:* '''''return''''' — стоимость доставки «Обратно» (если order->return=YES)
Тэг '''deliveryprice''' включает список дополнительных услуг (только для тарифа «Премиум»):
:* '''''advprice''''' — наименование дополнительной услуги
:* '''''code''''' — код дополнительной услуги
:* '''''price''''' — стоимость дополнительной услуги

* '''status''' — статус доставки (список статусов см. ниже). Атрибуты (заполняются начиная с версии системы 2008.0.0.670):
:* '''''eventstore''''' — филиал, к которому относится текущий статус
:* '''''eventtime''''' — время события по часовому поясу места его наступления.
:* '''''createtimegmt''''' — время по GMT создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. <spoiler text="Подробнее">Большинство событий фиксируются в полях eventtime и createtimegmt на основании одного действия, тогда они отличаются только сдвигом от GMT. Однако, если курьер доставил отправление 10.10.2010 в 20:00, по какой-то причине не внес это в мобильное приложение, на следующий день сдал накладную, и в 9 утра оператор внесла, что он доставил вчера в 20:00. Тогда в createtimegmt будет сегодня 6 утра (для Москвы), а в eventtime — вчера в 20:00. При этом оператор по каким-то причинам может внести время вручения раньше, чем какое-то предыдущее событие, т.о. нарушится последовательность времени в eventtime, но при сортировке по createtimegmt все-равно все будет правильно.</spoiler>
:* '''''message''''' — наименование филиала-получателя, при передаче между филиалами
:* '''''title''''' — русское наименование статуса

* '''statushistory''' — история статусов доставки. Содержит список контейнеров '''status'''. Заполняется только для тарифа «Премиум» начиная с версии системы 2008.0.0.670.
* '''customstatecode''' — код внутреннего статуса курьерской службы. Значения уточняйте в курьерской службе. Назначаются курьерской службой в разделе «Справочники» — «Статусы» — «15 Статусы корреспонденции». Справочник не передается через API клиенту по причине возможного наличия в нем внутренних технологических статусов курьерской службы.
* '''clientstatecode''' — код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
* '''deliveredto''' — данные из поля «Инфо. о доставке» (может быть информация о доставке, причина недоставки и т. п.).
* '''delivereddate''' — дата вручения.
* '''deliveredtime''' — время вручения. В случае недоставки может быть пустым.
* '''arrival''' — плановая дата прибытия в формате гггг-мм-дд чч: мм: сс. Заполняется только при использовании автоматических систем планирования (Максоптра, Яндекс доставка), во всех остальных случаях - пустое.
* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.
* '''partner''' — текущий филиал/подрядчик.
* '''return_message''' — информация о возврате
* '''return_date''' - дата возврата
* '''return_time''' - время возврата
* '''department''' — Подразделение, в котором оформляется заказ.

Контейнер '''status''' может принимать следующие значения:
: AWAITING_SYNC — Ожидает синхронизации. Данные заказа пока не появились в службе доставки.
: '''NEW''' — Успешно создан, передан в службу доставки.
: NEWPICKUP — Создан забор.
: PICKUP — Забран у отправителя.
: WMSASSEMBLED — Скомплектован на складе фулфилмента.
: WMSDISASSEMBLED — Разукомплектован на склад фулфилмента.
: '''ACCEPTED''' — Получен складом.
: CUSTOMSPROCESS — Производится таможенный контроль.
: CUSTOMSFINISHED — Таможенный контроль произведен.
: CONFIRM — Согласована доставка.
: UNCONFIRM — Не удалось согласовать доставку.
: DEPARTURING — Планируется отправка со склада на другой склад.
: DEPARTURE — Отправлено со склада на другой склад.
: INVENTORY — Инвентаризация. Убедились в наличии отправления на складе.
: PICKUPREADY — Готов к выдаче в ПВЗ.
: '''DELIVERY''' — Выдан курьеру на доставку.
: COURIERDELIVERED — Доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус COMPLETE).
: COURIERPARTIALLY — Частично доставлен (предварительно, ожидает подтверждения менеджером, чтобы перейти в статус PARTIALLY).
: COURIERCANCELED — Отказ (предварительно, после этого ожидается COURIERRETURN).
: COURIERRETURN — Возвращено курьером. Курьер не смог доставить до получателя и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли повторно доставлять (статусы DATECHANGE/DELIVERY) или это окончательная недоставка (CANCELED).
: DATECHANGE — Перенос даты доставки.

: '''COMPLETE''' — Доставлен.
: '''PARTIALLY''' — Доставлен частично.
: '''CANCELED''' — Не доставлен (Возврат/Отмена). После этого статуса отправление должны вернуть заказчику, будут статусы RETURNING и RETURNED

: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.

: PARTLYRETURNING — Планируется возврат остатков.
: PARTLYRETURNED — Остаток возвращен.
: TRANSACCEPTED — Прибыл на склад перевозчика.
: PICKUPTRANS — Забран у перевозчика.

'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Контейнер '''packages''' не возвращает более 1000 элементов.
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. То есть Вы можете получить статус «COMPLETE», а следующим запросом — «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br>

=== Передача только изменившихся статусов ===
В нашем API предусмотрено удобное средство получения статусов всех заказов, без необходимости «бомбить» сервер запросами статусов по каждому заказу. Работает это так: раз, например, в 10 минут, вы посылаете запрос «покажите все изменившиеся статусы». Пример запроса ниже. Система вам отдает ВСЕ заказы, статусы (или некоторые другие поля, см. ниже) которых изменились с момента последнего запроса. Вы разбираете полученный документ, по каждому заказу сохраняете его актуальный статус в своей системе, и если все хорошо, у вас все получилось, ваша система неожиданно не упала от наплыва информации, посылаете нам запрос подтверждения получения статусов (commitlaststatus). Мы у себя отмечаем, что эти статусы вами получены и их не надо передавать повторно. Таким образом, сколько бы заказов у вас ни было, статусы по ним всем почти в реальном времени вы можете получать всего двумя запросами.

Для получения только изменившихся статусов отправьте запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<streamid>1234</streamid>
</statusreq>
</source>

Система выдает все заказы, в которых с момента последнего запроса в этом режиме изменилось хотя бы одно из полей:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<streamid>1234</streamid>
</commitlaststatus>
</source>

'''Описание полей запроса'''

* '''auth''' — авторизация. Обязательный элемент.
* '''streamid''' — идентификатор потока. Если у вас несколько интеграций и каждая нуждается в получении статусов, вы можете передавать данный параметр и тем самым разделять получение и отметку об успешном получении статусов по заказам. Значение должно входить в промежуток от 100 до 10000, включительно. Необязательный элемент.
* '''client''' — признак клиента или агента. Необязательный элемент.
:* CLIENT — признак клиента, значение по умолчанию
:* AGENT — признак агента. В ответ отдается информация по заказам, переданным агенту на доставку

В случае успеха вы получите ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus error="0">OK</commitlaststatus>
</source>

Такой способ передачи статусов гарантирует полную корректную передачу статусов, даже если в нашей системе статус изменился между запросом статусов и подтверждением их получения. Если система не получила подтверждение передачи статуса, она будет считать информацию непереданной и выдаст ее при повторном запросе.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
# При этом способе передачи (<changes>ONLY_LAST</changes>) система просматривает заказы, оформленные за последние 3 месяца. Если заказ сделан ранее, изменение статуса по нему не попадет в результат выполнения запроса.
# Система всегда выдает текущий статус. Вы можете одним запросом получить статус «NEW», а следующим — «COMPLETE». Между запросами отправление могло пройти через несколько промежуточных статусов. Если нужна гарантия получения всех промежуточных статусов, нужно анализировать блок statushistory (может не заполняться вследствие ограничений версии или тарифа конкретной службы доставки).
# Система не гарантирует последовательность прохождения заказом набора статусов. Вы можете получить статус «COMPLETE», а следующим запросом «NEW» — такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br>

=== Лимитирование запросов ===
Дает возможность получить не все измененные заказы, а только какое-то определенное количество. Помогает на случай, если у вас скопилось очень много измененных заказов и нужно их грузить лимитировано. После успешной обработки получнных заказов, '''обязательно''' нужно вызвать commitlaststatus с кодами обработанных заказов.

'''Пример'''

Для получения ограниченного числа изменившихся заказов отправьте запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<limit>5</limit>
</statusreq>
</source>

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<acs>
<ac>11111</ac>
<ac>22222</ac>
<ac>33333</ac>
<ac>44444</ac>
<ac>55555</ac>
</acs>
</commitlaststatus>
</source>

* '''acs''' — контейнер. Обязательный элемент.
* '''ac''' — атрибут''' ordercode''' контейнера '''order''' полученного на этапе запроса '''statusreq'''.

Помимо приведенных в примере параметров, вы также можете передавать и остальные, описанные ранее, например '''streamid'''.

== Трекинг заказа по номеру ==
Запрос трекинга по номеру предназначен для выдачи минимальной обезличенной информации о конкретном заказе не авторизованному пользователю. Наша система имеет для этого интерфейс по адресу «home.courierexe.ru/{код экстра}/tracking». Вы можете либо сделать ссылку на такую страницу на своем сайте, либо разместить ее [[#Размещение страниц на своем сайте (iframe)|iframe’ом]] у себя, либо сделать свою и пользоваться нашим API. Этот интерфейс создан специально для выдачи информации живому пользователю сайта. Для получения статусов заказов в свою информационную систему нужно использовать запрос «statusreq», желательно с параметром changes=ONLY_LAST!

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<order orderno="111111" ordercode="12345">
<barcode>111111</barcode>
<AWB>111111</AWB>
<sender>
<town code="1" country="RU">Москва город</town>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<zipcode>125480</zipcode>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<paytype>CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</return_service>
<return_date></return_date>
<return_time></return_time>
<return_message></return_message>
<waittime>12</waittime>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<deliveryprice total="158.6" delivery="100.00" return="58.6" />
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<outstrbarcode>EXT123456</outstrbarcode>
<items>
<item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" VATrate="0" barcode="2345625213125" article="1" returns="0" origincountry="040" GTD="" excise="0.00" governmentCode="11223311" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
<acquirers>
<acquirer code="2" name="Ibox"/>
<acquirer code="5" name="Payme"/>
<acquirer code="6" name="Click"/>
</acquirers>
</order>
</tracking>
</source>

где,
* '''acquirers''' / '''acquirer''' - эквайринг, доступный для получения ссылки на оплату заказа
** '''acquirers''' / '''acquirer''' / ''code'' - внутренний код эквайринга
** '''acquirers''' / '''acquirer''' / ''name'' - наименование эквайринга

'''Получение информации в формате 17 TRACK'''

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking17>
<extra>8</extra>
<orderno>1234</orderno>
</tracking17>
</source>

'''Пример ответа:'''
<pre>{
"number":"ExtNumber",
"oriNumber":"1234",
"oriCountry":"RU",
"destCountry":"RU",
"status":"Complete",
"events":[
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Complete"
},
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Courierdelivered"
},
{
"time":"2016-06-02 09:17:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Delivery"
},
{
"time":"2016-06-02 07:41:00",
"location":"RU",
"town":"Москва",
"store":"Москва Главный",
"content":"Accepted"
},
{
"time":"2016-06-01 19:53:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"Departure"
},
{
"time":"2016-06-01 17:38:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"Departuring"
},
{
"time":"2016-05-30 10:20:00",
"location":"RU",
"town":"Горький",
"store":"Горький Автозавод",
"content":"New"
}
]
}</pre>

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.<br>
Описание контейнеров ответа аналогично описанию [[API#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81 .D1.81.D1.82.D0.B0.D1.82.D1.83.D1.81.D0.B0 .D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.BE.D0.B2|Запроса статусов заказов]].

=== Получение ссылки для оплаты заказа ===

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
Этим методом вы можете только получить ссылку на оплату. Фискализация этого платежа идет отдельным процессом. По его возможности уточняйте в службе поддержки.
</div>

Заказ доступен для оплаты, если:
* тип оплаты заказа не наличными, а например картой или по договору, альтернативой может стать установка параметра "Спрашивать тип оплаты" в карточке клиента.
* заказ имеет наложенный платеж
* не оплачен
* активен (не доставлен, не возвращен в т.ч. курьером)

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<acqlink>
<extra>8</extra>
<acq>
<code>2</code>
</acq>
<order>
<code>12345</code>
</order>
</acqlink>
</source>

где
*'''extra''' - код экстраклиента в системе Measoft.
*acq.'''code''' - внутренний код платформы эквайринга в системе Measoft. (известен в МП из [https://wiki.courierexe.ru/index.php/API#.D0.A2.D1.80.D0.B5.D0.BA.D0.B8.D0.BD.D0.B3_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0_.D0.BF.D0.BE_.D0.BD.D0.BE.D0.BC.D0.B5.D1.80.D1.83 Трекинга])
*order.'''ordercode''' - внутренний код заказа, типа ''int'', уникальный в пределах экстраклиента

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<acqlink error="0" amount="2000" extid="161083231">https://qr.nspk.ru/AD10001A7GLVGA9YDO2I0789SIOPV3?type=02&bank=1000011&sum=2000&cur=RUB&crc=7E9C</acqlink>
</source>

где
*'''acqlink''' - ссылка на оплату заказа
*acqlink.'''amount''' - тип integer сумма платежа в копейках в общем случае, в других случаях в соответствии с типом валюты
*acqlink.'''extid''' - идентификатор счета на стороне платежной системы
*acqlink.'''error'' - код ошибки, если отличается от 0, означает невозможность получения ссылки на оплату, в этом случае ссылки на оплату не будет и ответ будет выглядеть так:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<acqlink error="2" message="Ошибка авторизации: Invalid token" amount="2000" extid=""/>
</source>

где
*acqlink.'''message''' - текст ошибки возвращаемой эквайрингом

Возможные типы ошибок получения ссылки:
* '''1''' - не настроен эквайринг, либо не найден заказ
* '''2''' - ошибка на стороне эквайринга
* '''3''' - запрещающий статус курьера (заказ доставлен, частично доставлен)
* '''4''' - оплата заказа не разрешена

== Изменение заказа ==
Запрос предназначен для изменения заказов.

Изменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Чтобы разрешить изменение заказов, в личном кабинете курьерской службы перейдите в '''Настройки''' > '''Заказы''' и в разделе '''Отмена и редактирование''' установите флажок '''Разрешить отмену и изменение заказов'''. Вы также можете пометить в списке '''Статусы для отмены и редактирования заказов''' галками статусы корреспонденции, для которых возможны отмена и изменение заказов. По умолчанию (когда в этом списке ничего не выбрано) редактирование и отмена разрешены для статуса «Новый»

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут.
</div>

При редактировании заказа может быть отменен запланированный курьер. Это зависит от значения переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Автоматически устанавливать заплан. курьера по району''':
* '''Нет''' — при редактировании заказа по АПИ курьер не изменяется;
* '''Район''' — если изменен адрес доставки, курьер сбрасывается;
* '''Район или дата план. доставки''' — если изменен адрес доставки или плановая дата вручения, курьер сбрасывается.

=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:

* значение '''orderno''' данным методом изменить нельзя.
* значение '''barcode''' изменяется в случае явного его указания. В случае отсутствия или пустого значения - остается прежним.
* вместо корневого тэга '''neworder''' указывается '''editorder''';
* тэг курьера '''courier''' можно изменить только при включенной настройке '''Разрешить изменение курьера по АПИ''';
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.
* для мест '''package''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

Необходимо иметь в виду, что:

# Заказ нельзя изменить, пока он не синхронизирован с системой (пока предыдущие изменения не переданы в бэк-офис)
# Удаление вложений и мест выполняется не моментально, а в процессе синхронизации с бэк-офисом (для записей указываются метки Удалено)

=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==
Запрос предназначен для отмены заказов.

Отменять заказы могут курьерские службы с тарифами «Премиум» и «Максимум». Разрешения для отмены заказов и статусы в которых заказы можно отменять описаны в разделе '''Изменение заказов'''

При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

'''Пример запроса отмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<auth extra="8" login="login" pass="pass" />
<order orderno="" ordercode="123456" />
<order orderno="123aaa" ordercode="" />
</cancelorder>
</source>

'''Описание полей:'''

'''cancelorder''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''order''' — Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибуты:
:* '''''orderno''''' — Шифр заказа.
:* '''''ordercode''''' — Внутренний код заказа.
Обратите внимание, что должен быть указан хотя бы один из атрибутов ''orderno'' или ''ordercode''!

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<order orderno="123test" ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
<order orderno="123aaa" ordercode="" error="52" errormsg="order not found" errormsgru="Заказ не найден" />
</cancelorder>
</source>

== Добавление вложений к накладной ==

Метод позволяет прикрепить файлы к корреспонденции.
Размер загружаемого файла не должен превышать 1 Мб.

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<addattachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
<attachments>
<item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</addattachments>
</source>

'''Описание полей:'''

'''addattachments''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''orderno''' — Номер заказа. Обязательный элемент. Может использоваться тэг <ordercode> с указанием внутреннего кода заказа.
* '''attachments''' — Обязательный элемент, в котором перечисляются передаваемые данные файлов.
** '''item''' — Бинарные данные (файл), закодированные в base64. Обязательный элемент.
*** '''name''' — Атрибут элемента '''item''', в котором передается имя файла. Обязательный элемент.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachments>
<attachments>
<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
</attachments>
</addattachments>
</source>

== Получение вложений к накладной ==
'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
</attachments>
</source>

'''Описание полей:'''

'''attachments''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''orderno''' — Номер/код заказа. Обязательный элемент.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachments>
<item name="doc1.docx" timestamp="2025-01-01 12:00:00" size="35654">JVBERixLjMN
UwLJdLwIDKxTn+AScMjKqor7Xm3sp1yj1k6BzlPdX2Qsiit6yg3g1fCI4YVAgclUOIY5tDra2LvAcIS
5/+8PsL/sXb0+aoper/9kL/4Ov/YE9QsHwyg7YZTtKICy0YVIYb4Nt7L1tPUMfaX9NpuTsvFCtBAvYG
eJVZoZ2tm6+fZVqAavZpeLizVLtct1a+xvG0+bTSkw3Ac8PhdNfL4smrT2hSgPJLfyaVGyA2ndyW22t
sFtTP5knktPNumSZ56QsFRPJkaU8ExDxAcMYMDIoBiIoR4/dDjHMbMW/EW4fiB1pvWmV2ONWIl1Xdub
Xg1ob0qWX9W4qagsqzGhjRLsEGeJGVXg9oVC+XkJa9esrhGUmC0tuKEla+AplVO/OtHwXcW0FWui1z7
6KHrtobuWV0xa9sCEiSvb91w3ePHOvfcveo5xt9o4ZevHF7ZOeKxV5qmVx2MI44a1L+Mhk5YuGT12xd
Ibsb7r+j9bff/unQlv0al6HBnoD5G89q4+tkjgDtvwwARmqm2aa2Jgvmth8mrXquTNtl2u467vbF/5r
vnMt9uesu21Me1bjeNJGlVfAaCtw+/jfenJ/fWjqa7ygExx+L0BcTGroxrKexQXIQ1ImfEW7ZRJZa+O
ip7xJmmNESMxrgu/dquBbGypjJpFDJVRH1rVPR1Ifl4aFS5IEdDWZFSdyBBWKWhVSVu517ZgzOCFAwp
wwbFph29g4fTaxnvn/3X78x+Tt56ZNffArgULt+HByvy7+yz6U6XWMawCi3+6gJXN0S+jf4t+HT34wg
km7/HDp55YTSWMoCMgZsvZkBrXtIv4WA7xgkT4YpYpxjwLvnsWKkGE+pDbxER0UUWlpVFRY4oilTfM4
MIzgCPgxjOlZ87ceA7ceRJrgpipFGyugPQ4OTI2S8lWJoqTpHJlJbNOeYM7zTcoVxSNyJXiYWSAMklT
q/xd+3fd3/USq2V1rJ7RyBLHsuDSiLwgaOFc5LUCRGI+QWuBAsIwPlZrgRpSMseJyTzD15PKiIRE7bc
Rggk5ijXAPpqISetD4wVm0AD2LHuBZdaxmK3HOKIZoG0QLmiZdVqspXnFIJwVyCKhWiDCI4bzH8Y76w
TAnwM67HIqMISOkmJXY8mlYhpiNa7g2oTBkKxo4wgnvETQIUUrlFOn9KdOreDiKQx071rN4N61yRAi1
7EGRhSOgoeLYv+k41+KZ1SVBXAuDjB+xuxnQmm8wJDcP5IRn+5penzbR/ivm7qleHK5o790w8ejXchI
vOHIPWtWwYhtAO34LdDXqFqWxZEBLNstMCwwITBTWirxk12zuUppp</item>
</attachments>
</source>

В тегах item возвращаются бинарные данные (файлы), закодированные в base64.

== Изменение статуса агентом ==
Запрос изменения статуса заказа позволяет установить окончательный статус заказа — «Доставлен» или «Не доставлен (Возврат/Отмена)».

Кроме этого, устанавливается дата и время (при необходимости) изменения статуса, а также сообщение в поле ''Инфо о доставке''.

При необходимости к заказу можно прикрепить изображения.

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456">
<message>Получил Иванов</message>
<outstrbarcode>7654312</outstrbarcode>
</order>
<order ordercode="234567">
<status>PICKUPREADY</status>
<eventtime>2016-05-30 10:20:00</eventtime>
<message>Клиент отказался от покупки</message>
<paytype>CASH</paytype>
<storeprice>123</storeprice>
<items>
<item code="34533" quantity="1" reason="0" governmentCode="11223311" />
<item code="34456" quantity="0" reason="0" />
<item code="34421" quantity="2" reason="0" />
</items>
<attachments>
<attachment filename="filename1.jpg"> /9j/4AAQSkZJRgA
BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
PT09PT0//wAARCAYACAADAS IA</attachment>
<attachment filename="filename2.jpg"> /9j/4AAQSkZJRgA
BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
PT09PT0//wAARCAYACAADAS IA</attachment>
</attachments>
</order>
</setorderinfo>
</source>

'''Описание полей запроса статуса:'''

'''setorderinfo''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''order''' — Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера '''order'''. Атрибут '''''ordercode''''' — внутренний код заказа.
* '''status''' — Новый статус заказа. Доступны статусы из раздела [[#Описание полей ответа статусов]], кроме AWAITING_SYNC и NEW.
* '''eventtime''' — Дата и время изменения статуса. Обязательно при указании статуса.
* '''message''' — Текст сообщения ''Инфо о доставке''.
* '''outstrbarcode''' — код у подрядчика (код заказа во внешней системе). Используется в интеграциях с внешними системами.
* '''paytype''' — Тип оплаты заказа. Допустимые значения CASH/CARD.
* '''storeprice''' — Агентское вознаграждение.
* '''items''' — Контейнер для описания вложений '''item''' . Атрибуты:
:* '''''code''''' — Код вложения.
:* '''''quantity''''' — Количество доставленных единиц вложения.
:* '''''reason''''' — Причина недоставки, выбирается из соответствующего списка статусов.
:* '''''governmentCode''''' — Указание кода ТН для вложения при необходимости.
* '''attachments''' — Контейнер прикрепляемых изображений. Может содержать несколько контейнеров '''attachment'''
:* '''attachment''' — Контейнер изображения. Содержит текст файла изображения, закодированный по стандарту ''base64''. Атрибут:
::* '''''filename''''' — Имя файла.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo>
<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />
</setorderinfo>
</source>

== Получение документов для печати ==
'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybill>
<auth extra="8" login="login" pass="pass" />
<client>CLIENT</client>
<orders>
<order orderno="1234567" ordercode="33331" />
<order orderno="1234568" ordercode="33332" />
</orders>
<form>1</form>
<start>5</start>
<integration>21</integration>
</waybill>
</source>

'''Описание полей:'''

'''waybill''' — Корневой контейнер. Обязательный элемент
* '''auth''' — Авторизация. Обязательный элемент
* '''client''' — Признак клиента или агента. Необязательный элемент.
:* CLIENT — Признак клиента, значение по умолчанию
:* AGENT — Признак агента. В ответ отдается информация по заказам, переданным агенту на доставку
* '''orders''' — Список заказов для получения печатных форм. Содержит тэги '''order''' с атрибутами:
:* '''''orderno''''' — шифр заказа
:* '''''ordercode''''' — внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут '''''ordercode'''''
* '''form''' — Формат накладной. Не обязательный элемент. Принимает значения:
:* 1 — Подробная накладная (по-умолчанию)
:* 2 — Наклейки Zebra
:* 3 — Наклейки на страницу формата А4
:* 4 — Акты приема-передачи
* '''start''' — Имеет смысл только для form = 3. Начальная позиция первой наклейки. Используется для пропуска наклеек на листе для их экономии.
* '''integration''' - Получение наклеек от подрядчика. Не обязательный элемент, имеет смысл при наличии кода подрядчика в карточке заказа. Принимает значение:
:* 21 - подрядчик GTD

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<integration code="21">
<order code="33331">
<content>JVBERi0xLjYNJeLjz9MNC...</content>
</order>
<order code="33332">
<content>JVBERi0xLjYNJeLjz9MNC...</content>
</order>
</integration>
<content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw
IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG
mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM
4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00
79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q
mqqvp9p2E7T0/wiFemv8uG6 OM</content>
</waybill>
</source>

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.
При записи в файл необходимо использовать двоичный формат записи!

Блок integration содержит отдельные наклейки для заказов, предоставленные подрядчиком, так же закодированные в base64.

'''Обратите внимание''' Лимит количества при единовременном получении печатных форм - 1000 штук. Если нужно получить больше - делайте это несколькими запросами.

'''Обратите внимание''' Печатные формы для заборов не формируются.

'''Пример ответа с ошибкой:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<error>Текст ошибки</error>
</waybill>
</source>

== Справочник городов ==
'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<auth extra="8" />
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namecontainsparts>молоково моск</namecontainsparts>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

* '''auth''' — Авторизация, необязательный элемент. Используется в случае включенного и настроенного ограничения по населенным пунктам в конкретной курьерской службе.

* '''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.
:* '''zipcode''' — Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.
:* '''kladrcode''' — Поиск по 13-ти значному коду КЛАДР.
:* '''fiascode''' — Поиск по коду ФИАС (AOGUID).
:* '''code''' — Поиск по коду в системе.

* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''city''' — Поиск по всем населенным пунктам региона.
:* '''namecontainsparts''' — Поиск населенных пунктов, название которых содержит все указанные слова, с разбиением поисковой фразы через пробел. Например "моск моло" найдет деревню "Молоково" в Московской области.
:* '''namecontains''' — Поиск населенных пунктов, название которых содержит указанный текст.
:* '''namestarts''' — Поиск населенных пунктов, название которых начинается с указанного текста.
:* '''name''' — Поиск населенных пунктов, название которых соответствует указанному тексту.
:* '''fullname''' — Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.
:* '''country''' — Поиск только по стране с указанным внутренним кодом или текстовым кодом в соответствии [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» для России.

* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.
:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.
:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываются totalcount и totalpages.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>
<kladrcode>2300000700000</kladrcode>
<shortname /> (not yet supported)
<typename /> (not yet supported)
<coords lat="43.5855" lon="39.7231" />
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>
<kladrcode>3201900011100</kladrcode>
<shortname />
<typename />
<coords lat="52.6407" lon="33.1724" />
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>
<kladrcode>6001900015400</kladrcode>
<shortname />
<typename />
<coords lat="56.6003" lon="29.3542" />
</town>
</townlist>
</source>

В ответе города сортируются по популярности, важности (районные центры и т. д.), и только затем — по алфавиту.

== Справочник регионов ==
'''Пример запроса справочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist>
<codesearch>
<code>77</code>
</codesearch>
<conditions>
<namecontains>край</namecontains>
<namestarts>Моск</namestarts>
<fullname>Московская область</fullname>
<country>RU</country>
</conditions>
</regionlist>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2">
<city>
<code>80</code>
<country>
<code>1</code>
<name>Россия</name>
<id>643</id>
<ShortName1>RU</ShortName1>
<ShortName2>RUS</ShortName2>
</country>
<name>Агинский Бурятский автономный округ</name>
</city>
<city>
<code>1</code>
<country>
<code>1</code>
<name>Россия</name>
<id>643</id>
<ShortName1>RU</ShortName1>
<ShortName2>RUS</ShortName2>
</country>
<name>Адыгея республика</name>
</city>
</regionlist>
</source>

== Справочник улиц ==
'''Пример запроса справочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist>
<conditions>
<town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!
<namecontains>Хохло</namecontains>
<namestarts>Академика Х</namestarts>
<name>Академика Хохлова</name>
<fullname>Академика Хохлова ул.</fullname>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</streetlist>
</source>

* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''town''' — Обязательное поле. Название или код населенного пункта.
:* '''namecontains''' — Поиск улиц, название которых содержит указанный текст.
:* '''namestarts''' — Поиск улиц, название которых начинается с указанного текста.
:* '''name''' — Поиск улиц, название которых соответствует указанному тексту.
:* '''fullname''' — Поиск улиц, для которых название вместе с типом соответствует указанному тексту.

* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.
:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 10000.
:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено, в ответе не указываются totalcount и totalpages.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist count="1" page="1" totalcount="3" totalpages="1">
<street>
<code>124</code>
<name>Академика Хохлова ул.</name>
<shortname>Академика Хохлова</shortname>
<typename>ул.</typename>
</street>
</streetlist>
</source>

В ответе улицы сортируются по алфавиту.

== Справочник номенклатуры ==
'''Пример запроса справочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlist>
<auth extra="8" login="login" pass="pass"></auth>
<codesearch>
<code>123456</code>
<article>FD343</article>
<barcode>2345625213125</barcode>
</codesearch>
<conditions>
<namecontains>телевизор</namecontains>
<namestarts>sony</namestarts>
<name>Sony KDL-55W905 ЖК-телевизор</name>
<quantity>EXISTING_ONLY</quantity>
<store>2</store>
</conditions>
<except>
<code>123478</code>
</except>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</itemlist>
</source>

Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.
* '''codesearch''' — Поиск по кодам. В случае использования — контейнеры conditions и limit игнорируются.
:* '''code''' — Поиск по внутреннему коду системы.
:* '''article''' — Поиск по артикулу.
:* '''barcode''' — Поиск по штрихкоду.

* '''conditions''' — Задает условия поиска. Все вложенные элементы одновременно накладывают условие «И».
:* '''namecontains''' — Поиск товаров, название которых содержит указанный текст.
:* '''namestarts''' — Поиск товаров, название которых начинается с указанного текста.
:* '''name''' — Поиск товаров, название которых соответствует указанному тексту.
:* '''quantity''' — Наличие на складе. Принимает значения EXISTING_ONLY — Только в наличии, NOT_EXISTING_ONLY — Только не в наличии, ALL — Все. ''Это поле может быть недоступным в некоторых установках.''
:* '''store''' — Поиск товаров по определенному складу.

* '''except''' — Описание исключений для корректного определения количества зарезервированной номенклатуры.
:* '''code''' — Код заказа.

* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ.
:* '''limitcount''' — Задает количество записей результата, которые нужно вернуть.

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1">
<item>
<code>123456</code>
<article>FD343</article>
<barcode>2345625213125</barcode>
<name>Sony KDL-55W905 ЖК-телевизор</name>
<retprice>65000</retprice>
<purchprice>50000</purchprice>
<weight>5.1</weight>
<length>50</length>
<width>30</width>
<height>40</height>
<VATrate>20</VATrate>
<CountInPallet>30</CountInPallet>
<CountInBox>2</CountInBox>
<HasSerials>1</HasSerials>
<CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported)
<Message>Хороший телевизор</Message>
<Message2>Снова хороший телевизор</Message2>
<quantity>12</quantity>
<reserved>3</reserved>
<item>
...
</itemlist>
</source>

'''Описание полей:'''
* '''code''' — Внутренний идентификатор, присвоенный системой.
* '''article''' — Артикул, назначенный клиентом (поставщиком).
* '''barcode''' — Штрихкод производителя.
* '''name''' — Наименование.
* '''retprice''' — Розничная цена по-умолчанию. При оформлении заказа цена используется та, которая указана в заказе.
* '''purchprice''' — Закупочная цена.
* '''weight''' — Масса в килограммах.
* '''length''' — Длина в сантиметрах.
* '''width''' — Ширина в сантиметрах.
* '''height''' — Высота в сантиметрах.
* '''VATrate''' — Ставка НДС, целое число процентов.
* '''CountInPallet''' — Количество штук в паллете.
* '''CountInBox''' — Количество штук в упаковке.
* '''HasSerials''' — Требует учета серийных номеров. Принимает значения 1 — да, 0 — нет.
* '''CountryOfOrigin''' — Наименование страны происхождения на русском языке.
* '''Message''' — Комментарий.
* '''Message2''' — Дополнительный комментарий.
* '''quantity''' — Количество на складе. Товары, уже собранные в заказы в этом количестве не присутствуют, считаются покинувшими товарный склад. ''Это поле может быть недоступным в некоторых установках.''
* '''reserved''' — Количество зарезервированного товара. Может превышать остаток на складе, если покупатели ждут следующей поставки. ''Это поле может быть недоступным в некоторых установках.''

== Движение номенклатуры ==
'''Пример запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements>
<auth extra="8" login="login" pass="pass"></auth>
<code>4259</code>
<datefrom>2020-10-01</datefrom>
<dateto>2020-10-02</dateto>
</itemmovements>
</source>

* '''code''' — внутренний код товара в справочнике номенклатуры.
* '''datefrom''' — дата начала периода.
* '''dateto''' — дата окончания периода.
Может быть указан или код, или период, или код и период одновременно.

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements count="16">
<itemmovement>
<code>151500</code>
<date>2017-05-26</date>
<retprice>0</retprice>
<quantity>1</quantity>
<delivered>0</delivered>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
</item>
<status>
<code>5</code>
<name>Возврат от покупателя</name>
</status>
<store>
<code>1</code>
<name>офис в Москве</name>
</store>
<order>
<ordercode>3374830</ordercode>
<number>123660-0</number>
<date>2017-05-24</date>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<company>ТОВАР</company>
<address>Кравченко ул., 1</address>
<delivereddate>2017-05-29</delivereddate>
<deliveredtime>12:00:00</deliveredtime>
<deliveredto />
</order>
<document>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
</document>
<serials>
<serial>123456789</serial>
</serials>
</itemmovements>
</itemlist>
</source>

''' Описание полей ответа '''
* '''code''' — внутренний код операции движения
* '''date''' — дата операции
* '''retprice''' — цена товара
* '''quantity''' — количество товара операции
* '''delivered''' — количество доставленного товара

* '''item''' — контейнер товара
:* '''code''' — внутренний код товара
:* '''name''' — наименование товара

* '''status''' — контейнер статуса операции
:* '''code''' — код статуса
:* '''name''' — наименование

* '''store''' — контейнер филиала, к которому относится операция
:* '''code''' — код филиала
:* '''name''' — наименование филиала

* '''order''' — контейнер корреспонденции
:* '''ordercode''' — внутренний код заказа
:* '''number''' — номер заказа
:* '''date''' — дата заказа
:* '''orderno''' — шифр
:* '''barcode''' — штрихкод
:* '''company''' — компания
:* '''address''' — адрес
:* '''delivereddate''' — дата вручения
:* '''deliveredtime''' — время вручения
:* '''deliveredto''' — данные о вручении, либо причина недоставки

* '''document''' — контейнер документа операции
:* '''code''' — внутренний код документа
:* '''number''' — номер документа
:* '''extnumber''' — внешний номер документа
:* '''date''' — дата документа
:* '''message''' — комментарий

* '''serials''' — контейнер серийных номеров
:* '''serial''' — серийный номер единицы номенклатуры, участвующей в движении

== Серийные номера ==
'''Пример запроса движения номенклатуры с серийным номером:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<serialmovements>
<auth extra="8" login="login" pass="pass"></auth>
<serial>123456789</serial>
</serialmovements>
</source>

* '''serial''' — серийный номер единицы номенклатуры.

'''Пример ответа движения номенклатуры с серийным номером:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<serialmovements count="16">
<serialmovement>
<code>151500</code>
<serial>123456789</serial>
<date>2017-05-26</date>
<delivered>0</delivered>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
</item>
<status>
<code>5</code>
<name>Возврат от покупателя</name>
</status>
<order>
<ordercode>3374830</ordercode>
<number>123660-0</number>
<date>2017-05-24</date>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<company>ТОВАР</company>
<address>Кравченко ул., 1</address>
<delivereddate>2017-05-29</delivereddate>
<deliveredtime>12:00:00</deliveredtime>
<deliveredto />
</order>
<document>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
</document>
</serialmovement>
</serialmovements>
</source>

''' Описание полей ответа '''

Описание аналогично описанию полей [[#Движение номенклатуры|движения номенклатуры]]

== Серийные номера по заказу ==
'''Пример запроса движения серийных номеров заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<orderserials>
<auth extra="8" login="login" pass="pass"></auth>
<ordercode>123456789</ordercode>
<orderno>123456789</orderno>
<barcode>123456789</barcode>
</orderserials>
</source>

* '''ordercode''' — внутренний код заказа.
* '''orderno''' — шифр заказа.
* '''barcode''' — штрих-код заказа.
Указывать необходимо один из идентификаторов заказа.

'''Пример ответа движения серийных номеров заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<orderserials>
<order>
<code>3374830</code>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<delivereddate>2024-07-20</delivereddate>
<deliveredtime>10:04:00</deliveredtime>
<assemblydate>2024-07-19 07:05:34</assemblydate>
</order>
<items>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
<article>123000</article>
<state>Delivered</state>
<serials>
<serial>123456789</serial>
</serials>
</item>
</items>
</orderserials>
</source>

''' Описание полей ответа '''

* '''order''' — блок заказа:
:* '''code''' — код
:* '''orderno''' — шифр
:* '''barcode''' — штрих-код
:* '''delivereddate''' — дата доставки факт
:* '''deliveredtime''' — время доставки факт
:* '''assemblydate''' — дата сборки

* '''item''' — блок товара:
:* '''code''' — код
:* '''name''' — наименование
:* '''article''' — артикул
:* '''state''' — статус Доставлено (Delivered) или Возвращено (Returned)
:* '''serials''' — блок серийных номеров по заказу

== Получение справочника тарифов по городам ==

'''Пример запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs>
<auth extra="8" login="login" pass="pass" />
<townfrom>Москва</townfrom>
<service>1</service>
<mainonly>1</mainonly>
</tariffs>
</source>

* '''auth''' — атрибут '''extra''' обязателен, по нему определяется курьерская служба.
* '''townfrom''' — город-отправитель. Если не передан, то городом будет «Москва».
* '''service''' — режим доставки. Обязательный элемент.
* '''mainonly''' — необязательный элемент. Если передан, то в ответе будут данные только по городам из справочника '''Межгород''' > '''Зоны'''.

Важно понимать, что в ответе отдаются только тарифы, указанные в разделе "Тарифы по зонам" раздела "Межгород" в офисной системе курьерской службы, т.е. считающихся междугородними.
Доставка до городов, рассчитываемая по внутригородским тарифам, в ответе НЕ ОТДАЕТСЯ!

'''Пример ответа справочника тарифов по городам'''
<source lang="json">
{
"townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"service": 1,
"tariffs": [
{
"towntofias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"towntocode": 1,
"towntoname": "Москва город",
"townregion": "Город Москва",
"distance": 0,
"pricedistance": 0,
"pricesnew": {
"before": [
{
"price": 100,
"every": 0,
"mass": 1
},
{
"price": 150,
"every": 0,
"mass": 5
}
],
"after": [
{
"price": 0,
"every": 1,
"mass": 38.01
},
{
"price": 15,
"every": 1,
"mass": 51.01
}
]
},
"deliveryPeriodMin": 1,
"deliveryPeriodMax": 2
}
]
}
</source>

''' Описание полей ответа '''
* '''townfrom''' — код ФИАС города-отправителя.
* '''service''' — режим доставки.
* '''tariffs''' — cписок тарифов по городу.
:* '''townregion''' — регион города-получателя.
:* '''towntofias''' — код ФИАС города-получателя.
:* '''towntocode''' — внутренний код города-получателя.
:* '''towntoname''' — наименование города-получателя.
:* '''distance''' — дистанция в км до города от МКАД, если в запросе townfrom — Москва.
:* '''pricedistance''' — сумма за километраж до города от МКАД, если в запросе townfrom — Москва.
:* '''pricesnew''' — ваши настройки тарифов из справочника '''Межгород''' > '''Тарифы по зонам'''.
::* '''before/after''' — контейнеры ДО/ОТ.
:::* '''price''' — цена. Если ответ идет по «before», то в цену также плюсуется сумма pricedistance
:::* '''every''' — за каждые.
:::* '''mass''' — масса.
:* '''prices''' — устаревший элемент, не используется.
:* '''deliveryPeriodMin''' — минимальный срок доставки.
:* '''deliveryPeriodMax''' — максимальный срок доставки.

== Номенклатура приходной накладной ==
'''Пример запроса номенклатуры приходной накладной:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
<auth extra="8" login="login" pass="pass"></auth>
<code>21991</code>
</itemdoc>
</source>

* '''code''' — внутренний код документа приходной накладной (см. предыдущий запрос).

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
<items>
<item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item>
</items>
</itemdoc>
</source>

''' Описание полей ответа '''
* '''code''' — внутренний код приходной накладной
* '''number''' — номер документа
* '''date''' — дата документа
* '''message''' — комментарий

* '''item''' — контейнер товара
:* '''code''' — внутренний код товара
:* '''barcode''' — штрихкод товара
:* '''article''' — артикул товара
:* '''quantity''' — количество поступившего товара

== Справочник филиалов ==
'''Пример запроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist>
<auth extra="8"></auth>
<json>YES</json>
<client_code>7890</client_code>
</storelist>
</source>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба
* '''json''' — Признак вывода ответа в виде JSON YES/NO
* '''client_code''' — Код клиента курьерской службы

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist count="2">
<store>
<code>123</code>
<name>ABC</name>
</store>
<store>
<code>456</code>
<name>Филиал 2</name>
</store>
</storelist>
</source>

* '''code''' — Код филиала.
* '''name''' — Наименование филиала.

== Справочник пунктов самовывоза ==
Для отображения списка пунктов выдачи (ПВЗ) есть '''готовый JavaScript модуль''': https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию — внутри. Посмотреть пример работы можно [https://home.courierexe.ru/pvz_test.html Здесь]

Уникальные запросы списка ПВЗ кешируются на стороне личного кабинета и хранятся до 7 часов утра по московскому времени следующего дня. Например, если уникальный запрос с массой 2 кг был отправлен сегодня в 10 часов, то завтра в 7 утра он сбросится. Если сегодня в 18 часов в этом же запросе вы укажете массу 2 кг, в ответе вернется тот же список ПВЗ. Если передадите массу 3 кг, список может быть другим.

Обратите внимание, что если в выборке количество ПВЗ больше '''10000''' и не указаны параметры '''code''', '''json''' или '''limitcount''', то будет возвращаться ошибка. В этом случае необходимо использовать блок '''limit'''.

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<code>1234</code>
<client_code>7890</client_code>
<city>Свердловская область</city>
<town regioncode="66" country="RU">Нижний Тагил</town>
<address>Щёлковское шоссе</address>
<house>77</house>
<advanced_search>Строка поиска</advanced_search>
<parentcode>6</parentcode>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<maxweight>30</maxweight>
<acceptindividuals>YES</acceptindividuals>
<respstores>YES</respstores>
<lt>57.924737</lt>
<lg>59.940019</lg>
<rt>57.905682</rt>
<rg>59.984669</rg>
<json>YES</json>
<with_coords>YES</with_coords>
<limit>
<limitfrom>30</limitfrom>
<limitcount>2</limitcount>
<countall>YES</countall>
</limit>
</pvzlist>
</source>

* '''auth''' — Атрибут '''extra''' — обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.
* '''code''' — Внутренний код, целое число.
* '''client_code''' — Код клиента курьерской службы.
* '''city''' — Регион получателя. Можно указать код региона или полное наименование региона из [[#Справочник регионов|справочника регионов]].
* '''town''' — Город получателя.
Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

Также можно указать страну получателя в атрибуте '''''country''''' в соответствии с [https://ru.wikipedia.org/wiki/ISO_3166-1 стандартом ISO_3166-1], например, «RU», «RUS» или «643» для России.
Для формата запроса JSON фильтрация по городу работает только в связке с фильтром по адресу.

* '''address''' — Фильтр по адресу, работает только в связке с фильтром по городу
* '''house''' — Фильтр по номеру дома, работает только в связке с фильтрами по адресу и городу
* '''advanced_search''' — Фильтр по коду агента, наименованию, телефону или комментарию
* '''parentcode''' — Фильтр по родительскому [[#Справочник филиалов|филиалу]]
* '''acceptcash''' — Фильтр по приему наличных YES/NO
* '''acceptcard''' — Фильтр по приему банковских карт YES/NO
* '''acceptfitting''' — Фильтр по наличию примерки YES/NO
* '''maxweight''' — Фильтр по максимальному весу, с которым работает ПВЗ
* '''acceptindividuals''' — Фильтр по доступности физическим лицам YES/NO
* '''respstores''' - Признак вывода ответственных филиалов при значении YES
* '''lt''' — Широта левого верхнего угла
* '''lg''' — Долгота левого верхнего угла
* '''rt''' — Широта правого нижнего угла
* '''rg''' — Долгота правого нижнего угла
* '''json''' — Признак вывода ответа в виде JSON YES/NO
* '''with_coords''' — Признак вывода ПВЗ только с наличием координат YES/NO
* '''limit''' — Ограничивает вывод результата.
:* '''limitfrom''' — Задает номер записи результата, начиная с которой выдавать ответ. По-умолчанию — 0.
:* '''limitcount'''- Задает количество записей результата, которые нужно вернуть. По-умолчанию — 100.
:* '''countall''' — YES указывает на необходимость подсчета общего количества найденных совпадений. Это может замедлять выполнение запроса. Если отключено — в ответе не указываeтся totalcount.

'''Пример ответа справочника пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2" totalcount="40465">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Новый пункт доставки</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>
<maxweight>10</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93457</latitude>
<longitude>59.95131</longitude>
<uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Возможность примерки отсутствует</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Напротив ТЦ Пирамида</traveldescription>
<maxweight>20</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>NO</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93468</latitude>
<longitude>60.55476</longitude>
<uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid>
</pvz>
</pvzlist>
</source>

* '''code''' — Код ПВЗ в системе. Используется в запросе [[API#Оформление заказа|оформления заказов]]
* '''clientcode''' — Код ПВЗ используемый компанией-подрядчиком.
* '''name''' — Наименование ПВЗ.
* '''parentcode''' — Код родительского элемента.
* '''parentname''' — Наименование родительского элемента.
* '''town''' — Населенный пункт с кодом из [[#Справочник городов|справочника городов]], а также с кодом и наименованием региона.
* '''address''' — Адрес ПВЗ.
* '''phone''' — Телефоны ПВЗ.
* '''comment''' — Дополнительная информация.
* '''worktime''' — Режим работы ПВЗ.
* '''traveldescription''' — Описание местонахождения ПВЗ или пути к нему.
* '''maxweight''' — Максимальный вес, с которым работает ПВЗ.
* '''acceptcash''' — Признак приема наличных
* '''acceptcard''' — Признак приема банковских карт
* '''acceptfitting''' — Наличие примерки
* '''latitude''' — Широта
* '''longitude''' — Долгота
* '''uid''' — Уникальный идентификатор ПВЗ в системе Measoft. Создается автоматически при получении данных о ПВЗ от агентов.
* '''count''' — Количество записей в ответе
* '''totalcount''' — Общее количество записей, отвечающее параметрам запроса

== Получение фискальных данных заказа ==
'''Пример запроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="123456" />
<order orderno="890111C" />
</orders>
</receiptdata>

</source>

'''Пример ответа получения фискальных данных:'''
<source lang="xml">

<?xml version="1.0" encoding="UTF-8"?>
<receipts count="1">
<receipt>
<orderno>123456</orderno>
<fdDatetime>2020-06-07 12:14:00</fdDatetime>
<fdValue>123</fdValue>
<fdNum>456</fdNum>
<fnSn>789</fnSn>
<kktNum>100</kktNum>
<inn>222</inn>
<ofdUrl>gate.ofd.ru</ofdUrl>
<fullUrl>https://check.ofd.ru/123</fullUrl>
<price>12345</price>
<payType>2</payType>
<lines count="1">
<line>
<item>1111764</item>
<name>Сапоги</name>
<extcode>27113415</extcode>
<qty>1</qty>
<price>1000</price>
<vatRate>20</vatRate>
<governmentCode>Z16513LK2</governmentCode>
<itemType>1</itemType>
</line>
</lines>
</receipt>
</receipts>
</source>

Параметры ответа:
* '''orderno''' — Номер заказа
* '''fdDatetime''' — Дата и время пробития фискального чека
* '''fdValue''' — ФПД (фискальный признак документа)
* '''fdNum''' — ФИСКАЛЬНЫЙ ДОКУМЕНТ (фискальный номер чека)
* '''fnSn''' — ФН (номер фискального накопителя)
* '''kktNum''' — РН (регистрационный номер кассы)
* '''inn''' — ИНН
* '''ofdUrl''' — URL адрес (доменное имя) ОФД
* '''price''' — Сумма чека
* '''paytype''' — Тип оплаты чека. Принимает значения:
:* CASH — Наличными (по-умолчанию)
:* CARD — Безналичным способом
* '''fullUrl''' — URL чека для просмотра онлайн
* '''lines''' — Позиции чека
:* '''item''' — код товара
:* '''name''' — наименование товара
:* '''extcode''' — код товара во внешних системах
:* '''qty''' — количество товара
:* '''price''' — цена товара
:* '''governmentCode''' — считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162
:* '''vatRate''' — НДС товара
:* '''itemType''' — тип товара (товар, доставка и т. д.)

== Справочник Виды срочности ==
'''Пример запроса видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>
</source>

'''Пример ответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2">
<service>
<code>1</code>
<name>Эконом</name>
</service>
<service>
<code>2</code>
<name>Срочно</name>
</service>
</services>
</source>

== Справочник дополнительных услуг ==
'''Пример запроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<advprices>
<auth extra="8" login="login" pass="pass" />
</advprices>
</source>

'''advprices''' — Корневой контейнер. Обязательный элемент.

'''Пример ответа справочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advprices>
<advprice>
<code>1</code>
<name>Этажей в доме</name>
<type>int</type>
</advprice>
<advprice>
<code>2</code>
<name>Коэффициент надбавки</name>
<type>float</type>
</advprice>
<advprice>
<code>3</code>
<name>Расписаться на упаковке</name>
<type>bool</type>
</advprice>
</advprices>
</source>

Параметры:
* '''code''' — внутренний код услуги
* '''name''' — наименование услуги. Если поле «название в ЛК» в настройках услуги не пусто, то возвращает значение поля «название в ЛК».
* '''hine''' — подсказка по доп услуге для пользователя
* '''type''' — тип услуги. Может иметь значения:
:* '''bool''' — для услуг вида «чекбокс», «Да»
:* '''float''' — для числа с плавающей точкой
:* '''int''' — для целого числа

== Расчет стоимости доставки ==
'''Пример запроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<order>
<pricetype>CUSTOMER</pricetype>
<sender>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<coords lat="55.680327" lon="37.604456"></coords>
</sender>
<receiver>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<weight>5.1</weight>
<service>2</service>
<paytype>CASH</paytype>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<inshprice>387.5</inshprice>
<packages>
<package mass="1" quantity="5"></package>
<package mass="2.5" length="10" width="20" height="30"></package>
</packages>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</calculator>
</source>

Параметры:
Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]].

Дополнительные поля:
* '''pricetype''' — тип требуемой цены. Возможные значения: «CUSTOMER» (по-умолчанию) — [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], «CLIENT» — цена курьерской службы для клиента.
* '''userid''' — Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.
* '''groupid''' — Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками «Цена доставки для получателя», определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.

Суммы НП и ОЦ, а также тип оплаты CARD имеют значение при настроенных в тарифе на вкладке Прочее долях (в процентах) от данных сумм.

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.<br>
Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.<br>
В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).

'''Пример ответа стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculator>
<calc>
<townfrom code="1">Москва город</townfrom>
<townto code="56603">Иркутск город</townto>
<mass>3.7</mass>
<service name="Экспресс">1</service>
<zone>2</zone>
<price>1113</price>
<mindeliverydays>1</mindeliverydays>
<maxdeliverydays>3</maxdeliverydays>
<mindeliverydate>2020-05-13</mindeliverydate>
<intervals>
<workdays>
<interval>10:00-16:00</interval>
<interval>16:00-22:00</interval>
</workdays>
<holidays>
<interval>12:00-16:00</interval>
</holidays>
</intervals>
<deliveryprice>
<advprice code="1" price="1000">База</advprice>
<advprice code="4" price="100">Процент от суммы руб</advprice>
<advprice code="5" price="63">Процент от объявленной стоимости</advprice>
<advprice code="6" price="-50">Скидка при доставке</advprice>
</deliveryprice>
</calc>
</calculator>
</source>

Параметры:
* '''townfrom''' — Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.
* '''townto''' — Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' — код из справочника городов системы.
* '''mass''' — Масса в килограммах
* '''service''' — Режим доставки — число, указывающее на запись в справочнике видов срочности (см описание на этой странице).
* '''zone''' — номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.
* '''price''' — рассчитанная стоимость доставки в валюте прайс-листа курьерской службы. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.
* '''maxdeliverydays''' — максимальный срок доставки в рабочих днях.
* '''mindeliverydate''' — минимальная дата доставки в учетом выходных дней.
* '''intervals''' — список интервалов доставки для соответствующей зоны и режима срочности.
* '''deliveryprice''' — Данные по составляющим ценам доставки

'''''Обратите внимание:''''' В реальном ответе сервера в теге calc присутствует атрибут «price». Он оставлен для обратной совместимости, не используйте его. Пользуйтесь вложенным тегом price.

=== Коды и описание ошибок ===
{|class=wikitable
!Код ошибки
!Английское описание
!Русское описание
!Примечание
|-
|15||tarif not found||Тариф не найден||Ошибка получения тарифов: для клиента не указан тариф
|-
|19||field [town to] cannot be empty||Поле [город получателя] не может быть пустым||Необходимо указать город получателя или ПВЗ
|-
|20||field [weight] is incorrect||Некорректное значение [масса]||Значение массы некорректное, например, не является числом. Его необходимо исправить
|-
|21||town from not found||Город отправителя не найден||Системе не удалось найти указанный населенный пункт отправителя
|-
|22||town to not found||Город получателя не найден||Системе не удалось найти указанный населенный пункт отправителя
|-
|23||field [weight] cannot be empty||Поле [масса] не может быть пустым||Необходимо указать значение массы отправления, поле [weight]
|-
|36||subtown not found||Город в регионе не найден||Не настроено направление доставки до города в регионе: не добавлен регион или указанный город отсутствует в списке региона
|-
|37||zoneprice not found||Тариф зоны не найден||Отсутствуют зоны тарификации или для них не указаны стоимости
|-
|38||tarif not found - 1||Тариф не найден 1||Результаты расчета отсутствуют: общая ошибка в случае, если других ошибок нет, но результат пустой
|-
|39||tarif not found - 2||Тариф не найден 2||Ошибка получения тарифов: для клиента не настроен тариф или тарификация от количества заказов
|-
|82||field [weight] exceeded limit PVZ||Значение [weight] превышает ограничение ПВЗ||Указанное значение массы больше, чем максимально допустимое для указанного ПВЗ
|-
|83||attribute [paytype] not allowed PVZ||Значение [paytype] не допустимо для ПВЗ||В ПВЗ не допустим указанный тип оплаты
|-
|}

== Получение информации о клиенте ==
'''Пример запроса получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<auth extra="8" login="login" pass="pass" />
</client>
</source>

'''client''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.

'''Пример ответа на запрос получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<code>1082</code>
</client>
</source>

* '''code''' — Код клиента

== Список актов передачи денег ==
'''Пример запроса списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalist>
<auth extra="8" login="login" pass="pass" />
<datefrom>2016-02-10</datefrom>
<dateto>2016-03-10</dateto>
</smalist>
</source>

'''smalist''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''datefrom''' — Дата «с». Необязательный элемент.
* '''dateto''' — Дата «по». Необязательный элемент.
Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.

'''Пример ответа на запрос списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smalist count="1">
<sma>
<code>6278</code>
<number>3992</number>
<actdate>2016-02-12</actdate>
<datepay></datepay>
<dateto>2016-02-12</dateto>
<promiseddatepay></promiseddatepay>
<price>637.00</price>
<pricecorr>113.00</pricecorr>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
<signedcopyreceived>NO</signedcopyreceived>
</sma>
</smalist>
</source>

* '''code''' — Код акта
* '''number''' — Номер акта в системе
* '''actdate''' — Дата акта
* '''datepay''' — Дата оплаты по акту
* '''dateto''' — Дата конечного периода для формирования АПД
* '''promiseddatepay''' — Плановая дата оплаты
* '''price''' — Стоимость услуг
* '''pricecorr''' — Сумма корректировки
* '''rur''' — Сумма заказа
* '''pricekur''' — Стоимость курьерской доставки
* '''priceag''' — Агентское вознаграждение
* '''payno''' — Номер платежного поручения
* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту
* '''paytypename''' — Строковое представление типа оплаты
* '''signedcopyreceived''' — Признак факта возврата акта YES/NO

== Детализация актов передачи денег ==
'''Пример запроса детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetail>
<auth extra="8" login="login" pass="pass" />
<code>6278</code>
</smadetail>
</source>

'''smadetail''' — Корневой контейнер. Обязательный элемент.
* '''auth''' — Авторизация. Обязательный элемент.
* '''code''' — Код акта передачи денег (см. запрос списка АПД). Обязательный элемент.

'''Пример ответа на запрос детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smadetail count="2">
<specialsma>
<code>42494</code>
<ordercode>14424</ordercode>
<orderno>11111</orderno>
<orderdate>2018-01-01</orderdate>
<delivereddate>2018-10-01</delivereddate>
<company>Компания</company>
<price>314.00</price>
<rur>8800.00</rur>
<inshprice>314.00</inshprice>
<pricekur>270.00</pricekur>
<priceag>44.00</priceag>
<pricecalc>8486.00</pricecalc>
<paytype>2</paytype>
<paytypename>наличными курьером</paytypename>
<weight>0.400</weight>
<distance>0.0</distance>
<status>Доставлено</status>
</specialsma>
</smadetail>
</source>

* '''code''' — Код записи.
* '''ordercode''' — Код заказа.
* '''orderno''' — Шифр заказа.
* '''orderdate''' — Дата заказа.
* '''delivereddate''' — Дата доставки.
* '''company''' — Получатель.
* '''price''' — Стоимость услуг.
* '''rur''' — Сумма заказа.
* '''inshprice''' — Стоимость заказа.
* '''pricekur''' — Стоимость курьерской доставки.
* '''priceag''' — Агентское вознаграждение.
* '''pricecalc''' — Сумма для передачи агенту.
* '''paytype''' — Тип оплаты: 1 — безнал, 2 — наличными курьером, 3 — наличными в офисе, 4 — перевод на карту.
* '''paytypename''' — Строковое представление типа оплаты
* '''weight''' — Вес заказа.
* '''distance''' — Дистанция по заказу
* '''status''' — Статус заказа.

== Установка статуса согласования заказа ==
Для возможности клиентом установки статуса согласования заказа необходимо включить переменную [[Личный кабинет курьерской службы#Заказы|Разрешить менять статус согласования]]

'''Пример запроса установки статуса согласования заказа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setapprovalstatus>
<auth extra="8" login="login" pass="pass" />
<order ordercode="1234561">
<confirmstate>1</confirmstate>
<message>Сообщение статуса</message>
</order>
<order ordercode="1234562">
<confirmstate>2</confirmstate>
<message>Согласовано</message>
</order>
<order ordercode="1234563">
<confirmstate>3</confirmstate>
<message>Не согласовано</message>
</order>
</setapprovalstatus>
</source>

* '''order''' — Контейнер заказа. Обязателен как минимум один элемент.
:* '''ordercode''' — Внутренний код заказа.
* '''confirmstate''' — Код статуса заказа. Все статусы с кодами можно получить запросом [[#Получение списка статусов согласования заказа|Получение списка статусов согласования заказа]]
* '''message''' — Дополнительный комментарий, который отобразится в поле ''Инфо о доставке''.

== Получение списка статусов согласования заказа ==
'''Пример запроса списка статусов согласования заказа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<approvalstatuses>
<auth extra="8" login="login" pass="pass" />
</approvalstatuses>
</source>

'''Пример ответа списка статусов согласования заказа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<approvalstatuses count="6">
<status>
<code>1</code>
<name>Неизвестно</name>
</status>
<status>
<code>2</code>
<name>Согласование запрошено</name>
</status>
<status>
<code>3</code>
<name>Доставка полностью согласована</name>
</status>
<status>
<code>4</code>
<name>Согласовано с изменением времени</name>
</status>
<status>
<code>5</code>
<name>Перенос на другую дату</name>
</status>
<status>
<code>6</code>
<name>Отказ</name>
</status>
</approvalstatuses>
</source>

== Генерация коротких ссылок ==
В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК.
Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки.

'''Пример запроса генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<shortlink>
<link short="0"> https://home.courierexe.ru/8/site/orders </link>
</shortlink>
</source>

'''shortlink''' — Корневой контейнер. Обязательный элемент.
* '''link''' — Полная ссылка, для которой необходимо получить код. Обязательный элемент. Если атрибут '''short''' равен 1, то ответ не будет содержать XML, а только хэш-код.

'''Пример ответа на запрос генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
<hash>35AF350C</hash>
</shortlink>
</source>

* '''hash''' — Хэш-код ссылки.

Далее, можно использовать ссылку на ЛК:

<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>

'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft.

== Проверка надежности покупателя ==
Проверка надежности работает только для тарифа «Максимум» личного кабинета.

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<auth extra="8" login="login" pass="pass" />
<phones>
<phone>89161147992</phone>
</phones>
</mcheck>
</source>

Ответ:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<phones>
<phone rate="90">89161147992</phone>
</phones>
</mcheck>
</source>

== Размещение страниц на своем сайте (iframe) ==

В некоторых случаях имеет смысл разметить те или иные страницы на своем сайте.

Например, чтобы клиенты могли рассчитать стоимость доставки не переходя по внешней ссылке, а там же, на сайте, калькулятор можно разместить прямо на странице такого сайта посредством так называемого фрейма — '''iframe'''.

[https://ya.ru/search/?text=iframe Фрейм] — контейнер внутри обычной страницы, который позволяет загружать сторонние страницы. Пример загрузки калькулятора:

<source lang="html">
<iframe id="frame" src="https://home.courierexe.ru/8/calculator">
Здесь должен отобразиться калькулятор
</iframe>
</source>

Для удобства пользователей вашего сайта можно указать язык интерфейса (который переключается непосредственно на сайте) параметром '''lang''':

<source lang="html">
<iframe id="frame" src="https://home.courierexe.ru/8/calculator?lang=2">
Здесь должен отобразиться калькулятор
</iframe>
</source>

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# При использовании iFrame могут не работать некоторые функции, например, подписка на push-уведомления на странице трекинга или отслеживания.
# Если язык не указать, то на страницах калькулятора и трекинга отображается свой переключатель языка. Если язык указан, то переключатель не отображается.

Поддерживаемые языки и их коды:
:'''1''' — русский
:'''2''' — английский
:'''4''' — узбекский
</div>

== Оформление манифеста ==

'''Пример запроса на создание манифеста:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<manifest>
<auth extra="8" login="login" pass="pass" />
<store_from>1</store_from>
<store_to>2</store_to>
<trn_code>3</trn_code>
<sentdate>2024-11-07</sentdate>
<places>
<place>
<number>1</number>
<seal>7890AABBB</seal>
</place>
<place>
<number>2</number>
<seal>123456ABC</seal>
</place>
</places>
<addresses>
<address>
<code>12345</code>
<place>1</place>
</address>
<address>
<code>67890</code>
<place>2</place>
</address>
</addresses>
</manifest>
</source>

'''manifest''' - Корневой контейнер. Обязательный элемент.
*'''auth''' - Авторизация. Обязательный элемент.
*'''store_from''' - код филиала отправителя. Обязательный элемент.
*'''store_to''' - код филиала получателя. Обязательный элемент.
*'''trn_code''' - код перевозчика. Обязательный элемент.
*'''sentdate''' - дата отправки манифеста. Не обязательный элемент.
*'''addresses''' - корневой элемент для списка заказов.
*:'''address''' - корневой элемент для заказа.
*::'''code''' - наш внутренний номер заказа. Обязательный элемент.
*::'''place''' - номер места заказа. Обязательный элемент, если переданы места.
*'''places''' - корневой элемент для списка мест.
*::'''place''' - корневой элемент для места.
*::'''number''' - номер места. Обязательный элемент.
*::'''seal''' - номер пломбы. Необязательный элемент.

'''Пример успешного ответа'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<result>OK</result>
</manifest>
</source>

'''Пример ответа с ошибкой'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<result error="Текст ошибки">ERROR</result>
</manifest>
</source>

'''manifest''' - Корневой контейнер. Обязательный элемент.
*'''result ''' - Результат. Принимает значения OK или ERROR.
*'''error''' - атрибут с текстом ошибки, если она была.

API

2026-03-20T14:01:49Z

OlegD: /* Описание полей ответа статусов */

Дополнительные возможности

2025-09-25T05:21:38Z

OlegD: /* Настройка документов */

== Настройка для печатной документации ==

'''CustomGivnAct''' - Функция позволяет заменить печатную форму, акта передачи материальных ценностей (печать из выдачи) на пользовательскую. Включить использование этой возможности можно в переменных "Справочники" -> "Переменные" -> "Печать" -> "Акты передачи курьеру" -> "Печатная форма акта: Пользовательская".
Объявленные переменные
%code% - коды записей в выдаче которые необходимо распечатать
%docdate% - дата установленная в выдаче
%dockurier% - ФИО курьера показанного в выдаче
%dockurierfull% - Значение выбранного элемента в дереве (если есть выбранный узел дерева , иначе фио курьера)

Пользовательская форма акта, будет печататься только по заказам со статусом "На руках".

'''OnBeforePrintNakls''' - Вызывается перед печатью накладных, содержит %code% - коды всех адресов (через запятую).

'''OnAfterPrintNakls''' - Вызывается после печати накладных, содержит %code% - коды всех адресов (через запятую).

'''OnBeforePrintOneNakl''' - Вызывается перед печатью накладной, содержит %code% - код адреса.

'''OnAfterPrintOneNakl''' - Вызывается после печати накладной, содержит %code% - код адреса.

'''OnBeforePrintSticker''' - Вызывается перед печатью наклейки, содержит %code% - код адреса, %barcode% - ШК наклейки.

'''OnAfterItemPrint''' - Вызывается после печати наклейки из карточки номенклатуры. Поддерживает поля ввода - input. Содержит %code% - код номенклатуры item.code, %Naimen% - наименование, %country% - название страны, %Count% - указанное количество копий к печати.

'''PrintCustomSticker''' - Функция позволяет установить пользовательскую печатную форму для наклеек (из интерфейса "Печать ведомостей/наклеек"). Вызывается если выбран тип наклейки 15 (переменная StickerForm). Содержит %RectLeft%, %RectTop%, %RectRight%, %RectBottom% - границы прямоугольника на холсте принтера, в которые надо печатать (для поддержки табличной печати на A4), %RecNumber% - номер текущей записи датасета, %CurrentBarCode% - ШК, рассчитанный в зависимости от параметров в интерфейсе "Печать ведомостей/наклеек". %ACopyNo% - номер копии, нумерация с 1. %KolvoStr% - Стандартный текст "текущее место/всего мест", с учетом возможной печати этикетки на одно место из нескольких. Также содержит весь датасет, использующийся в других типах наклеек. В момент вызова функции, принтер уже запущен и начат документ, объект TPrinter в функции создавать не нужно, необходимо только создать объект TCanvas, он создастся как ссылка на текущий холст принтера.

'''PrintItemSticker''' - Вызывается перед печатью наклейки из карточки номенклатуры, для возможности распечатать уникальную наклейку для номенклатуры по заложенным в допвозможности условиям. Содержит %clientbar% - ШК наклейки. Если наклейка распечатана из допвозможности возвращает true, в противном случае false и будет распечатана стандартная наклейка, заложенная в системе

'''ChangeSchetDetailQuery''' - Вызывается формировании / пересчете счета. Возвращает строку разбитую через CRLF на две. Первая строка заменяет поля в запросе по детализации счета, вторая меняет строку группировки. Обязательные поля: zakazcnt - кол-во заказов, price - стоимость курьерских услуг, cnt - количество, pr - общая стоимость курьерских услуг.

'''OnAutoPrintManSticker''' - вызывается перед автопечатью сопроводительного документа к манифесту при заполнении номера пломбы (такая возможность включается уставкой печатаемой формы в переменной AutoPrintManSticker), содержит %code% - код манифеста, %mnf_date% - дату манифеста, %transporter% - код перевозчика, %store% - код филиала-получателя манифеста. Если доп.возможность возвращает true - автопечать происходит, false - нет.

'''OnBeforePrintAddresses''' - Вызывается из формы печати ведомостей/наклеек после нажатия на кнопку "ОК", содержит %code% - коды всех адресов (через запятую).

== Настройка всплывающих окон==

'''OnGivnStateChanged''' - Вызывается в транзакции при изменении статуса выдачи. В параметре %code% указан код выдачи. В %pickupDocId% указан код на таблицу docs, документ приема забранных корреспонденций у курьера (доска приема при закрытии забора). Переменная %RetNotScanned% принимает значение true, если при установленной переменной "Запрашивать возвратные документы при приеме" = "Требовать маркировки наклейкой" пользователь не стал сканировать наклейку.

'''OnAfterGivnStateChanged''' - Вызывается после транзакции, при изменении статуса выдачи. В параметре %code% указан код выдачи. В %pickupDocId% указан код на таблицу docs, документ приема забранных корреспонденций у курьера (доска приема при закрытии забора)

'''OnBeforeAddressSave''' - Вызывается перед сохранением изменений в карточке корреспонденции. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В качестве параметра передан объект fieldlist (объект полный аналог addressrecord в доп. услугах). . Если результат функции -1, то происходит отмена сохранения без ошибки (abort).

'''OnBeforeBaseSave''' - Вызывается перед сохранением изменений в карточке срочного заказа. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В качестве параметра передан объект fieldlist (объект полный аналог таблицы base). Теги %date_put%, %time_put%, %message% - содержат дату вручения, время вручения и инфо о доставке соответственно. Если результат функции -1, то происходит отмена сохранения без ошибки (abort).

'''OnAfterAddressSave''' - Вызывается после сохранения карточки корреспонденции в транзакции. Тег %code% - равен коду адреса; %Form3FrameMode% равен 1, если корреспонденция заполняется из интерфейса: "Функции - Ввод заявок по фото".

'''OnBarScan''' - Скриптовая обработка штрих-кода перед поиском

'''AfterAddressAcceptance''' - Событие после приема корреспонденции на склад (например,заказы - прием корреспонденции). Код выполняется не в транзакции и есть возможность показывать диалоговые окна. Содержит %Code% - код адреса, %StrBarCode% - отсканированный штрих-код. При вызове из интерфейса доски приема либо приема корреспонденции передается дополнительный тег %NewMass%, который содержит массу проставленную весами, содержит -1 если проставление массы отключено.

'''BeforeAddressAcceptance''' - Событие перед приемом корреспонденции на склад (например,заказы - прием корреспонденции). Код выполняется в транзакции. Содержит %Code% - код адреса; %StrBarCode% - отсканированный штрих-код; %mass% - массу, если значение меньше 0 значит весы выключены; %l%, %w%, %h% - габариты; %MultiBarCode% - истина если это наклейка на место; %SetKolvo% - проставлять принятые места, место может быть уже принято; %ClientCode% - код клиента (clients.code); %PackCode% - код места (packages.code) . Если функция возвращает значение больше 0, то это будет новой массой места или корреспонденции.

'''OnAddToShippingPlace''' - событие после добавления корреспонденции в мешок манифеста. Код выполняется в транзакции. Содержит %сode% - код адреса, %BarCode% - штрих код который отсканировали,%ShippingPlace% - код мешка

'''GetTypeShippingPlace''' - событие перед добавлением корреспонденции в мешок манифеста. Задача события распределить корреспонденцию между мешками. Результат функции код мешка, в который необходимо поместить корреспонденцию. Содержит %сode% - код адреса.

'''OnBeforePlanToManifest''' - событие перед планированием корреспонденции в манифест. Предназначено для дополнительных проверок. Выполняется до транзакции. Содержит %code% - код манифеста, %AddrList% - список кодов адресов через запятую. Объявление события отменяет системную проверку на возможность доставки адреса филиалом получателя, ее нужно реализовывать в этом событии.

'''OnBeforeScanToManifest''' - событие перед добавлением корреспонденции в мешок манифеста. Предназначено для дополнительных проверок. Выполняется до транзакции. Содержит %code% - код манифеста, %Address% - код помещаемого адреса

'''OnBeforePlanning''' - событие перед планированием одного или нескольких отправлений на курьера. Содержит %сode% - код курьера, %AddressCodes% - код(ы) планируемых корреспонденций.

'''OnAfterPlanning'''- событие после планирования планированием одного или нескольких отправлений на курьера. Содержит %сode% - код курьера, %AddressCodes% - код(ы) фактически запланированных корреспонденций.

'''DAILY''' - задание выполняемое один раз в день

'''OnGivnKurierStateChanged''' - событие вызывается после изменений данных со слов курьера (статуса, времени или причины недоставки). Вызывается даже при получении данных из мобильного приложения курьера. В событии запрещено показывать диалоги, т.к. это может остановить синхронизацию данных с ЛК. Содержит %сode% - код выдачи.

'''OnBeforeGivnStatus''' - событие срабатывает перед установкой статуса выдачи, не в транзакции. В параметре %code% указан код выдачи, %status% - устанавливаемый статус,%kurier% - код курьера, %date% - дата выдачи, %address% - код адреса

'''OnBeforeClientSave''' - событие срабатывает перед сохранением изменений в карточке клиента. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В качестве параметров переданы %code% (содержит код клиента) и объект fieldlist (полный аналог addressrecord в доп. услугах), который содержит ещё не сохранённую информацию о карточке клиента, а так же все её пользовательские поля. Если результат функции -1, то происходит отмена сохранения без ошибки (abort).

'''OnAfterClientSave''' - событие срабатывает после сохранения изменений в карточке клиента. Код выполняется в транзакции. В качестве параметров переданы %code% (содержит код клиента) и объект fieldlist (полный аналог addressrecord в доп. услугах), который содержит сохранённую информацию о карточке клиента, а так же все её пользовательские поля с предыдущими значениями, которые можно получить через функцию _Former('VarCode', значение, 'VarValue')

'''OnBeforeBasePutCheck''' - событие срабатывает при проставлении галки на вкладке срочных заказов. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В параметре <nowiki>%code%</nowiki> указан код срочного заказа, а в параметре <nowiki>%BasePutCheckType%</nowiki> указан тип проставления: 0 - если галка, 1 - если плюс. Если результат функции -1, то отмена выполняемой функции (abort).

'''OnAfterCreateSpecialSMA''' - событие срабатывает после создания нового АПД для клиента. Код выполняется вне транзакции, потому есть возможность показывать диалоговые окна. В качестве единственного параметра %code% передается код созданного АПД.

'''OnBeforeReturnIncome''' - Событие перед приемом возврата на вкладке выдача. Код выполняется вне транзакции. Содержит %Code% - код адреса. Функция заполняет две переменные: ''$mass'' - масса возврата корреспонденции (проставляется только если значение переменной больше нуля, а если это значение больше массы корреспонденции, то будет использовано в качестве массы места) и ''$kurier'' - код вернувшего курьера (если пустое или равно нулю, то проставляется стандартный код курьера ВОЗВРАТ НА СКЛАД [15]).

'''OnBeforeCreatePickup''' - Событие перед созданием забора правой кнопкой мыши в списке заказов. Код выполняется вне транзакции. Содержит %Code% - код заказа. %FromCompany% - компания, у которой осуществляется забор (поле target), %FromAddress% - адрес забора

'''AfterTicketAnswer''' - Событие происходит после ответа на тикет. %code% - код сообщения, %TimeSpent% - кол-во потраченных минут, %ticket% - номер тикета. Доп. возможность может отключить стандартный ввод затраченного времени, для этого нужно вернуть любое значение.

'''OnAfterTownSave''' - событие срабатывает после заведения нового населенного пункта через интерфейс справочника городов. Параметры: %code% - код населенного пункта, %name% - название населенного пункта, %city% - код региона (области).

== Настройка документов ==
'''CustomAddressPrnForm2''' - Кастомная реализация упрощенной печатной формы. В карточке заказа установлена галка Простые, и установлена переменная "Справочники" -> "Переменные" -> "Печать" -> "Упрощенные печатные формы" -> "Тип упрощенной печатной формы: 5"

'''GetTypeShippingPlace''' - Выполняется при помещении корреспонденции в мешок манифеста. Содержит %code% - код корреспонденции. Возвращаемое значение это код мешка (shippingpalce.code), если его указать , то это изменит мешок, в который будет помещена корреспонденция.

'''OnShelvingBarScan''' - Обработка отсканированного штрих-кода при комплектации.

'''AdditionalStringForSMA''' - задает дополнительные условия для формирования АПД (наиболее часто: разделения актов на нал. и безнал, помимо этого практически неограниченные возможности по изменению условий для отбора корреспонденций в акт, учета их доставленности и т.п.) Содержит %code% - код клиента, переменную %ActPayType% со значениями типов оплаты входящих в акт отправлений: "nal" - наличный, "bnal"- безналичный,"all" - все, а ткаже %ActDateTo% - с датой, до которой создается акт. Может возвращать строку, разделенную символами переноса строки. (На 17.09.2021 в возвращаемой строке предусмотрен 1 символ переноса, т.е. строка состоит из двух частей.) В этом случае часть строки до первого переноса будет использоваться в запросе как доп. условие отбора, часть строки после первого символа пеерноса - в качестве дополнительного условия для определения "выполненности" доставки (поле specialsma.Made). С помощью второго модификатора можно сделать например так, чтобы корреспонденции с незаполненными датой/временем вручения считались доставленными.

'''CustomBillDetaling''' - Кастомная детализация счета. Установка переменной $CancelCustomDetail в true, включает вывод стандартной детализации. В переменной $schet - код счета по которому строится детализация.

'''OnSchetChanged''' - Выполняется при удалении счета и его изменении. Содержит %code% - код счета schet.code

'''QRCodePurpose''' - задает строку "Назначение платежа" (тэг "Purpose") в платежном QR-коде счета. По умолчанию "Курьерские услуги". Содержит %code% - код счета schet.code, %Source% - код клиента clients.code

'''ExceptionsForAPK''' - Задает дополнительные критерии поиска корреспонденции при формировании акта передачи корреспонденции(АПК). Содержит %Boxes% - псевдоним таблицы вложений используемый в запросе. Функция возвращает !ДВЕ! части sql запроса разделенных CRLF. При отборе в АПК используется два запроса. Первый - отбирает не доставленные заказы и возвраты документов, в него будет подставлено условие слева от разделителя CRLF. Второй запрос отбирает возращенные товары, в него будет подставлено условие справа от разделителя CRLF или вся строка условий если в строке нет разделителя CRLF (оставлено для обратной совместимости, в версии программы до 1115 фильтрация была только во втором запросе). %AdditionalParam% - дополнительный параметр, который можно установить в интерпретаторе при вызове функции CreateAddressTransferAct.
пример кода по умолчанию, фильтр только по второму запросу, вложение с названием "Доставка" - не попадает в АПК
<NOWIKI><?>
SET($ExcStr,' and %Boxes%.Name not like ''%Доставка%'' ');
$ExcStr</NOWIKI>

пример для изменения фильтрации сразу у двух запросов:
<NOWIKI><?>
SET($WHERE1,''); rem('условие отбора не доставленных и возврата документов');
SET($WHERE2, ''); rem('условие отбора возврата товаров');
$WHERE1 + CHAR(13) + CHAR(10) + $WHERE2</NOWIKI>

'''OnOrderCountCalc''' -Для расчета стоимости доставки необходимо учитывать кол-во отправлений. Доп. возможность возвращает часть SQL запроса, уточняющий условия поиска. Содержит %code% - равен значению переменной "Считать кол-во отправлений по текущему месяцу" (UseCurrentMonthCount, нет - 0, да - 1)

'''OnGetZakazCount''' - подменяет стандартный подсчет количества отправлений для расчета стоимости доставки (в том чисте отменяется вызов доп.возможности OnOrderCountCalc). Должна возвращать кол-во корреспонденций. В процедуру передаются следующие переменные: %CntAccType% - вид подсчета: 0-по заказу, 1-за месяц по клиенту; %code% - код клиента (обязателен для вида подсчета 1); %ZakazDate% - дата заказа; %CountByMonthType% - способ подсчета заказов за месяц (1-по текущему месяцу; 0 - по предыдущему); %UseCurrentUrgency% - 1:подсчитывать только корреспонденцию определенного режима срочности; %Mode% - этот режим срочности (при подсчете по заказу учитываются так же связанные режимы срочности, указанные в параметре 5 режима срочности в таблице статусов); %DatePut% - дата доставки (добавлено для альтернативных видов подсчета, может быть null); %SeparateIntercityDelivery% - 1:не учитывать междугородние доставки; В функцию так же передается объект fieldlist.

'''OnSMABarcodeScan''' - событие вызывается при сканировании штрихкода АПК в списке актов. %code% - код АПК (sendmoneyact.code)

'''OnPaintSMAColumns''' - вызывается при прорисовке таблицы в форме списка АПД/АПК. В функцию передается DataSet, содержащий поля таблиц SendMoneyAct и Clients, а так же пользовательские поля клиентов, называющиеся ufX, где X - номер поля (в статусах). Функция должна возвращать строку следующей структуры:
Поле1_таблицы, Цвет_фона, Поле2_таблицы, Цвет_фона и т.п. Возврат нечетного числа параметров эквивалентен возврату пустой строки (цвет не меняется)

'''CustomZPDetail''' - кастомное дополнение к детализации зарплаты (Специальная надбавка). Вызывается из скриптовой детализации зарплаты. Предназначено для расчета и вывода в детализацию значения какой-либо специальной надбавки, определенной пользователем. Входящие параметры: %code% - код платежа в таблице kurier_pays, %kurier% - код курьера. Возвращает строку, где через запятую указаны Название надбавки и ее значение. Если эта строка не содержит двух параметров - ничего не выводится.

'''ZPAdditionalSheets''' - кастомное дополнение к детализации зарплаты - дополнительный лист(листы) на форме детализации. В функцию передается DataSet из детализации зарплаты, ссылка на объект Excel (имя - xl). Внутри функции нельзя объявлять объект TSelfAdo с именем DB (он объявлен в детализации). Номер новой страницы Excel передается в переменной $page.

'''OnAddrInventoryAfterCreateDoc''' - вызывается в транзакции, в процедуре создания документа инветаризации корреспонденции. Входящие параметры: %code% - код созданного документа инвентаризации.

'''AddrInventoryAdditionalSQL''' - позволяет модифицировать запрос на создаваемый документ инвентаризации корреспонденции. Используется для наложения дополнительных фильтров. Входящие параметры: %code% - код созданного документа инвентаризации. %header% - часть SQL запроса в которую необходимо сделать вставки, возможные варианты join, where.
Пример использования '''AddrInventoryAdditionalSQL''', добавление фильтра по пользовательскому полю.
<source lang="SQL">
<?>
if('%header%'='join', 'left join userfields uf on uf.sourcecode=b.source and uf.sourcetable=2 and uf.varvalue=1',
if('%header%'='where', 'and ifnull(uf.varvalue, "F") = "T"'
,''))
</source>
.

== Настройка вида маркера ==
Настройки находятся в "Отчеты" -> "Дополнительные возможности" - "Системные". <br />

В функции передается объект Table2Map типа [[Руководство программиста#Объект TFieldObject|TFieldObject]]. Получить поля с примерами значений из него можно например так:
showmessage(table2map._GETTABLEINFO)
(текст большое сообщения можно скопировать в буфер комбинацией Ctrl-C).

Для доступа к данным пользуйтесь только этим объектом, т.к. любое обращение к базе приведет к значительному снижению скорости работы.

Так же текущее состояние окна карты доступно через переменные:

$PlanDate - Выбранная дата, на которую планируется.

$KurierCode - Код выделенного курьера.

$MetroCode - Код выделенной станции метро (маршрута).

Обратите внимание, что все ошибки, возникающие при отрисовке, подавляются системой. Поэтому, если вы допустите ошибку в скрипте, он просто не будет работать, никаких сообщений вы не увидите. Для отладочных целей можно заменить ошибки на сообщения такой конструкцией:

set($s, try(
error('вот тут ошибка, которую вы увидите в виде сообщения');
));
if($s, showmessage($s), '');

'''MapObjectFigure''' - Доп. возможность позволяет установить вид маркера на карте. Результат определяет фигуру: 1 - перевернутый треугольник (острым концом вниз), 2 - треугольник, 3 - увеличенный перевернутый треугольник (острым концом вниз), чтобы квадрат не мог его перекрыть, 4 - квадрат, 5 - ромб, все остальное круг. Ромб поддерживается с версии 960.<br/>
Например:
if(table2map.zabor, 2, if(StrDateToFloat(table2map.DatePeriod) = $PlanDate, 3, 4))
Выводит треугольник, если отправление - забор. Иначе - если дата план отправления равна дате, на которую планируется - увеличенный перевернутый треугольник, иначе - квадрат.

'''MapObjectColor''' - Доп. возможность позволяет установить цвет маркера на карте.
При помощи данных параметров можно создать условия отображения маркеров.<br/>

Для доступа к настройкам доступны переменные:

$Color

$DefaultColor

$PlanedColor

$SelectedPlanedColor

$GetKurierColor

Например:
if((table2map.kurier<20)*(StrDateToFloat(table2map.DatePeriod) = $PlanDate), 16753920, $color)
Не запланированные отправления на текущий день будут отображаться выбранным цветом, иначе - цветом по-умолчанию.

== Речь диктора ==

'''OnGivnVoice''' - выполняется после изменения статуса выдачи. Параметр <nowiki>%code%</nowiki> содержит код выдачи, <nowiki>%State%</nowiki> содержит код устанавливаемого статуса, <nowiki>%OldState%</nowiki> - код старого статуса (0 если не было). Позволяет отключать стандартный звук ОК, если возвращает не 0.

'''OnDashboardManifestVoice''' - выполняется после сканирования адреса в интерфейсе приёма манифестов. Параметр <nowiki>%code%</nowiki> содержит код корреспонденции. Позволяет отключать стандартную диктовку программой (код курьера, вес и т.д.), если возвращает не 0.

== Настройка мобильного приложения ==

== Скрипты ==
'''OnEveryStartApp''' - выполняется при запуске программы.

'''OnEveryCloseApp''' - выполняет при закрытии программы.

'''OnBarScan''' - выполняется при получении ШК со сканера, в параметре %code% - получаем ШК. Если функция, что-то возвращает, то система будет использовать возвращенный ШК.

'''OnMapBeforeGeolocation''' - Вызывается перед отображаем адреса на карте. В функцию передается объект fieldlist.
Пример скрипта, переводящий адреса в НЕ найденные на карте, если станция метро НЕОПЕРЕДЕЛЕННАЯ.
<NOWIKI><?>
if(station=0,
_set('lon', null);
_set('lat', null);
_set('searchCoordinate', 'F');
,0)</NOWIKI>

'''OnSyncInsert''' - Выполняется для каждой добавленной записи при синхронизации с ЛК. Содержит %tablename% - название синхронизируемой таблицы.

'''OnSyncUpdate''' - Выполняется для каждой обновленной записи при синхронизации с ЛК. Содержит %tablename% - название синхронизируемой таблицы.

Если при получении новых адресов с ЛК, нужно поменять любое поле в таблице address, то необходимо использовать сразу два события OnSyncInsert и OnSyncUpdate. Адреса без вложений обрабатываются событием OnSyncInsert, адреса с вложениями будут обрабатываться событием OnSyncUpdate. Это связано с механизмом синхронизации, если в событии OnSyncInsert, проапдейтить поле в адресе с вложениями, то данные могут потеряться.
Когда адрес без вложений, то у него сразу station = 65535 и можно апдейтить. Если с вложениями, то у него сначала station = 65534, а после синхронизации вложений есть отдельный апдейт на 65535. Пример кода, для апдейта поля в адресах, события OnSyncInsert и OnSyncUpdate:
<NOWIKI>

<?>
rem(ticket 23584, 23583);
if( ('%tablename%'='address'),
query('UPDATE address a
JOIN trace t ON t.address=a.code AND t.state=1
JOIN zakaz z ON z.code=a.zakaz
SET
a.mode = IF(z.source=646, 3, 2)
WHERE
a.code = %code%
AND a.station=65535
AND (
(z.source=646 AND a.mode<>3) OR
(A.DATE_PUTN=DATE(t.Statetime) AND a.mode=1) OR
(A.DATE_PUTN=DATE_ADD(DATE(t.Statetime), INTERVAL 1 DAY) AND TIME(t.Statetime) > "21:59:59" AND a.mode=1)
)')
, '');</NOWIKI>
;

'''OnCalcSalary''' - Событие происходит после начисления зарплаты курьеру. %code% - код созданного начисления kurier_pays.code ; %dateto% - дата до которой рассчитали зарплату; И отдельно части зарплаты: %profit% -итоговая сумма; %Zarab% - сдельная часть; %Oklad% - оклад; %Friends% - выплаты за приведенных; %Other% - разное; %AgentMoney% - агентское вознаграждение; %StandingMoney% - Доплата за стаж; %Bonus%, %Shtraf% - бонусы и штрафы.

'''OnCalcAvans''' - Событие происходит после начисления аванса курьеру. %code% - код созданного начисления kurier_pays.code. Можно произвести дополнительные начисления и удержания из kurier_pays.profit.

'''OnTicketSetCusr''' - Пользовательский скрипт перед назначением ответственного в тикетах. %code% - код тикета; %Cusr% - код назначаемого пользователя (может быть равно NULL)

'''OnCreateAddressForActDelivery''' - Пользовательский скрипт вызывающийся в момент формирования корреспонденции на доставку АПД/АПК. Позволяет существенно доработать формируемую корреспонденцию. %code% - код акта sendmoneyact.code, %Client% - код клиента; %delivery% - флаг определяющий корр. на доставку акта (1, значение по умолчанию) или забор акта. fieldlist - объект с полями адреса (повторяет структуру таблицы address), dataset - объект дополнительными полями функции. Объект fieldlist является классом TMyFieldList и позволяет менять значения полей. Также измененный адрес можно сохранить прямо в событии, или он будет сохранен автоматически после выполнения скрипта. Для сохранения адреса используйте метод _save.

Пример, для клиента с кодом 3360, в корреспонденцию на доставку АПК, добавляем список корреспонденций попавших в него во вложения.
<source lang="sql">
<?>
if((client=3360)*(ActType=2),
rem('Ticket 70827, 2022-09-07 Anatoly and Sergey');
set($addresscode, fieldlist._save);
query('insert boxes (address, pos, name)
select '+$addresscode+' AS address, @q := @q + 1 AS pos,
CASE WHEN a.client_id <> '' THEN a.client_id WHEN a.strbarcode<>'' THEN a.strbarcode ELSE CONCAT(a.zakaz,"-", a.number) END AS `name`
FROM addressfld af
JOIN address a ON a.code=af.`address` ,(SELECT @q := 0 ) p
WHERE
af.`AddrTransferCode` = %code% AND af.`ReceivedInTransfer` > 0');
,0);
</source>

'''OnAfterPreassemblyScan''' - событие происходит после сканирования складского товара в корреспонденцию на вкладке «Склад». %code% - код корреспонденции, %ItemCode% - код товара, %ItemCnt% - количество отсканированного товара.

'''OnGeocodeScript''' - скрипт подключения к геокодеру клиента. Используется при включенной переменной "Справочники" -> "Переменные" -> "Подключения" -> "Карты" -> "Геокодирование" -> "Протокол геокодирования: Клиентский (скрипт OnGeocodeScript)". Имеет встроенные переменные:
*$address - адрес для геокодирования;
*$town - код города;
*$street и $home - упрощенный адрес;

Скрипт должен вернуть следующие переменные :
*$lon и $lat - координаты ;
*$goodaddress - нормализованный адрес (не обязательно);

<source lang="sql">
<?>
set($response, HTTPPOST('http://XXXXXXXX',
'{"query":'+ FormatTextJSON($address)+ '}',
'','','','',
'post', 'application/json', 10000));

if($response!'',
new('TJSON', 'json');
set($e, try(
json.SetText($response);
json.OpenChild('geo_data');
json.OpenChild('mid');
set($lat, sqlfloat(json.ChildNodeValue('lat')));
set($lon, sqlfloat(json.ChildNodeValue('lon')));
));
if($e, error('Ошибка в разборе ответа: '+$e), '');
, error('Пришел пустой ответ от геокодера')
);
</source>

'''OnFilterAddressRecalc''' - Позволяет отфильтровать коды адресов, для которых можно пересчитать стоимость. Событие происходит перед расчетом стоимости доставки из интерфейса программы для: актов, счетов, заказов, и т.д. Не работает для пересчета запускаемого из самой карточки корреспонденции.
%codes% - коды адресов для пересчета стоимости доставки. Формат: (1,2,3,...). %RecalcUserCode% - код пользователя запустившего пересчет (актуально для отложенных пересчетов).
Функция должна вернуть коды адресов, допущенных к пересчету в формате: (1,2,3,...)

<source lang="sql">
<?>
rem('2023-12-04 Sergey. Отключаем перерасчет стоимости доставки у корреспонденций в статусе - проверено,
если у пользователя нет права Счета-изменять. Тикет 79954.
Блокировка работает в связке с тикетом 77995.');
new('TSelfADO', 'DB');
DB.OPEN('SELECT a.code FROM courier.address a
LEFT JOIN courier.users u ON u.code=%RecalcUserCode%
LEFT JOIN courier.`userrules` ur ON ur.`GroupId`=u.grup AND ur.`RuleType`=1 AND ur.newruleid =78 -- RSA
WHERE ((a.state1<>8) OR (a.state1=8 AND ur.state="T")) AND a.code in %code%');
DB.ParseForIn('CODE')
</source>

'''OnRecalcBoldCntInFrame''' - срабатывает в карточке тарифа при перемещении курсора зоны. Возвращает целочисленное значение, равное количеству доставленных корреспонденций у клиента за предыдущий месяц. Срабатывает только при открытии карточки тарифа из карточки клиента. %ClientCode% - код клиента. %ZoneCode% - код зоны.

'''ChangeStatusColor''' - подменяет цвет фона сообщения в строке статуса в форме приема корреспонденции. Возвращает целочисленное значение - новый цвет фона, 0 - если цвет менять не нужно. Входящие значения: %code% - входящее значение цвета. Остальные переменные - булевского типа - отражают состояние Настроек: %Renum% - Перенумеровывать, %IgnoreDblScan% - Игнорировать ошибки повторного сканирования, %PrintNakl% - Печатать накладные, %Given% - Выдавать отправления, %PrintFiles% - Печатать файлы, %BarLine% - Включить поддержку штрих-кодовой линейки, '%CreateTrans% - формировать кассовые чеки.

'''GetLusrSQL''' - переопределяет столбец "Изменивший пользователь" в истории изменений. Должен возвращать часть SQL запроса для столбца lusr. Входящее значение %code% содержит код таблицы, для которой строится SQL-запрос истории.

Дополнительные возможности

2025-08-13T08:54:48Z

OlegD: /* Настройка всплывающих окон */

== Настройка для печатной документации ==

'''CustomGivnAct''' - Функция позволяет заменить печатную форму, акта передачи материальных ценностей (печать из выдачи) на пользовательскую. Включить использование этой возможности можно в переменных "Справочники" -> "Переменные" -> "Печать" -> "Акты передачи курьеру" -> "Печатная форма акта: Пользовательская".
Объявленные переменные
%code% - коды записей в выдаче которые необходимо распечатать
%docdate% - дата установленная в выдаче
%dockurier% - ФИО курьера показанного в выдаче
%dockurierfull% - Значение выбранного элемента в дереве (если есть выбранный узел дерева , иначе фио курьера)

Пользовательская форма акта, будет печататься только по заказам со статусом "На руках".

'''OnBeforePrintNakls''' - Вызывается перед печатью накладных, содержит %code% - коды всех адресов (через запятую).

'''OnAfterPrintNakls''' - Вызывается после печати накладных, содержит %code% - коды всех адресов (через запятую).

'''OnBeforePrintOneNakl''' - Вызывается перед печатью накладной, содержит %code% - код адреса.

'''OnAfterPrintOneNakl''' - Вызывается после печати накладной, содержит %code% - код адреса.

'''OnBeforePrintSticker''' - Вызывается перед печатью наклейки, содержит %code% - код адреса, %barcode% - ШК наклейки.

'''OnAfterItemPrint''' - Вызывается после печати наклейки из карточки номенклатуры. Поддерживает поля ввода - input. Содержит %code% - код номенклатуры item.code, %Naimen% - наименование, %country% - название страны, %Count% - указанное количество копий к печати.

'''PrintCustomSticker''' - Функция позволяет установить пользовательскую печатную форму для наклеек (из интерфейса "Печать ведомостей/наклеек"). Вызывается если выбран тип наклейки 15 (переменная StickerForm). Содержит %RectLeft%, %RectTop%, %RectRight%, %RectBottom% - границы прямоугольника на холсте принтера, в которые надо печатать (для поддержки табличной печати на A4), %RecNumber% - номер текущей записи датасета, %CurrentBarCode% - ШК, рассчитанный в зависимости от параметров в интерфейсе "Печать ведомостей/наклеек". %ACopyNo% - номер копии, нумерация с 1. %KolvoStr% - Стандартный текст "текущее место/всего мест", с учетом возможной печати этикетки на одно место из нескольких. Также содержит весь датасет, использующийся в других типах наклеек. В момент вызова функции, принтер уже запущен и начат документ, объект TPrinter в функции создавать не нужно, необходимо только создать объект TCanvas, он создастся как ссылка на текущий холст принтера.

'''PrintItemSticker''' - Вызывается перед печатью наклейки из карточки номенклатуры, для возможности распечатать уникальную наклейку для номенклатуры по заложенным в допвозможности условиям. Содержит %clientbar% - ШК наклейки. Если наклейка распечатана из допвозможности возвращает true, в противном случае false и будет распечатана стандартная наклейка, заложенная в системе

'''ChangeSchetDetailQuery''' - Вызывается формировании / пересчете счета. Возвращает строку разбитую через CRLF на две. Первая строка заменяет поля в запросе по детализации счета, вторая меняет строку группировки. Обязательные поля: zakazcnt - кол-во заказов, price - стоимость курьерских услуг, cnt - количество, pr - общая стоимость курьерских услуг.

'''OnAutoPrintManSticker''' - вызывается перед автопечатью сопроводительного документа к манифесту при заполнении номера пломбы (такая возможность включается уставкой печатаемой формы в переменной AutoPrintManSticker), содержит %code% - код манифеста, %mnf_date% - дату манифеста, %transporter% - код перевозчика, %store% - код филиала-получателя манифеста. Если доп.возможность возвращает true - автопечать происходит, false - нет.

'''OnBeforePrintAddresses''' - Вызывается из формы печати ведомостей/наклеек после нажатия на кнопку "ОК", содержит %code% - коды всех адресов (через запятую).

== Настройка всплывающих окон==

'''OnGivnStateChanged''' - Вызывается в транзакции при изменении статуса выдачи. В параметре %code% указан код выдачи. В %pickupDocId% указан код на таблицу docs, документ приема забранных корреспонденций у курьера (доска приема при закрытии забора). Переменная %RetNotScanned% принимает значение true, если при установленной переменной "Запрашивать возвратные документы при приеме" = "Требовать маркировки наклейкой" пользователь не стал сканировать наклейку.

'''OnAfterGivnStateChanged''' - Вызывается после транзакции, при изменении статуса выдачи. В параметре %code% указан код выдачи. В %pickupDocId% указан код на таблицу docs, документ приема забранных корреспонденций у курьера (доска приема при закрытии забора)

'''OnBeforeAddressSave''' - Вызывается перед сохранением изменений в карточке корреспонденции. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В качестве параметра передан объект fieldlist (объект полный аналог addressrecord в доп. услугах). . Если результат функции -1, то происходит отмена сохранения без ошибки (abort).

'''OnBeforeBaseSave''' - Вызывается перед сохранением изменений в карточке срочного заказа. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В качестве параметра передан объект fieldlist (объект полный аналог таблицы base). Теги %date_put%, %time_put%, %message% - содержат дату вручения, время вручения и инфо о доставке соответственно. Если результат функции -1, то происходит отмена сохранения без ошибки (abort).

'''OnAfterAddressSave''' - Вызывается после сохранения карточки корреспонденции в транзакции. Тег %code% - равен коду адреса; %Form3FrameMode% равен 1, если корреспонденция заполняется из интерфейса: "Функции - Ввод заявок по фото".

'''OnBarScan''' - Скриптовая обработка штрих-кода перед поиском

'''AfterAddressAcceptance''' - Событие после приема корреспонденции на склад (например,заказы - прием корреспонденции). Код выполняется не в транзакции и есть возможность показывать диалоговые окна. Содержит %Code% - код адреса, %StrBarCode% - отсканированный штрих-код. При вызове из интерфейса доски приема либо приема корреспонденции передается дополнительный тег %NewMass%, который содержит массу проставленную весами, содержит -1 если проставление массы отключено.

'''BeforeAddressAcceptance''' - Событие перед приемом корреспонденции на склад (например,заказы - прием корреспонденции). Код выполняется в транзакции. Содержит %Code% - код адреса; %StrBarCode% - отсканированный штрих-код; %mass% - массу, если значение меньше 0 значит весы выключены; %l%, %w%, %h% - габариты; %MultiBarCode% - истина если это наклейка на место; %SetKolvo% - проставлять принятые места, место может быть уже принято; %ClientCode% - код клиента (clients.code); %PackCode% - код места (packages.code) . Если функция возвращает значение больше 0, то это будет новой массой места или корреспонденции.

'''OnAddToShippingPlace''' - событие после добавления корреспонденции в мешок манифеста. Код выполняется в транзакции. Содержит %сode% - код адреса, %BarCode% - штрих код который отсканировали,%ShippingPlace% - код мешка

'''GetTypeShippingPlace''' - событие перед добавлением корреспонденции в мешок манифеста. Задача события распределить корреспонденцию между мешками. Результат функции код мешка, в который необходимо поместить корреспонденцию. Содержит %сode% - код адреса.

'''OnBeforePlanToManifest''' - событие перед планированием корреспонденции в манифест. Предназначено для дополнительных проверок. Выполняется до транзакции. Содержит %code% - код манифеста, %AddrList% - список кодов адресов через запятую. Объявление события отменяет системную проверку на возможность доставки адреса филиалом получателя, ее нужно реализовывать в этом событии.

'''OnBeforeScanToManifest''' - событие перед добавлением корреспонденции в мешок манифеста. Предназначено для дополнительных проверок. Выполняется до транзакции. Содержит %code% - код манифеста, %Address% - код помещаемого адреса

'''OnBeforePlanning''' - событие перед планированием одного или нескольких отправлений на курьера. Содержит %сode% - код курьера, %AddressCodes% - код(ы) планируемых корреспонденций.

'''OnAfterPlanning'''- событие после планирования планированием одного или нескольких отправлений на курьера. Содержит %сode% - код курьера, %AddressCodes% - код(ы) фактически запланированных корреспонденций.

'''DAILY''' - задание выполняемое один раз в день

'''OnGivnKurierStateChanged''' - событие вызывается после изменений данных со слов курьера (статуса, времени или причины недоставки). Вызывается даже при получении данных из мобильного приложения курьера. В событии запрещено показывать диалоги, т.к. это может остановить синхронизацию данных с ЛК. Содержит %сode% - код выдачи.

'''OnBeforeGivnStatus''' - событие срабатывает перед установкой статуса выдачи, не в транзакции. В параметре %code% указан код выдачи, %status% - устанавливаемый статус,%kurier% - код курьера, %date% - дата выдачи, %address% - код адреса

'''OnBeforeClientSave''' - событие срабатывает перед сохранением изменений в карточке клиента. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В качестве параметров переданы %code% (содержит код клиента) и объект fieldlist (полный аналог addressrecord в доп. услугах), который содержит ещё не сохранённую информацию о карточке клиента, а так же все её пользовательские поля. Если результат функции -1, то происходит отмена сохранения без ошибки (abort).

'''OnAfterClientSave''' - событие срабатывает после сохранения изменений в карточке клиента. Код выполняется в транзакции. В качестве параметров переданы %code% (содержит код клиента) и объект fieldlist (полный аналог addressrecord в доп. услугах), который содержит сохранённую информацию о карточке клиента, а так же все её пользовательские поля с предыдущими значениями, которые можно получить через функцию _Former('VarCode', значение, 'VarValue')

'''OnBeforeBasePutCheck''' - событие срабатывает при проставлении галки на вкладке срочных заказов. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В параметре <nowiki>%code%</nowiki> указан код срочного заказа, а в параметре <nowiki>%BasePutCheckType%</nowiki> указан тип проставления: 0 - если галка, 1 - если плюс. Если результат функции -1, то отмена выполняемой функции (abort).

'''OnAfterCreateSpecialSMA''' - событие срабатывает после создания нового АПД для клиента. Код выполняется вне транзакции, потому есть возможность показывать диалоговые окна. В качестве единственного параметра %code% передается код созданного АПД.

'''OnBeforeReturnIncome''' - Событие перед приемом возврата на вкладке выдача. Код выполняется вне транзакции. Содержит %Code% - код адреса. Функция заполняет две переменные: ''$mass'' - масса возврата корреспонденции (проставляется только если значение переменной больше нуля, а если это значение больше массы корреспонденции, то будет использовано в качестве массы места) и ''$kurier'' - код вернувшего курьера (если пустое или равно нулю, то проставляется стандартный код курьера ВОЗВРАТ НА СКЛАД [15]).

'''OnBeforeCreatePickup''' - Событие перед созданием забора правой кнопкой мыши в списке заказов. Код выполняется вне транзакции. Содержит %Code% - код заказа. %FromCompany% - компания, у которой осуществляется забор (поле target), %FromAddress% - адрес забора

'''AfterTicketAnswer''' - Событие происходит после ответа на тикет. %code% - код сообщения, %TimeSpent% - кол-во потраченных минут, %ticket% - номер тикета. Доп. возможность может отключить стандартный ввод затраченного времени, для этого нужно вернуть любое значение.

'''OnAfterTownSave''' - событие срабатывает после заведения нового населенного пункта через интерфейс справочника городов. Параметры: %code% - код населенного пункта, %name% - название населенного пункта, %city% - код региона (области).

== Настройка документов ==
'''CustomAddressPrnForm2''' - Кастомная реализация упрощенной печатной формы. В карточке заказа установлена галка Простые, и установлена переменная "Справочники" -> "Переменные" -> "Печать" -> "Упрощенные печатные формы" -> "Тип упрощенной печатной формы: 5"

'''GetTypeShippingPlace''' - Выполняется при помещении корреспонденции в мешок манифеста. Содержит %code% - код корреспонденции. Возвращаемое значение это код мешка (shippingpalce.code), если его указать , то это изменит мешок, в который будет помещена корреспонденция.

'''OnShelvingBarScan''' - Обработка отсканированного штрих-кода при комплектации.

'''AdditionalStringForSMA''' - задает дополнительные условия для формирования АПД (наиболее часто: разделения актов на нал. и безнал, помимо этого практически неограниченные возможности по изменению условий для отбора корреспонденций в акт, учета их доставленности и т.п.) Содержит %code% - код клиента, переменную %ActPayType% со значениями типов оплаты входящих в акт отправлений: "nal" - наличный, "bnal"- безналичный,"all" - все, а ткаже %ActDateTo% - с датой, до которой создается акт. Может возвращать строку, разделенную символами переноса строки. (На 17.09.2021 в возвращаемой строке предусмотрен 1 символ переноса, т.е. строка состоит из двух частей.) В этом случае часть строки до первого переноса будет использоваться в запросе как доп. условие отбора, часть строки после первого символа пеерноса - в качестве дополнительного условия для определения "выполненности" доставки (поле specialsma.Made). С помощью второго модификатора можно сделать например так, чтобы корреспонденции с незаполненными датой/временем вручения считались доставленными.

'''CustomBillDetaling''' - Кастомная детализация счета. Установка переменной $CancelCustomDetail в true, включает вывод стандартной детализации. В переменной $schet - код счета по которому строится детализация.

'''OnSchetChanged''' - Выполняется при удалении счета и его изменении. Содержит %code% - код счета schet.code

'''ExceptionsForAPK''' - Задает дополнительные критерии поиска корреспонденции при формировании акта передачи корреспонденции(АПК). Содержит %Boxes% - псевдоним таблицы вложений используемый в запросе. Функция возвращает !ДВЕ! части sql запроса разделенных CRLF. При отборе в АПК используется два запроса. Первый - отбирает не доставленные заказы и возвраты документов, в него будет подставлено условие слева от разделителя CRLF. Второй запрос отбирает возращенные товары, в него будет подставлено условие справа от разделителя CRLF или вся строка условий если в строке нет разделителя CRLF (оставлено для обратной совместимости, в версии программы до 1115 фильтрация была только во втором запросе). %AdditionalParam% - дополнительный параметр, который можно установить в интерпретаторе при вызове функции CreateAddressTransferAct.
пример кода по умолчанию, фильтр только по второму запросу, вложение с названием "Доставка" - не попадает в АПК
<NOWIKI><?>
SET($ExcStr,' and %Boxes%.Name not like ''%Доставка%'' ');
$ExcStr</NOWIKI>

пример для изменения фильтрации сразу у двух запросов:
<NOWIKI><?>
SET($WHERE1,''); rem('условие отбора не доставленных и возврата документов');
SET($WHERE2, ''); rem('условие отбора возврата товаров');
$WHERE1 + CHAR(13) + CHAR(10) + $WHERE2</NOWIKI>

'''OnOrderCountCalc''' -Для расчета стоимости доставки необходимо учитывать кол-во отправлений. Доп. возможность возвращает часть SQL запроса, уточняющий условия поиска. Содержит %code% - равен значению переменной "Считать кол-во отправлений по текущему месяцу" (UseCurrentMonthCount, нет - 0, да - 1)

'''OnGetZakazCount''' - подменяет стандартный подсчет количества отправлений для расчета стоимости доставки (в том чисте отменяется вызов доп.возможности OnOrderCountCalc). Должна возвращать кол-во корреспонденций. В процедуру передаются следующие переменные: %CntAccType% - вид подсчета: 0-по заказу, 1-за месяц по клиенту; %code% - код клиента (обязателен для вида подсчета 1); %ZakazDate% - дата заказа; %CountByMonthType% - способ подсчета заказов за месяц (1-по текущему месяцу; 0 - по предыдущему); %UseCurrentUrgency% - 1:подсчитывать только корреспонденцию определенного режима срочности; %Mode% - этот режим срочности (при подсчете по заказу учитываются так же связанные режимы срочности, указанные в параметре 5 режима срочности в таблице статусов); %DatePut% - дата доставки (добавлено для альтернативных видов подсчета, может быть null); %SeparateIntercityDelivery% - 1:не учитывать междугородние доставки; В функцию так же передается объект fieldlist.

'''OnSMABarcodeScan''' - событие вызывается при сканировании штрихкода АПК в списке актов. %code% - код АПК (sendmoneyact.code)

'''OnPaintSMAColumns''' - вызывается при прорисовке таблицы в форме списка АПД/АПК. В функцию передается DataSet, содержащий поля таблиц SendMoneyAct и Clients, а так же пользовательские поля клиентов, называющиеся ufX, где X - номер поля (в статусах). Функция должна возвращать строку следующей структуры:
Поле1_таблицы, Цвет_фона, Поле2_таблицы, Цвет_фона и т.п. Возврат нечетного числа параметров эквивалентен возврату пустой строки (цвет не меняется)

'''CustomZPDetail''' - кастомное дополнение к детализации зарплаты (Специальная надбавка). Вызывается из скриптовой детализации зарплаты. Предназначено для расчета и вывода в детализацию значения какой-либо специальной надбавки, определенной пользователем. Входящие параметры: %code% - код платежа в таблице kurier_pays, %kurier% - код курьера. Возвращает строку, где через запятую указаны Название надбавки и ее значение. Если эта строка не содержит двух параметров - ничего не выводится.

'''ZPAdditionalSheets''' - кастомное дополнение к детализации зарплаты - дополнительный лист(листы) на форме детализации. В функцию передается DataSet из детализации зарплаты, ссылка на объект Excel (имя - xl). Внутри функции нельзя объявлять объект TSelfAdo с именем DB (он объявлен в детализации). Номер новой страницы Excel передается в переменной $page.

'''OnAddrInventoryAfterCreateDoc''' - вызывается в транзакции, в процедуре создания документа инветаризации корреспонденции. Входящие параметры: %code% - код созданного документа инвентаризации.

'''AddrInventoryAdditionalSQL''' - позволяет модифицировать запрос на создаваемый документ инвентаризации корреспонденции. Используется для наложения дополнительных фильтров. Входящие параметры: %code% - код созданного документа инвентаризации. %header% - часть SQL запроса в которую необходимо сделать вставки, возможные варианты join, where.
Пример использования '''AddrInventoryAdditionalSQL''', добавление фильтра по пользовательскому полю.
<source lang="SQL">
<?>
if('%header%'='join', 'left join userfields uf on uf.sourcecode=b.source and uf.sourcetable=2 and uf.varvalue=1',
if('%header%'='where', 'and ifnull(uf.varvalue, "F") = "T"'
,''))
</source>
.

== Настройка вида маркера ==
Настройки находятся в "Отчеты" -> "Дополнительные возможности" - "Системные". <br />

В функции передается объект Table2Map типа [[Руководство программиста#Объект TFieldObject|TFieldObject]]. Получить поля с примерами значений из него можно например так:
showmessage(table2map._GETTABLEINFO)
(текст большое сообщения можно скопировать в буфер комбинацией Ctrl-C).

Для доступа к данным пользуйтесь только этим объектом, т.к. любое обращение к базе приведет к значительному снижению скорости работы.

Так же текущее состояние окна карты доступно через переменные:

$PlanDate - Выбранная дата, на которую планируется.

$KurierCode - Код выделенного курьера.

$MetroCode - Код выделенной станции метро (маршрута).

Обратите внимание, что все ошибки, возникающие при отрисовке, подавляются системой. Поэтому, если вы допустите ошибку в скрипте, он просто не будет работать, никаких сообщений вы не увидите. Для отладочных целей можно заменить ошибки на сообщения такой конструкцией:

set($s, try(
error('вот тут ошибка, которую вы увидите в виде сообщения');
));
if($s, showmessage($s), '');

'''MapObjectFigure''' - Доп. возможность позволяет установить вид маркера на карте. Результат определяет фигуру: 1 - перевернутый треугольник (острым концом вниз), 2 - треугольник, 3 - увеличенный перевернутый треугольник (острым концом вниз), чтобы квадрат не мог его перекрыть, 4 - квадрат, 5 - ромб, все остальное круг. Ромб поддерживается с версии 960.<br/>
Например:
if(table2map.zabor, 2, if(StrDateToFloat(table2map.DatePeriod) = $PlanDate, 3, 4))
Выводит треугольник, если отправление - забор. Иначе - если дата план отправления равна дате, на которую планируется - увеличенный перевернутый треугольник, иначе - квадрат.

'''MapObjectColor''' - Доп. возможность позволяет установить цвет маркера на карте.
При помощи данных параметров можно создать условия отображения маркеров.<br/>

Для доступа к настройкам доступны переменные:

$Color

$DefaultColor

$PlanedColor

$SelectedPlanedColor

$GetKurierColor

Например:
if((table2map.kurier<20)*(StrDateToFloat(table2map.DatePeriod) = $PlanDate), 16753920, $color)
Не запланированные отправления на текущий день будут отображаться выбранным цветом, иначе - цветом по-умолчанию.

== Речь диктора ==

'''OnGivnVoice''' - выполняется после изменения статуса выдачи. Параметр <nowiki>%code%</nowiki> содержит код выдачи, <nowiki>%State%</nowiki> содержит код устанавливаемого статуса, <nowiki>%OldState%</nowiki> - код старого статуса (0 если не было). Позволяет отключать стандартный звук ОК, если возвращает не 0.

'''OnDashboardManifestVoice''' - выполняется после сканирования адреса в интерфейсе приёма манифестов. Параметр <nowiki>%code%</nowiki> содержит код корреспонденции. Позволяет отключать стандартную диктовку программой (код курьера, вес и т.д.), если возвращает не 0.

== Настройка мобильного приложения ==

== Скрипты ==
'''OnEveryStartApp''' - выполняется при запуске программы.

'''OnEveryCloseApp''' - выполняет при закрытии программы.

'''OnBarScan''' - выполняется при получении ШК со сканера, в параметре %code% - получаем ШК. Если функция, что-то возвращает, то система будет использовать возвращенный ШК.

'''OnMapBeforeGeolocation''' - Вызывается перед отображаем адреса на карте. В функцию передается объект fieldlist.
Пример скрипта, переводящий адреса в НЕ найденные на карте, если станция метро НЕОПЕРЕДЕЛЕННАЯ.
<NOWIKI><?>
if(station=0,
_set('lon', null);
_set('lat', null);
_set('searchCoordinate', 'F');
,0)</NOWIKI>

'''OnSyncInsert''' - Выполняется для каждой добавленной записи при синхронизации с ЛК. Содержит %tablename% - название синхронизируемой таблицы.

'''OnSyncUpdate''' - Выполняется для каждой обновленной записи при синхронизации с ЛК. Содержит %tablename% - название синхронизируемой таблицы.

Если при получении новых адресов с ЛК, нужно поменять любое поле в таблице address, то необходимо использовать сразу два события OnSyncInsert и OnSyncUpdate. Адреса без вложений обрабатываются событием OnSyncInsert, адреса с вложениями будут обрабатываться событием OnSyncUpdate. Это связано с механизмом синхронизации, если в событии OnSyncInsert, проапдейтить поле в адресе с вложениями, то данные могут потеряться.
Когда адрес без вложений, то у него сразу station = 65535 и можно апдейтить. Если с вложениями, то у него сначала station = 65534, а после синхронизации вложений есть отдельный апдейт на 65535. Пример кода, для апдейта поля в адресах, события OnSyncInsert и OnSyncUpdate:
<NOWIKI>

<?>
rem(ticket 23584, 23583);
if( ('%tablename%'='address'),
query('UPDATE address a
JOIN trace t ON t.address=a.code AND t.state=1
JOIN zakaz z ON z.code=a.zakaz
SET
a.mode = IF(z.source=646, 3, 2)
WHERE
a.code = %code%
AND a.station=65535
AND (
(z.source=646 AND a.mode<>3) OR
(A.DATE_PUTN=DATE(t.Statetime) AND a.mode=1) OR
(A.DATE_PUTN=DATE_ADD(DATE(t.Statetime), INTERVAL 1 DAY) AND TIME(t.Statetime) > "21:59:59" AND a.mode=1)
)')
, '');</NOWIKI>
;

'''OnCalcSalary''' - Событие происходит после начисления зарплаты курьеру. %code% - код созданного начисления kurier_pays.code ; %dateto% - дата до которой рассчитали зарплату; И отдельно части зарплаты: %profit% -итоговая сумма; %Zarab% - сдельная часть; %Oklad% - оклад; %Friends% - выплаты за приведенных; %Other% - разное; %AgentMoney% - агентское вознаграждение; %StandingMoney% - Доплата за стаж; %Bonus%, %Shtraf% - бонусы и штрафы.

'''OnTicketSetCusr''' - Пользовательский скрипт перед назначением ответственного в тикетах. %code% - код тикета; %Cusr% - код назначаемого пользователя (может быть равно NULL)

'''OnCreateAddressForActDelivery''' - Пользовательский скрипт вызывающийся в момент формирования корреспонденции на доставку АПД/АПК. Позволяет существенно доработать формируемую корреспонденцию. %code% - код акта sendmoneyact.code, %Client% - код клиента; %delivery% - флаг определяющий корр. на доставку акта (1, значение по умолчанию) или забор акта. fieldlist - объект с полями адреса (повторяет структуру таблицы address), dataset - объект дополнительными полями функции. Объект fieldlist является классом TMyFieldList и позволяет менять значения полей. Также измененный адрес можно сохранить прямо в событии, или он будет сохранен автоматически после выполнения скрипта. Для сохранения адреса используйте метод _save.

Пример, для клиента с кодом 3360, в корреспонденцию на доставку АПК, добавляем список корреспонденций попавших в него во вложения.
<source lang="sql">
<?>
if((client=3360)*(ActType=2),
rem('Ticket 70827, 2022-09-07 Anatoly and Sergey');
set($addresscode, fieldlist._save);
query('insert boxes (address, pos, name)
select '+$addresscode+' AS address, @q := @q + 1 AS pos,
CASE WHEN a.client_id <> '' THEN a.client_id WHEN a.strbarcode<>'' THEN a.strbarcode ELSE CONCAT(a.zakaz,"-", a.number) END AS `name`
FROM addressfld af
JOIN address a ON a.code=af.`address` ,(SELECT @q := 0 ) p
WHERE
af.`AddrTransferCode` = %code% AND af.`ReceivedInTransfer` > 0');
,0);
</source>

'''OnAfterPreassemblyScan''' - событие происходит после сканирования складского товара в корреспонденцию на вкладке «Склад». %code% - код корреспонденции, %ItemCode% - код товара, %ItemCnt% - количество отсканированного товара.

'''OnGeocodeScript''' - скрипт подключения к геокодеру клиента. Используется при включенной переменной "Справочники" -> "Переменные" -> "Подключения" -> "Карты" -> "Геокодирование" -> "Протокол геокодирования: Клиентский (скрипт OnGeocodeScript)". Имеет встроенные переменные:
*$address - адрес для геокодирования;
*$town - код города;
*$street и $home - упрощенный адрес;

Скрипт должен вернуть следующие переменные :
*$lon и $lat - координаты ;
*$goodaddress - нормализованный адрес (не обязательно);

<source lang="sql">
<?>
set($response, HTTPPOST('http://XXXXXXXX',
'{"query":'+ FormatTextJSON($address)+ '}',
'','','','',
'post', 'application/json', 10000));

if($response!'',
new('TJSON', 'json');
set($e, try(
json.SetText($response);
json.OpenChild('geo_data');
json.OpenChild('mid');
set($lat, sqlfloat(json.ChildNodeValue('lat')));
set($lon, sqlfloat(json.ChildNodeValue('lon')));
));
if($e, error('Ошибка в разборе ответа: '+$e), '');
, error('Пришел пустой ответ от геокодера')
);
</source>

'''OnFilterAddressRecalc''' - Позволяет отфильтровать коды адресов, для которых можно пересчитать стоимость. Событие происходит перед расчетом стоимости доставки из интерфейса программы для: актов, счетов, заказов, и т.д. Не работает для пересчета запускаемого из самой карточки корреспонденции.
%codes% - коды адресов для пересчета стоимости доставки. Формат: (1,2,3,...). %RecalcUserCode% - код пользователя запустившего пересчет (актуально для отложенных пересчетов).
Функция должна вернуть коды адресов, допущенных к пересчету в формате: (1,2,3,...)

<source lang="sql">
<?>
rem('2023-12-04 Sergey. Отключаем перерасчет стоимости доставки у корреспонденций в статусе - проверено,
если у пользователя нет права Счета-изменять. Тикет 79954.
Блокировка работает в связке с тикетом 77995.');
new('TSelfADO', 'DB');
DB.OPEN('SELECT a.code FROM courier.address a
LEFT JOIN courier.users u ON u.code=%RecalcUserCode%
LEFT JOIN courier.`userrules` ur ON ur.`GroupId`=u.grup AND ur.`RuleType`=1 AND ur.newruleid =78 -- RSA
WHERE ((a.state1<>8) OR (a.state1=8 AND ur.state="T")) AND a.code in %code%');
DB.ParseForIn('CODE')
</source>

'''OnRecalcBoldCntInFrame''' - срабатывает в карточке тарифа при перемещении курсора зоны. Возвращает целочисленное значение, равное количеству доставленных корреспонденций у клиента за предыдущий месяц. Срабатывает только при открытии карточки тарифа из карточки клиента. %ClientCode% - код клиента. %ZoneCode% - код зоны.

'''ChangeStatusColor''' - подменяет цвет фона сообщения в строке статуса в форме приема корреспонденции. Возвращает целочисленное значение - новый цвет фона, 0 - если цвет менять не нужно. Входящие значения: %code% - входящее значение цвета. Остальные переменные - булевского типа - отражают состояние Настроек: %Renum% - Перенумеровывать, %IgnoreDblScan% - Игнорировать ошибки повторного сканирования, %PrintNakl% - Печатать накладные, %Given% - Выдавать отправления, %PrintFiles% - Печатать файлы, %BarLine% - Включить поддержку штрих-кодовой линейки, '%CreateTrans% - формировать кассовые чеки.

'''GetLusrSQL''' - переопределяет столбец "Изменивший пользователь" в истории изменений. Должен возвращать часть SQL запроса для столбца lusr. Входящее значение %code% содержит код таблицы, для которой строится SQL-запрос истории.

Руководство программиста

2025-07-21T13:23:12Z

OlegD: /* Объект TExcel */

== Основные положения ==

В систему «MEASOFT» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

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

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

SET($a, a) – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

IF(a,b,c) или IF(a,b) – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

WHILE(a, b) – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

FOR($a, b, c, d) – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

NEW(ClassName, InstanceName) – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

FREE(InstanceName) – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

ShowObjects – Возвращает список созданных объектов – названия классов и имена.

ERROR(message) – Вызывает ошибку с текстом message.

SHOWMESSAGE(message) – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

SimpleAskUser(Message) – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

TRY(a) – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

REM(….) – Код в скобках игнорируется (комментарий).

EXEC(FileName, Params, Wait, WindowState) – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

=== Строковые функции ===

UpCase(s) – возвращает строку s в верхнем регистре.

LCase(s) – возвращает строку s в нижнем регистре.

Len(s) – возвращает количество символов в строке s.

Pos(s, substr [,start]) – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Параметр start - это позиция старта поиска, не обязательный параметр, по умолчанию равен 1. Поиск не чувствителен к регистру.

Param(s, i) – возвращает i-й элемент строки s, разделенной запятыми на элементы.

ParamsCount(s) - возвращает количество элементов строки s, разделенной запятыми на элементы.

SetParam(s, p, i) – заменяет на значение p i-й элемент строки s, разделенной запятыми на элементы.

Left(s, i [,full] ) – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Mid(s, i, j) - возвращает подстроку из s начиная с i символа и длиной j символов

Right(s, i [,full]) – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Reverse(s) - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

Char(i) – возвращает символ с кодом i.

Ord(s) – возвращает код первого символа строки s.

Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive]) - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

RemSpace(s) – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

SumStr(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

NumToStrSimple(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

FullNameToShort(Name) – Возвращает фамилию и инициалы по полному ФИО Name.

MonthName1(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

MonthName2(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

StrForXML(s) - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

FixedIntToStr(i, len[, char]) - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

Translate(format, [param1, param2, ...]) - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

ExtractFileName(FilePath) - возвращает имя файла с расширением из полного пути к файлу FilePath.

====Функции перекодировки====
DecodeStr(s, charset) - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

EncodeStr(s, charset) - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

Translit(s) - транслитерация строки русского текста s латиницей

UnTranslit(s) - транслитерация строки s с латиницы на русский.

==== Экранирование ====

QUOTEDSTR(s) – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

FormatTextXML(s) - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

FormatTextJSON(s) - переводит строку в формат JSON, экранирует служебные символы.

FormatTextBlob(s) - строка s содержит файл, функция перекодирует переданную строку в байты, используется для заполнения полей формата blob.

====Хеширование ====

HMACHash256(key, text) - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

MD5Hash(text) - создаёт хеш по алгоритму MD5

SignatureUrl(url) - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

CurrTime – возвращает текущее время

CurrDate – возвращает текущую дату

CurrMillisecond - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

Today - возвращает текущую дату в числовом формате.

Day(dt) – возвращает день месяца даты dt.

Month(dt) – возвращает месяц года даты dt.

Year(dt) – возвращает год даты dt.

FirstDayOfMonth(dt) – Возвращает первый день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( FirstDayOfMonth( CurrDate() ) );

LastDayOfMonth(dt) – Возвращает последний день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( LastDayOfMonth( CurrDate() ) );

DaysInMonth(month, year) – Возвращает количество дней в указанном месяце.

IncDay(dt, [count=1]) – Возвращает дату, увеличенную на count дней.

SQLDate(dt) – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

SQLDateToDate(dt) – Переводит дату из SQL-формата в обычный.

DAYSBETWEEN(dt1, dt2) – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimeBetween(t1, t2) - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0], [DefaultHolidayVarNum=1]) - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней(по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

TimePeriod(time1, time2) - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

StrDateToFloat(s, [time=false]) - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

IsAWorkDay(dt) - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

IncWorkDay(dt, [count=1],[DefaultHolidayVarNum=1]) - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней (по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

Sleep(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

INT(v) – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

FLOAT(v) – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

STR(v) – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

Date(v) – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

Time(v) – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

ROUNDUP(f) – округляет число f до ближайшего большего по модулю целого числа.

ROUNDDN(f) – округляет число f до ближайшего меньшего по модулю целого числа.

Money(f, CouldBeEmpty, ZeroFill, MakeSpace) - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.
''Подсказка: для простого округления используется функция int()''

Abs(f) - возвращает модуль числа f.

Mod(x, y) - возвращает остаток от деления целочисленного числа x на целочисленное число y.

=== Константы ===

Null – Возвращает пустое значение.

Да, True, Нет, False – константы, соответствующие булевым значениям.

=== Прочие функции ===

SQLFloat(f) – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding [, append])- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Если append = true, то производится дописывание данных в файл, а не перезаписывание (не обязательный, по умолчанию выключен).

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - Дополнительные заголовки HTTP запроса, передается в виде списка параметров через запятую и всегда образуют пару: 1 параметр - название заголовка, 2 параметр - значение. Если значение содержит запятую то его нужно экранировать в двойные кавычки. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в миллисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

LastHttpError - Выводит последний запрос выполненный с ошибкой в функции HttpPost. Содержит подробную информацию по запросу и ответу.

LastHttpResponse - Выводит последний запрос и ответ от сервера после выполнения Http-запроса в функции HttpPost.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel. Для работы без установленного MS Excel предусмотрен объект TDirectExcel.

'''''Ввод данных'''''

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Если TranslateHeader истинно, то заголовки таблицы будут автоматически переведены.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

Close – Закрывает текущий файл.

'''''Ячейки'''''

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

'''''Строки'''''

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

RowAutoFit([y1, y2]) - Устанавливает автоматическую высоту строк. Аргументы y1 и y2 необязательны и если не указаны, то процедура будет выполнена для всей страницы, в ином случае только для строк от y1 до y2.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

GetRowHeight(r) – Возвращает высоту строки r в пикселях.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

'''''Столбцы'''''

ColCount - Возвращает количество столбцов в листе.

AutoFit – Устанавливает автоматическую ширину столбцов.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SetColWidth (c, w) – Устанавливает ширину столбца c в w пикселей.

GetColWidth (c) – Возвращает ширину столбца c в пикселях.

'''''Листы'''''

SetSheet(No) – Устанавливает номер текущего листа. Если лист с таким номером не существует - он будет создан (и все листы до него). Нумерация начинается с 1.

SetSheetName(Name) - Устанавливает название текущего листа.

SheetsCount – Возвращает количество листов в книге.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

SheetDelete(i) - Удаляет лист с номером i.

'''''Форматирование'''''

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

NumberFormat(x1, y1, x2, y2, Format) - Устанавливает формат вывода чисел в указанном диапазоне ячеек. Например, если Format='0.00' - числа будут выводиться c обязательными 2 знаками после десятичного разделителя.

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

SaveValuesOnly - убирает формулы на текущей странице и оставляет лишь их результативные статичные значения.

'''''Цвета'''''

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

'''''Копи-паст'''''

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

'''''Изображения'''''

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0, width=0, height=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки, width, height (не работает для DirectExcel) - ширина и высота области рисунка в пойнтах-единицах Excel

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

'''''Вывод'''''

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр copies - количество копий, по умолчанию равен 1.

Save(filename) - Сохраняет в файл filename. Если файл существует, в основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

'''''Пример использования'''''

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{| class="wikitable"
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|-
|GetSQL
|Для отладки. Возвращает последний SQL запрос переданный в методы Open, Query, GetSQLValue
|-
|ExportExcel
|Для отладки. Выгружает в эксель содержимое датасета. Можно использовать в незнакомом окружении для понимания передаваемых полей в : шаблонах, печатных формах и т.д. Аналог команды %echo% в шаблонах, на случай если она не сработает.
|-
|OnGetText
|Функция подменяет текстовый вывод значения поля при выгрузке в эксель. Первый параметр это имя поля, которое надо подменить. Второй параметр это то что необходимо вывести. Работает только с текстовыми полями.
'''''Пример использования'''''
DB.OnGetText('Зона', IF((DB.FieldByName('-Lat') ! 0) * (DB.FieldByName('-Lon') ! 0),
GetPolygonByLatLon(DB.FieldByName('-Lat'), DB.FieldByName('-Lon'), 'TYPE = 1 AND IFNULL(zone, 0) > 0 AND PRICE = ' + DB.FieldByName('-price'), 'zone')
,
''
));
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

GetDefaultPrinter - Возвращает имя текущего активного принтера.

SetDefaultPrinter(Printer) – Запоминает предыдущий активный принтер и устанавливает новый текущий принтер. Printer - имя принтера. При необходимости нескольких последовательных вызовов SetDefaultPrinter рекомендуется между вызовами использовать RestoreDefaultPrinter.

RestoreDefaultPrinter - Устанавливает активным принтер, который был текущим перед последним вызовом SetDefaultPrinter.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Для кода DataMatrix можно установить режим для печати скрытых символов с кодами 29(GS) и 232(FCN1), которые требуются для формирования Честного Знака. Для этого необходимо в начале строки указать символ "[" и все разделители 01, 21, 91, 92 так же экранировать этими скобками. Должно получиться [01]02900002317701[21]k3LInNbH_oG0Q[91]EE06[92]YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= . При формировании кода, включится режим формирования штрих-кода DataMatrix GS1, в начале будет добавлен символ с кодом 232 (FCN1), а потом будут добавлены разделители с кодом 29 (GS)
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «MEASOFT». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator][,Correction])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1.
Поле Correction позволяет указать данные для корректировочного чека, используется в системе Штрих-М. По умолчанию пустая строка. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [DeliveryDateMode=0, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; DeliveryDateMode: 0 - установить план. дату доставки текущим рабочим днем, 1 - установить план. дату доставки следующим рабочим днем, 2 - установить план. дату доставки равной планируемой дате оплаты АПД; Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД). Работа функции может быть изменена системной доп. возможностью OnCreateAddressForActDelivery.

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''GetRouteCode(AddressText, TownCode, LatLon[, Lon])''' - для адреса AddressText в городе с кодом TownCode (из таблицы Town) по географическим координатам lat, lon возвращает код роута (записи, хранящей координаты адреса в городе). Если роут не найден (для адреса в городе не найдено записи с указанными координатами) - создает новый роут и возвращает его код, если роут найден (был создан ранее) - обновляет у роута координаты. Если параметр Lon задан, то параметр LatLon должен содержать одну координату, иначе LatLon должен содержать строку вида 'lat, lon'.
В случае ошибки возвращает Null.

Пример:<br>
Set($res, GetRouteCode(address, townto, '55.114034, 36.592397'));<br>
Set($res, GetRouteCode('Троицк, Полковника милиции Курочкина ул., 11', 1, '37.467446, 55.740537'));<br>
Set($res, GetRouteCode('Обнинск, Маркса пр., 20', TownByName('Обнинск'), 55.114034, 36.592397));

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''CalcClientCnt(client_code, date, is_intown [, date_put=CurrDate(), skipajust=false])''' - функция расчета количество доставленных корреспонденций у клиента с кодом client_code за предыдущий месяц от даты date (Или за текущий месяц, подробнее смотри переменную UseCurrentMonthCount) среди внутригородских (is_intown = true) либо междугородних (is_intown = false) корреспонденций, date_put - дата доставки (для альтернативного способа подсчета, включаемого переменной UseDatePutForCalcCnt), skipajust - не учитывать принудительно введенные количества (таблица priceclientadjust типы записей 0 и 1).

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcTownPrice''' - возвращает базовую стоимость междугородней доставки, посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов, типа, срочности, массы, расстояния.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset.self".

*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*tp - тип корреспонденции;
*mode - режим доставки;
*mass - масса отправления;
*TownFrom - код города отправителя;
*TownTo - код города получателя.

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FromEmailStr''' - строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber,Print,[printer]) - Выполняет указанную печатную форму в объекте excel. Excel объект можно не указывать, тогда функция сама создаст объект экселя и разрушит его, полезно когда книгу
нужно распечатать или отправить по email (на листе данных в ячейке 1,1 укажите ключевое слово email). Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Print - печатает книгу на принтере, после печати объект excel разрушается, при использовании параметра не указываете объект excel. Printer - имя принтера, на котором печатать (по умолчанию пустая строка, что означает "печатать на принтере по умолчанию"). Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

'''SelDistAddr(s)''' – Возвращает строку для вставки в select запрос, для вывода поля с упрощенным адресом. Принимает один необязательный строковый параметр - алиас таблицы из которой будет упрощаться поле address, по умолчанию "a"

'''VoiceReadStr(str)''' – Озвучивает фразу str голосовым уведомлением доступными словами из базы. Может содержать тег "{break_off}" для того, чтобы сделать эту фразу не пропускаемой в очереди воспроизведения.

'''CalcStorageCost(ClientCodes, DateFrom, DateTo, NeedReport[, Store])''' – рассчитывает стоимость хранения на складе для выбранных клиентов (ClientCodes - коды клиентов через запятую), в период дат с DateFrom до DateTo, с прикреплением к корреспонденции отчета в зависимости от выставленного параметра NeedReport. Может содержать параметр Store - код филиала, по умолчанию пустой (расчет выполняется для всех филиалов). Возвращает коды созданных корреспонденций через запятую.

'''WriteOut(DocId, ItemId, Date, Cnt[, BC])''' – производит списание товара со склада. DocId - код (docs.code) документа списания, ItemId - код товара (item.code), Date - дата операции, Cnt - количество списываемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер. Если указан BC, то параметр ItemId игнорируется и поиск номенклатуры происходит исключительно по штрих-коду. В случае успеха, функция возвращает строку вида: код номенклатуры, списанное кол-во

'''IncomePurch(DocId, ItemId, Date, Cnt[, BC, Location = CurrentLocation])''' – производит приход товара на склад. DocId - код (docs.code) приходной накладной, ItemId - код товара (item.code), Date - дата операции, Cnt - количество приходуемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер, Location - код склада (store.code). В случае успеха, функция возвращает строку вида: код номенклатуры, введенное кол-во

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID (для провайдера iVoice - идентификатор сценария (кампании)). Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдеров BitCall и iVoice. Для BitCall по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием). Для iVoice по умолчанию подразумевается параметр 'response', при этом будет возвращен JSON с ответами абонента на заданные вопросы (в зависимости от сценария)

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, ZipPath) - Добавляет файл SrcPath в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл из строки Data в архив и располагает его по пути ZipPath. -ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

'''Функции общего назначения''':

'''ExecSimpleScript(Caption, Text)''' - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

'''FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns,ShowAll])''' - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. ShowAll - показать все дополнительные услуги, по умолчанию false и показывает только услуги с начислениями. Функция возвращает количество использованных столбцов.

'''PrintSticker(Codes, [ToBoxes=False])'''

'''PrintBlanc(Codes, BlancNumber)''' - печатать форму из раздела "Заполнить бланк". Codes - коды корреспонденций, BlancNumber - номер формы из раздела "Бланки для корреспонденции" (3)

'''GetItemByName(Name)'''

'''GetA4Printer''' - возвращает имя принтера выбранного для печати документов

'''GetStickerPrinter''' - возвращает имя принтера выбранного для печати стикеров

'''GetDuplexPrinter''' - возвращает имя принтера выбранного для двусторонней печати, если принтер не выбран, возвращает пустую строку

'''PrintAttachPDFPage(Code, FileName, Page, Printer)''' - печатает страницу из вложенного файла PDF. Code - код вложения (attachment), Page - номер страницы, Printer - 0 = принтер A4, 1 = принтер этикеток.

'''AttachPDFToText(Code, [TextFileName])''' - преобразует файл PDF из вложений в текст. Code - код вложения (attachment), TextFileName - имя текстового файла, в который записывается результат (если не указан, используется временный файл). Возвращает текст в виде строки.

'''GetActiveForm([SkipFormName])''' - возвращает код активной формы в программе где происходит сканирование. SkipFormName - не обязательны параметр, имя формы которую нужно пропустить при определении интерфейса.
'''Список интерфейсов''':
0 - неопределенный;
1 - прием корреспонденции на склад;
2 - АПД;
3 - комплектация адресов (ShelfingForm);
4 - доска приема;
9 - вкладка «Манифесты»;
10 - Инвентаризация корреспонденции;
11 - АПК;
12 - вкладка «Адреса»;
13 - вкладка «Выдача»;
14 - вкладка «Склад»;
15 - Список номенклатуры;
16 - Инвентаризация склада;
17 - Приходная накладная;
18 - Списание товара;
19 - Карточка корреспонденции.

'''AddAddressScanLog(Code[, StrBarCode, IsManual, FromInterface, ExtraInfo])''' - добавляет событие сканирование для корреспонденции с кодом Code. Необязательные параметры: StrBarCode - сканируемый ШК корреспонденции (по умолчанию пустой), IsManual - галка ручного сканирования (по умолчанию false), FromInterface - код интерфейса сканирования (StateType=81, по умолчанию 0 - неопределенный), ExtraInfo - текстовый комментарий события.

'''RuleName(alias)''' - Выдает полный путь в дерева прав по псевдониму права.

'''ShowText(Caption:string, Value:string)''' - показывает пользователю окно с заголовком Caption и с многострочным полем со значением Value. Может быть полезен при отображении логов выполненной операции.

'''ShowScanError(msg [, Speek])''' - выдает пользователю окно с текстом msg блокируя последующие действия сканирования. Если Speek - истинно, то сообщение проговаривается голосовым движком, по умолчанию выключено.

'''CheckRule(alias)''' - функция проверки разрешения у текущего пользователя системы, alias - псевдоним права. Возвращает 1, если право есть и 0, если права нет.
Пример: if(CheckRule('RSE'), ShowMessage('У пользователя есть право изменять счета'), ShowMessage('У пользователя нет права изменять счета'));

'''GetKurierMoney(KurierCode, DateEnd, NonCash)''' - возвращает баланс курьера с кодом KurierCode на дату DateEnd. NonCash - булевый флаг, если истинно, то будет рассчитан безнальный баланс;

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

ClientTown - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

== Объект TFieldObject ==
Создается только автоматически. Объект для доступа к записям, используется в картах и доп.услугах.

_GETTABLEINFO - возвращает данные о полях и примеры данных объекта.

== Объект TMessage ==
Создается только автоматически. Объект используется для скриптовой обработки письма в [https://wiki.courierexe.ru/index.php/%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8F_%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8#.D0.98.D0.BC.D0.BF.D0.BE.D1.80.D1.82_.D0.B4.D0.B0.D0.BD.D0.BD.D1.8B.D1.85| заданиях импорта данных]. В себе содержит текст письма в очищенном формате и оригинальном формате HTML, отправитель письма, тему письма, дата получения и список прикрепленных файлов.

'''Message.Text''' - возвращает очищенный от HTML-тегов текст письма.

'''Message.HTMLText''' - возвращает оригинальный текст письма со всеми HTML-тегами.

'''Message.Sender''' - возвращает email-адрес отправителя письма.

'''Message.AttachmentsCount''' - возвращает количество вложенных файлов.

'''Message.DateTime''' - возвращает дату и время получения письма.

'''Message.Subject''' - возвращает тему письма.

'''Message.GetAttachmentDataString(Number)''' - возвращает вложенный файл под номером Number в виде строки.

'''Message.GetAttachmentName(Number)''' - возвращает имя вложенного файла под номером Number.

== Объект TStringList ==
Может использоваться для построчной обработки многостраничных файлов либо для организации текстовых данных. Номер строк начинается с 0.
Имеет следующий функционал:

'''Count''' - возвращает количество строк в списке.

'''Add(Value:string)''' - добавляет значение Value в конец списка.

'''Insert(Number:integer, Value:string)''' - добавляет строку Value в позицию Number.

'''Delete(Number:integer)''' - удаляет строку из списка в позиции Number.

'''Clear''' - очищает элементы списка.

'''LoadFromFile(Path:string)''' - загружает текстовый файл по пути Path.

'''Strings(Number:integer)''' - возвращает строку с номером Number.

'''SetString(Number:integer, Value:string)''' - устанавливает значение строки с номером Number в значение Value.

'''Text''' - возвращает полный список строк в виде текста.

'''CommaText([Quoted:boolean])''' - возвращает список значений через запятую. Если Quoted = true, то квотирует элементы списка. По умолчанию равен false.

'''SetCommaText(Value: string)''' - разбивает значение Value на отдельные строки и кладет в список. Разделитель - запятые.

'''IndexOf(Value:string)''' - ищет значение Value среди элементов списка и если находит, то возвращает номер строки. Возвращает -1 если значение не было найдено.

'''Sorted(Value:boolean)''' - устанавливает флаг отсортированности списка в Value. Если Value = true, то сразу же его сортирует. По умолчанию Value = false.

'''Exchange(Pos1:integer, Pos2:integer)''' - меняет элементы списка с позициями Pos1 и Pos2 местами.

'''Duplicates(Value:integer)''' - изменяет параметр управления дубликатами в списке. Если Value = 0 (значение по умолчанию), то список не реагирует на дубликаты. Если Value = 1, то список при добавлении будет игнорировать дубликаты. Если Value = 2, то список будет выдавать исключение, при добавлении дубликата в список.

'''ParamName(Number:integer[, Delimiter:string])''' - возвращает текст до первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает пустоту.

'''ParamValue(Number:integer[, Delimiter:string])''' - возвращает текст после первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает всю строку.

== Применение языка формул ==
'''в различных контекстах системы «MEASOFT» и сопутствующих проектах'''

=== MEASOFT ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с уровнем (pricelevel) меньше текущего.

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===

{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-

Руководство программиста

2025-07-21T13:22:24Z

OlegD: /* Объект TExcel */

== Основные положения ==

В систему «MEASOFT» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

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

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

SET($a, a) – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

IF(a,b,c) или IF(a,b) – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

WHILE(a, b) – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

FOR($a, b, c, d) – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

NEW(ClassName, InstanceName) – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

FREE(InstanceName) – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

ShowObjects – Возвращает список созданных объектов – названия классов и имена.

ERROR(message) – Вызывает ошибку с текстом message.

SHOWMESSAGE(message) – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

SimpleAskUser(Message) – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

TRY(a) – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

REM(….) – Код в скобках игнорируется (комментарий).

EXEC(FileName, Params, Wait, WindowState) – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

=== Строковые функции ===

UpCase(s) – возвращает строку s в верхнем регистре.

LCase(s) – возвращает строку s в нижнем регистре.

Len(s) – возвращает количество символов в строке s.

Pos(s, substr [,start]) – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Параметр start - это позиция старта поиска, не обязательный параметр, по умолчанию равен 1. Поиск не чувствителен к регистру.

Param(s, i) – возвращает i-й элемент строки s, разделенной запятыми на элементы.

ParamsCount(s) - возвращает количество элементов строки s, разделенной запятыми на элементы.

SetParam(s, p, i) – заменяет на значение p i-й элемент строки s, разделенной запятыми на элементы.

Left(s, i [,full] ) – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Mid(s, i, j) - возвращает подстроку из s начиная с i символа и длиной j символов

Right(s, i [,full]) – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Reverse(s) - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

Char(i) – возвращает символ с кодом i.

Ord(s) – возвращает код первого символа строки s.

Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive]) - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

RemSpace(s) – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

SumStr(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

NumToStrSimple(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

FullNameToShort(Name) – Возвращает фамилию и инициалы по полному ФИО Name.

MonthName1(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

MonthName2(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

StrForXML(s) - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

FixedIntToStr(i, len[, char]) - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

Translate(format, [param1, param2, ...]) - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

ExtractFileName(FilePath) - возвращает имя файла с расширением из полного пути к файлу FilePath.

====Функции перекодировки====
DecodeStr(s, charset) - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

EncodeStr(s, charset) - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

Translit(s) - транслитерация строки русского текста s латиницей

UnTranslit(s) - транслитерация строки s с латиницы на русский.

==== Экранирование ====

QUOTEDSTR(s) – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

FormatTextXML(s) - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

FormatTextJSON(s) - переводит строку в формат JSON, экранирует служебные символы.

FormatTextBlob(s) - строка s содержит файл, функция перекодирует переданную строку в байты, используется для заполнения полей формата blob.

====Хеширование ====

HMACHash256(key, text) - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

MD5Hash(text) - создаёт хеш по алгоритму MD5

SignatureUrl(url) - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

CurrTime – возвращает текущее время

CurrDate – возвращает текущую дату

CurrMillisecond - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

Today - возвращает текущую дату в числовом формате.

Day(dt) – возвращает день месяца даты dt.

Month(dt) – возвращает месяц года даты dt.

Year(dt) – возвращает год даты dt.

FirstDayOfMonth(dt) – Возвращает первый день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( FirstDayOfMonth( CurrDate() ) );

LastDayOfMonth(dt) – Возвращает последний день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( LastDayOfMonth( CurrDate() ) );

DaysInMonth(month, year) – Возвращает количество дней в указанном месяце.

IncDay(dt, [count=1]) – Возвращает дату, увеличенную на count дней.

SQLDate(dt) – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

SQLDateToDate(dt) – Переводит дату из SQL-формата в обычный.

DAYSBETWEEN(dt1, dt2) – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimeBetween(t1, t2) - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0], [DefaultHolidayVarNum=1]) - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней(по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

TimePeriod(time1, time2) - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

StrDateToFloat(s, [time=false]) - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

IsAWorkDay(dt) - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

IncWorkDay(dt, [count=1],[DefaultHolidayVarNum=1]) - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней (по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

Sleep(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

INT(v) – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

FLOAT(v) – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

STR(v) – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

Date(v) – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

Time(v) – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

ROUNDUP(f) – округляет число f до ближайшего большего по модулю целого числа.

ROUNDDN(f) – округляет число f до ближайшего меньшего по модулю целого числа.

Money(f, CouldBeEmpty, ZeroFill, MakeSpace) - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.
''Подсказка: для простого округления используется функция int()''

Abs(f) - возвращает модуль числа f.

Mod(x, y) - возвращает остаток от деления целочисленного числа x на целочисленное число y.

=== Константы ===

Null – Возвращает пустое значение.

Да, True, Нет, False – константы, соответствующие булевым значениям.

=== Прочие функции ===

SQLFloat(f) – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding [, append])- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Если append = true, то производится дописывание данных в файл, а не перезаписывание (не обязательный, по умолчанию выключен).

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - Дополнительные заголовки HTTP запроса, передается в виде списка параметров через запятую и всегда образуют пару: 1 параметр - название заголовка, 2 параметр - значение. Если значение содержит запятую то его нужно экранировать в двойные кавычки. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в миллисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

LastHttpError - Выводит последний запрос выполненный с ошибкой в функции HttpPost. Содержит подробную информацию по запросу и ответу.

LastHttpResponse - Выводит последний запрос и ответ от сервера после выполнения Http-запроса в функции HttpPost.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel. Для работы без установленного MS Excel предусмотрен объект TDirectExcel.

'''''Ввод данных'''''

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Если TranslateHeader истинно, то заголовки таблицы будут автоматически переведены.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

Close – Закрывает текущий файл.

'''''Ячейки'''''

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

'''''Строки'''''

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

RowAutoFit([y1, y2]) - Устанавливает автоматическую высоту строк. Аргументы y1 и y2 необязательны и если не указаны, то процедура будет выполнена для всей страницы, в ином случае только для строк от y1 до y2.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

GetRowHeight(r) – Возвращает высоту строки r в пикселях.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

'''''Столбцы'''''

ColCount - Возвращает количество столбцов в листе.

AutoFit – Устанавливает автоматическую ширину столбцов.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SetColWidth (c, w) – Устанавливает ширину столбца c в w пикселей.

ПуеColWidth (c) – Возвращает ширину столбца c в пикселях.

'''''Листы'''''

SetSheet(No) – Устанавливает номер текущего листа. Если лист с таким номером не существует - он будет создан (и все листы до него). Нумерация начинается с 1.

SetSheetName(Name) - Устанавливает название текущего листа.

SheetsCount – Возвращает количество листов в книге.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

SheetDelete(i) - Удаляет лист с номером i.

'''''Форматирование'''''

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

NumberFormat(x1, y1, x2, y2, Format) - Устанавливает формат вывода чисел в указанном диапазоне ячеек. Например, если Format='0.00' - числа будут выводиться c обязательными 2 знаками после десятичного разделителя.

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

SaveValuesOnly - убирает формулы на текущей странице и оставляет лишь их результативные статичные значения.

'''''Цвета'''''

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

'''''Копи-паст'''''

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

'''''Изображения'''''

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0, width=0, height=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки, width, height (не работает для DirectExcel) - ширина и высота области рисунка в пойнтах-единицах Excel

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

'''''Вывод'''''

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр copies - количество копий, по умолчанию равен 1.

Save(filename) - Сохраняет в файл filename. Если файл существует, в основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

'''''Пример использования'''''

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{| class="wikitable"
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|-
|GetSQL
|Для отладки. Возвращает последний SQL запрос переданный в методы Open, Query, GetSQLValue
|-
|ExportExcel
|Для отладки. Выгружает в эксель содержимое датасета. Можно использовать в незнакомом окружении для понимания передаваемых полей в : шаблонах, печатных формах и т.д. Аналог команды %echo% в шаблонах, на случай если она не сработает.
|-
|OnGetText
|Функция подменяет текстовый вывод значения поля при выгрузке в эксель. Первый параметр это имя поля, которое надо подменить. Второй параметр это то что необходимо вывести. Работает только с текстовыми полями.
'''''Пример использования'''''
DB.OnGetText('Зона', IF((DB.FieldByName('-Lat') ! 0) * (DB.FieldByName('-Lon') ! 0),
GetPolygonByLatLon(DB.FieldByName('-Lat'), DB.FieldByName('-Lon'), 'TYPE = 1 AND IFNULL(zone, 0) > 0 AND PRICE = ' + DB.FieldByName('-price'), 'zone')
,
''
));
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

GetDefaultPrinter - Возвращает имя текущего активного принтера.

SetDefaultPrinter(Printer) – Запоминает предыдущий активный принтер и устанавливает новый текущий принтер. Printer - имя принтера. При необходимости нескольких последовательных вызовов SetDefaultPrinter рекомендуется между вызовами использовать RestoreDefaultPrinter.

RestoreDefaultPrinter - Устанавливает активным принтер, который был текущим перед последним вызовом SetDefaultPrinter.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Для кода DataMatrix можно установить режим для печати скрытых символов с кодами 29(GS) и 232(FCN1), которые требуются для формирования Честного Знака. Для этого необходимо в начале строки указать символ "[" и все разделители 01, 21, 91, 92 так же экранировать этими скобками. Должно получиться [01]02900002317701[21]k3LInNbH_oG0Q[91]EE06[92]YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= . При формировании кода, включится режим формирования штрих-кода DataMatrix GS1, в начале будет добавлен символ с кодом 232 (FCN1), а потом будут добавлены разделители с кодом 29 (GS)
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «MEASOFT». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator][,Correction])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1.
Поле Correction позволяет указать данные для корректировочного чека, используется в системе Штрих-М. По умолчанию пустая строка. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [DeliveryDateMode=0, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; DeliveryDateMode: 0 - установить план. дату доставки текущим рабочим днем, 1 - установить план. дату доставки следующим рабочим днем, 2 - установить план. дату доставки равной планируемой дате оплаты АПД; Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД). Работа функции может быть изменена системной доп. возможностью OnCreateAddressForActDelivery.

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''GetRouteCode(AddressText, TownCode, LatLon[, Lon])''' - для адреса AddressText в городе с кодом TownCode (из таблицы Town) по географическим координатам lat, lon возвращает код роута (записи, хранящей координаты адреса в городе). Если роут не найден (для адреса в городе не найдено записи с указанными координатами) - создает новый роут и возвращает его код, если роут найден (был создан ранее) - обновляет у роута координаты. Если параметр Lon задан, то параметр LatLon должен содержать одну координату, иначе LatLon должен содержать строку вида 'lat, lon'.
В случае ошибки возвращает Null.

Пример:<br>
Set($res, GetRouteCode(address, townto, '55.114034, 36.592397'));<br>
Set($res, GetRouteCode('Троицк, Полковника милиции Курочкина ул., 11', 1, '37.467446, 55.740537'));<br>
Set($res, GetRouteCode('Обнинск, Маркса пр., 20', TownByName('Обнинск'), 55.114034, 36.592397));

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''CalcClientCnt(client_code, date, is_intown [, date_put=CurrDate(), skipajust=false])''' - функция расчета количество доставленных корреспонденций у клиента с кодом client_code за предыдущий месяц от даты date (Или за текущий месяц, подробнее смотри переменную UseCurrentMonthCount) среди внутригородских (is_intown = true) либо междугородних (is_intown = false) корреспонденций, date_put - дата доставки (для альтернативного способа подсчета, включаемого переменной UseDatePutForCalcCnt), skipajust - не учитывать принудительно введенные количества (таблица priceclientadjust типы записей 0 и 1).

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcTownPrice''' - возвращает базовую стоимость междугородней доставки, посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов, типа, срочности, массы, расстояния.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset.self".

*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*tp - тип корреспонденции;
*mode - режим доставки;
*mass - масса отправления;
*TownFrom - код города отправителя;
*TownTo - код города получателя.

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FromEmailStr''' - строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber,Print,[printer]) - Выполняет указанную печатную форму в объекте excel. Excel объект можно не указывать, тогда функция сама создаст объект экселя и разрушит его, полезно когда книгу
нужно распечатать или отправить по email (на листе данных в ячейке 1,1 укажите ключевое слово email). Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Print - печатает книгу на принтере, после печати объект excel разрушается, при использовании параметра не указываете объект excel. Printer - имя принтера, на котором печатать (по умолчанию пустая строка, что означает "печатать на принтере по умолчанию"). Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

'''SelDistAddr(s)''' – Возвращает строку для вставки в select запрос, для вывода поля с упрощенным адресом. Принимает один необязательный строковый параметр - алиас таблицы из которой будет упрощаться поле address, по умолчанию "a"

'''VoiceReadStr(str)''' – Озвучивает фразу str голосовым уведомлением доступными словами из базы. Может содержать тег "{break_off}" для того, чтобы сделать эту фразу не пропускаемой в очереди воспроизведения.

'''CalcStorageCost(ClientCodes, DateFrom, DateTo, NeedReport[, Store])''' – рассчитывает стоимость хранения на складе для выбранных клиентов (ClientCodes - коды клиентов через запятую), в период дат с DateFrom до DateTo, с прикреплением к корреспонденции отчета в зависимости от выставленного параметра NeedReport. Может содержать параметр Store - код филиала, по умолчанию пустой (расчет выполняется для всех филиалов). Возвращает коды созданных корреспонденций через запятую.

'''WriteOut(DocId, ItemId, Date, Cnt[, BC])''' – производит списание товара со склада. DocId - код (docs.code) документа списания, ItemId - код товара (item.code), Date - дата операции, Cnt - количество списываемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер. Если указан BC, то параметр ItemId игнорируется и поиск номенклатуры происходит исключительно по штрих-коду. В случае успеха, функция возвращает строку вида: код номенклатуры, списанное кол-во

'''IncomePurch(DocId, ItemId, Date, Cnt[, BC, Location = CurrentLocation])''' – производит приход товара на склад. DocId - код (docs.code) приходной накладной, ItemId - код товара (item.code), Date - дата операции, Cnt - количество приходуемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер, Location - код склада (store.code). В случае успеха, функция возвращает строку вида: код номенклатуры, введенное кол-во

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID (для провайдера iVoice - идентификатор сценария (кампании)). Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдеров BitCall и iVoice. Для BitCall по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием). Для iVoice по умолчанию подразумевается параметр 'response', при этом будет возвращен JSON с ответами абонента на заданные вопросы (в зависимости от сценария)

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, ZipPath) - Добавляет файл SrcPath в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл из строки Data в архив и располагает его по пути ZipPath. -ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

'''Функции общего назначения''':

'''ExecSimpleScript(Caption, Text)''' - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

'''FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns,ShowAll])''' - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. ShowAll - показать все дополнительные услуги, по умолчанию false и показывает только услуги с начислениями. Функция возвращает количество использованных столбцов.

'''PrintSticker(Codes, [ToBoxes=False])'''

'''PrintBlanc(Codes, BlancNumber)''' - печатать форму из раздела "Заполнить бланк". Codes - коды корреспонденций, BlancNumber - номер формы из раздела "Бланки для корреспонденции" (3)

'''GetItemByName(Name)'''

'''GetA4Printer''' - возвращает имя принтера выбранного для печати документов

'''GetStickerPrinter''' - возвращает имя принтера выбранного для печати стикеров

'''GetDuplexPrinter''' - возвращает имя принтера выбранного для двусторонней печати, если принтер не выбран, возвращает пустую строку

'''PrintAttachPDFPage(Code, FileName, Page, Printer)''' - печатает страницу из вложенного файла PDF. Code - код вложения (attachment), Page - номер страницы, Printer - 0 = принтер A4, 1 = принтер этикеток.

'''AttachPDFToText(Code, [TextFileName])''' - преобразует файл PDF из вложений в текст. Code - код вложения (attachment), TextFileName - имя текстового файла, в который записывается результат (если не указан, используется временный файл). Возвращает текст в виде строки.

'''GetActiveForm([SkipFormName])''' - возвращает код активной формы в программе где происходит сканирование. SkipFormName - не обязательны параметр, имя формы которую нужно пропустить при определении интерфейса.
'''Список интерфейсов''':
0 - неопределенный;
1 - прием корреспонденции на склад;
2 - АПД;
3 - комплектация адресов (ShelfingForm);
4 - доска приема;
9 - вкладка «Манифесты»;
10 - Инвентаризация корреспонденции;
11 - АПК;
12 - вкладка «Адреса»;
13 - вкладка «Выдача»;
14 - вкладка «Склад»;
15 - Список номенклатуры;
16 - Инвентаризация склада;
17 - Приходная накладная;
18 - Списание товара;
19 - Карточка корреспонденции.

'''AddAddressScanLog(Code[, StrBarCode, IsManual, FromInterface, ExtraInfo])''' - добавляет событие сканирование для корреспонденции с кодом Code. Необязательные параметры: StrBarCode - сканируемый ШК корреспонденции (по умолчанию пустой), IsManual - галка ручного сканирования (по умолчанию false), FromInterface - код интерфейса сканирования (StateType=81, по умолчанию 0 - неопределенный), ExtraInfo - текстовый комментарий события.

'''RuleName(alias)''' - Выдает полный путь в дерева прав по псевдониму права.

'''ShowText(Caption:string, Value:string)''' - показывает пользователю окно с заголовком Caption и с многострочным полем со значением Value. Может быть полезен при отображении логов выполненной операции.

'''ShowScanError(msg [, Speek])''' - выдает пользователю окно с текстом msg блокируя последующие действия сканирования. Если Speek - истинно, то сообщение проговаривается голосовым движком, по умолчанию выключено.

'''CheckRule(alias)''' - функция проверки разрешения у текущего пользователя системы, alias - псевдоним права. Возвращает 1, если право есть и 0, если права нет.
Пример: if(CheckRule('RSE'), ShowMessage('У пользователя есть право изменять счета'), ShowMessage('У пользователя нет права изменять счета'));

'''GetKurierMoney(KurierCode, DateEnd, NonCash)''' - возвращает баланс курьера с кодом KurierCode на дату DateEnd. NonCash - булевый флаг, если истинно, то будет рассчитан безнальный баланс;

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

ClientTown - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

== Объект TFieldObject ==
Создается только автоматически. Объект для доступа к записям, используется в картах и доп.услугах.

_GETTABLEINFO - возвращает данные о полях и примеры данных объекта.

== Объект TMessage ==
Создается только автоматически. Объект используется для скриптовой обработки письма в [https://wiki.courierexe.ru/index.php/%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8F_%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8#.D0.98.D0.BC.D0.BF.D0.BE.D1.80.D1.82_.D0.B4.D0.B0.D0.BD.D0.BD.D1.8B.D1.85| заданиях импорта данных]. В себе содержит текст письма в очищенном формате и оригинальном формате HTML, отправитель письма, тему письма, дата получения и список прикрепленных файлов.

'''Message.Text''' - возвращает очищенный от HTML-тегов текст письма.

'''Message.HTMLText''' - возвращает оригинальный текст письма со всеми HTML-тегами.

'''Message.Sender''' - возвращает email-адрес отправителя письма.

'''Message.AttachmentsCount''' - возвращает количество вложенных файлов.

'''Message.DateTime''' - возвращает дату и время получения письма.

'''Message.Subject''' - возвращает тему письма.

'''Message.GetAttachmentDataString(Number)''' - возвращает вложенный файл под номером Number в виде строки.

'''Message.GetAttachmentName(Number)''' - возвращает имя вложенного файла под номером Number.

== Объект TStringList ==
Может использоваться для построчной обработки многостраничных файлов либо для организации текстовых данных. Номер строк начинается с 0.
Имеет следующий функционал:

'''Count''' - возвращает количество строк в списке.

'''Add(Value:string)''' - добавляет значение Value в конец списка.

'''Insert(Number:integer, Value:string)''' - добавляет строку Value в позицию Number.

'''Delete(Number:integer)''' - удаляет строку из списка в позиции Number.

'''Clear''' - очищает элементы списка.

'''LoadFromFile(Path:string)''' - загружает текстовый файл по пути Path.

'''Strings(Number:integer)''' - возвращает строку с номером Number.

'''SetString(Number:integer, Value:string)''' - устанавливает значение строки с номером Number в значение Value.

'''Text''' - возвращает полный список строк в виде текста.

'''CommaText([Quoted:boolean])''' - возвращает список значений через запятую. Если Quoted = true, то квотирует элементы списка. По умолчанию равен false.

'''SetCommaText(Value: string)''' - разбивает значение Value на отдельные строки и кладет в список. Разделитель - запятые.

'''IndexOf(Value:string)''' - ищет значение Value среди элементов списка и если находит, то возвращает номер строки. Возвращает -1 если значение не было найдено.

'''Sorted(Value:boolean)''' - устанавливает флаг отсортированности списка в Value. Если Value = true, то сразу же его сортирует. По умолчанию Value = false.

'''Exchange(Pos1:integer, Pos2:integer)''' - меняет элементы списка с позициями Pos1 и Pos2 местами.

'''Duplicates(Value:integer)''' - изменяет параметр управления дубликатами в списке. Если Value = 0 (значение по умолчанию), то список не реагирует на дубликаты. Если Value = 1, то список при добавлении будет игнорировать дубликаты. Если Value = 2, то список будет выдавать исключение, при добавлении дубликата в список.

'''ParamName(Number:integer[, Delimiter:string])''' - возвращает текст до первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает пустоту.

'''ParamValue(Number:integer[, Delimiter:string])''' - возвращает текст после первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает всю строку.

== Применение языка формул ==
'''в различных контекстах системы «MEASOFT» и сопутствующих проектах'''

=== MEASOFT ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с уровнем (pricelevel) меньше текущего.

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===

{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-

Статусная модель

2025-07-21T13:17:24Z

OlegD: /* Статусы трекинга */

=Виды статусов =
Основные виды статусов, связанные с доставкой отправлений:
* статус корреспонденции — пользовательский статус отправления, отображается в [[Карточка корреспонденции#Общие поля|карточке корреспонденции]]. Значения можно добавлять и изменять в справочнике '''Статусы''' > '''15 Статусы корреспонденции''';
* статус срочного заказа — системный статус выполнения [[Срочные заказы#Вкладка «Срочные»|срочного заказа]]. Статусы определены в справочнике '''Статусы''' > '''3 Статусы для срочных'''. Вы можете изменить название статуса и цвет, которым окрашена соответствующая строка в таблице. Количество статусов изменить нельзя;
* статус клиента — дополнительные статусы отправления, настраиваются по просьбе клиента в случае использования своего набора статусов. Подробнее см. раздел [[Клиенты и партнеры#Основное|«Клиенты и партнеры»]];
* статус манифеста — системные статусы, хранятся в справочнике '''Статусы''' > '''43 Системные''' > '''63 Статусы манифестов'''. Статусы нельзя изменять, можно выбрать их цвета. Подробнее см. в разделе [[Манифесты#Статусы манифеста|«Статусы манифеста»]];
* статус со слов курьера — статус доставки, который сообщает курьер, отображается на вкладке [[Выдача корреспонденции курьерам#Вкладка «Выдача»|'''Выдача''']]. Значения статуса хранятся в справочнике '''Статусы''' > '''43 Системные''' > '''64 Статусы со слов курьера'''. Если включена переменная '''Справочники''' > '''Переменные''' > '''Выдача''' > '''Использовать статус со слов курьера в первую очередь''', то в карточке корреспонденции в поле '''Инфо о доставке''' копируется примечание, которое курьер указал в мобильном приложении при проставлении статуса недоставки, и вне зависимости от статуса выдачи всегда будет проставлен тот, который указан в статусе со слов курьера;
* статус выдачи — статус доставки, которые [[Выдача корреспонденции курьерам#Статус выдачи|устанавливает]] менеджер в офисе при приемке работы курьера, отображается на вкладке [[Выдача корреспонденции курьерам#Вкладка «Выдача»|'''Выдача''']]. Значения статуса хранятся в справочнике '''Справочники''' > '''Статусы''' > '''8 Статусы выдачи'''. Пользователи могут только переименовывать и назначать цвета статусов выдачи;
* статусы трекинга — системные статусы, устанавливаются автоматически, пользователь не может их изменить. Значения статуса хранятся в справочнике '''Справочники''' > '''Статусы''' > '''43 Системные''' > '''1 Статусы трекинга'''.

==Статусы трекинга ==

Статусы трекинга отображаются:
* в карточке отправления — '''Функции''' > '''История статусов''';
* в ответах на запрос по [[API#Запрос статуса заказов|API]];
* в [[Личный кабинет курьерской службы#Отслеживание заказа по номеру|трекинге]] заказа в личном кабинете;
* в информации по заказу в ЛК клиента, в офисной системе можно вывести столбец со статусами на вкладке '''Адреса'''.

В таблице ниже указаны события, при наступлении каждого из которых устанавливается определенный статус трекинга.

{|class = "wikitable" style = "width: 80%;"
!Код статуса
!Название
!В каких случаях устанавливается статус
|-
|AWAITING_SYNC||Ожидает синхронизации||Служба доставки еще не получила данные заказа
|-
|NEW||Новый||Добавлено отправление на вкладке '''Адреса'''
|-
|NEWPICKUP||Создан забор||Добавлено отправление на вкладке '''Адреса''' типа «забор» (номер 0)
|-
|PICKUP||Забран у отправителя||Если отправлению типа «забор» установили статус «Доставлено» или доставочную кор-ию приняли через мобильное приложение по забору или в мобильном приложении в заявке на забор установлен статус «Получено».
|-
|WMSASSEMBLED||Скомплектован на складе фулфилмента||На складе ответственного хранения скомплектовали отправление
|-
|WMSDISASSEMBLED|| Разукомплектован на склад фулфилмента||На складе ответственного хранения разукомплектовали отправление
|-
|ACCEPTED||Получен складом||Отправление [[Прием корреспонденции на склад#Прием корреспонденции|принято]] на склад
|-
|CUSTOMSPROCESS||Производится таможенный контроль||Установлен статус отправления, указанный в переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Статусы таможенного контроля в процессе'''. Подробнее см. раздел [[Манифесты#Таможенное оформление отправления|«Таможенное оформление отправления»]]
|-
|CUSTOMSFINISHED|| Таможенный контроль произведен||Установлен статус отправления, указанный в переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Статусы пройденного таможенного контроля'''. Подробнее см. раздел [[Манифесты#Таможенное оформление отправления|«Таможенное оформление отправления»]]
|-
|CONFIRM||Согласована доставка||Установлен статус отправления, указанный в переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Статусы успешного согласования доставки'''
|-
|UNCONFIRM||Не удалось согласовать доставку||Установлен статус отправления, указанный в переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Статусы НЕ успешного согласования доставки'''.
|-
|DEPARTURING||Планируется отправка||Отправление запланировано в манифест
|-
|DEPARTURE||Отправлено со склада||В манифесте указали дату отправки и отсканировали отправление в мешок
|-
|INVENTORY||Инвентаризация||Отправление отсканировано в интерфейсе функции [[Функции#Инвентаризация корреспонденции|«Инвентаризация корреспонденции»]]
|-
|PICKUPREADY||Готов к выдаче||Если получатель — ПВЗ, и отправление принято на ПВЗ
|-
|DELIVERY||Выдан курьеру на доставку||Отправление выдается курьеру, статус в выдаче — «На руках»
|-
|COURIERDELIVERED||Доставлен (предварительно)||Отправлению установлен статус со слов курьера '''Доставлено''' или статус в выдаче '''Доставлено'''
|-
|COURIERPARTIALLY||Частично со слов курьера||Установлен статус со слов курьера «Частично доставлено»
|-
|COURIERCANCELED||Отказ со слов курьера ||Установлен статус со слов курьера «Не доставлено»
|-
|COURIERRETURN||Возвращено курьером (курьер вернул на склад)||Курьер не смог доставить отправление получателю и вернул заказ обратно на склад. Это промежуточный статус, после которого оператор выясняет, нужно ли еще раз доставлять заказ или это окончательная недоставка. Статус отправления в выдаче «Не доставлено» или «Не доставлено по причине»
|-
|DATECHANGE||Перенос||Изменена плановая дата доставки. На проставляется, если у корреспонденции только один статус "Новый"
|-
|COMPLETE||Доставлен||В карточке отправления указаны дата и время вручения
|-
|PARTIALLY||Доставлен частично||В карточке отправления указаны дата и время вручения, но есть возвраты вложений
|-
|CANCELED||Не доставлен (Возврат/Отмена)||В карточке отправления указана только дата вручения, без времени
|-
|RETURNING||Планируется возврат||Отправление отсканировано в интерфейсе [[Акты_передачи_денег_и_корреспонденции#Акты передачи корреспонденции (АПК)|АПК]]
|-
|RETURNED||Возвращен||В АПК указали дату отправки
|-
|LOST||Утрачен||В карточке корреспонденции установлен флажок '''Утрачено'''
|-
|PARTLYRETURNING||Планируется возврат остатков||Заказ с частичной доставкой добавлен в АПК
|-
|PARTLYRETURNED||Остаток возвращен||По АПК проставлена дата возврата для заказа с частичной доставкой
|-
|TRANSACCEPTED||Прибыл на склад перевозчика||При проставлении даты доставки в манифесте
|-
|PICKUPTRANS||Забран у перевозчика||При проставлении даты получения в манифесте
|-
|STORETAKE||Принят в работу на складе||При взятии в работу на вкладке Склад или при первой складской операции
|}

Дополнительные возможности

2025-06-27T13:42:18Z

OlegD: /* Настройка документов */

== Настройка для печатной документации ==

'''CustomGivnAct''' - Функция позволяет заменить печатную форму, акта передачи материальных ценностей (печать из выдачи) на пользовательскую. Включить использование этой возможности можно в переменных "Справочники" -> "Переменные" -> "Печать" -> "Акты передачи курьеру" -> "Печатная форма акта: Пользовательская".
Объявленные переменные
%code% - коды записей в выдаче которые необходимо распечатать
%docdate% - дата установленная в выдаче
%dockurier% - ФИО курьера показанного в выдаче
%dockurierfull% - Значение выбранного элемента в дереве (если есть выбранный узел дерева , иначе фио курьера)

Пользовательская форма акта, будет печататься только по заказам со статусом "На руках".

'''OnBeforePrintNakls''' - Вызывается перед печатью накладных, содержит %code% - коды всех адресов (через запятую).

'''OnAfterPrintNakls''' - Вызывается после печати накладных, содержит %code% - коды всех адресов (через запятую).

'''OnBeforePrintOneNakl''' - Вызывается перед печатью накладной, содержит %code% - код адреса.

'''OnAfterPrintOneNakl''' - Вызывается после печати накладной, содержит %code% - код адреса.

'''OnBeforePrintSticker''' - Вызывается перед печатью наклейки, содержит %code% - код адреса, %barcode% - ШК наклейки.

'''OnAfterItemPrint''' - Вызывается после печати наклейки из карточки номенклатуры. Поддерживает поля ввода - input. Содержит %code% - код номенклатуры item.code, %Naimen% - наименование, %country% - название страны, %Count% - указанное количество копий к печати.

'''PrintCustomSticker''' - Функция позволяет установить пользовательскую печатную форму для наклеек (из интерфейса "Печать ведомостей/наклеек"). Вызывается если выбран тип наклейки 15 (переменная StickerForm). Содержит %RectLeft%, %RectTop%, %RectRight%, %RectBottom% - границы прямоугольника на холсте принтера, в которые надо печатать (для поддержки табличной печати на A4), %RecNumber% - номер текущей записи датасета, %CurrentBarCode% - ШК, рассчитанный в зависимости от параметров в интерфейсе "Печать ведомостей/наклеек". %ACopyNo% - номер копии, нумерация с 1. %KolvoStr% - Стандартный текст "текущее место/всего мест", с учетом возможной печати этикетки на одно место из нескольких. Также содержит весь датасет, использующийся в других типах наклеек. В момент вызова функции, принтер уже запущен и начат документ, объект TPrinter в функции создавать не нужно, необходимо только создать объект TCanvas, он создастся как ссылка на текущий холст принтера.

'''PrintItemSticker''' - Вызывается перед печатью наклейки из карточки номенклатуры, для возможности распечатать уникальную наклейку для номенклатуры по заложенным в допвозможности условиям. Содержит %clientbar% - ШК наклейки. Если наклейка распечатана из допвозможности возвращает true, в противном случае false и будет распечатана стандартная наклейка, заложенная в системе

'''ChangeSchetDetailQuery''' - Вызывается формировании / пересчете счета. Возвращает строку разбитую через CRLF на две. Первая строка заменяет поля в запросе по детализации счета, вторая меняет строку группировки. Обязательные поля: zakazcnt - кол-во заказов, price - стоимость курьерских услуг, cnt - количество, pr - общая стоимость курьерских услуг.

'''OnAutoPrintManSticker''' - вызывается перед автопечатью сопроводительного документа к манифесту при заполнении номера пломбы (такая возможность включается уставкой печатаемой формы в переменной AutoPrintManSticker), содержит %code% - код манифеста, %mnf_date% - дату манифеста, %transporter% - код перевозчика, %store% - код филиала-получателя манифеста. Если доп.возможность возвращает true - автопечать происходит, false - нет.

'''OnBeforePrintAddresses''' - Вызывается из формы печати ведомостей/наклеек после нажатия на кнопку "ОК", содержит %code% - коды всех адресов (через запятую).

== Настройка всплывающих окон==

'''OnGivnStateChanged''' - Вызывается в транзакции при изменении статуса выдачи. В параметре %code% указан код выдачи. В %pickupDocId% указан код на таблицу docs, документ приема забранных корреспонденций у курьера (доска приема при закрытии забора). Переменная %RetNotScanned% принимает значение true, если при установленной переменной "Запрашивать возвратные документы при приеме" = "Требовать маркировки наклейкой" пользователь не стал сканировать наклейку.

'''OnAfterGivnStateChanged''' - Вызывается после транзакции, при изменении статуса выдачи. В параметре %code% указан код выдачи. В %pickupDocId% указан код на таблицу docs, документ приема забранных корреспонденций у курьера (доска приема при закрытии забора)

'''OnBeforeAddressSave''' - Вызывается перед сохранением изменений в карточке корреспонденции. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В качестве параметра передан объект fieldlist (объект полный аналог addressrecord в доп. услугах). . Если результат функции -1, то происходит отмена сохранения без ошибки (abort).

'''OnBeforeBaseSave''' - Вызывается перед сохранением изменений в карточке срочного заказа. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В качестве параметра передан объект fieldlist (объект полный аналог таблицы base). Теги %date_put%, %time_put%, %message% - содержат дату вручения, время вручения и инфо о доставке соответственно. Если результат функции -1, то происходит отмена сохранения без ошибки (abort).

'''OnAfterAddressSave''' - Вызывается после сохранения карточки корреспонденции в транзакции. Тег %code% - равен коду адреса; %Form3FrameMode% равен 1, если корреспонденция заполняется из интерфейса: "Функции - Ввод заявок по фото".

'''OnBarScan''' - Скриптовая обработка штрих-кода перед поиском

'''AfterAddressAcceptance''' - Событие после приема корреспонденции на склад (например,заказы - прием корреспонденции). Код выполняется не в транзакции и есть возможность показывать диалоговые окна. Содержит %Code% - код адреса, %StrBarCode% - отсканированный штрих-код. При вызове из интерфейса доски приема либо приема корреспонденции передается дополнительный тег %NewMass%, который содержит массу проставленную весами, содержит -1 если проставление массы отключено.

'''BeforeAddressAcceptance''' - Событие перед приемом корреспонденции на склад (например,заказы - прием корреспонденции). Код выполняется в транзакции. Содержит %Code% - код адреса; %StrBarCode% - отсканированный штрих-код; %mass% - массу, если значение меньше 0 значит весы выключены; %l%, %w%, %h% - габариты; %MultiBarCode% - истина если это наклейка на место; %SetKolvo% - проставлять принятые места, место может быть уже принято; %ClientCode% - код клиента (clients.code); %PackCode% - код места (packages.code) . Если функция возвращает значение больше 0, то это будет новой массой места или корреспонденции.

'''OnAddToShippingPlace''' - событие после добавления корреспонденции в мешок манифеста. Код выполняется в транзакции. Содержит %сode% - код адреса, %BarCode% - штрих код который отсканировали,%ShippingPlace% - код мешка

'''GetTypeShippingPlace''' - событие перед добавлением корреспонденции в мешок манифеста. Задача события распределить корреспонденцию между мешками. Результат функции код мешка, в который необходимо поместить корреспонденцию. Содержит %сode% - код адреса.

'''OnBeforePlanToManifest''' - событие перед планированием корреспонденции в манифест. Предназначено для дополнительных проверок. Выполняется до транзакции. Содержит %code% - код манифеста, %AddrList% - список кодов адресов через запятую. Объявление события отменяет системную проверку на возможность доставки адреса филиалом получателя, ее нужно реализовывать в этом событии.

'''OnBeforeScanToManifest''' - событие перед добавлением корреспонденции в мешок манифеста. Предназначено для дополнительных проверок. Выполняется до транзакции. Содержит %code% - код манифеста, %Address% - код помещаемого адреса

'''OnBeforePlanning''' - событие перед планированием одного или нескольких отправлений на курьера. Содержит %сode% - код курьера, %AddressCodes% - код(ы) планируемых корреспонденций.

'''OnAfterPlanning'''- событие после планирования планированием одного или нескольких отправлений на курьера. Содержит %сode% - код курьера, %AddressCodes% - код(ы) фактически запланированных корреспонденций.

'''DAILY''' - задание выполняемое один раз в день

'''OnGivnKurierStateChanged''' - событие вызывается после изменений данных со слов курьера (статуса, времени или причины недоставки). Вызывается даже при получении данных из мобильного приложения курьера. В событии запрещено показывать диалоги, т.к. это может остановить синхронизацию данных с ЛК. Содержит %сode% - код выдачи.

'''OnBeforeGivnStatus''' - событие срабатывает перед установкой статуса выдачи, не в транзакции. В параметре %code% указан код выдачи, %status% - устанавливаемый статус,%kurier% - код курьера, %date% - дата выдачи, %address% - код адреса

'''OnBeforeClientSave''' - событие срабатывает перед сохранением изменений в карточке клиента. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В качестве параметров переданы %code% (содержит код клиента) и объект fieldlist (полный аналог addressrecord в доп. услугах), который содержит ещё не сохранённую информацию о карточке клиента, а так же все её пользовательские поля. Если результат функции -1, то происходит отмена сохранения без ошибки (abort).

'''OnAfterClientSave''' - событие срабатывает после сохранения изменений в карточке клиента. Код выполняется в транзакции. В качестве параметров переданы %code% (содержит код клиента) и объект fieldlist (полный аналог addressrecord в доп. услугах), который содержит сохранённую информацию о карточке клиента, а так же все её пользовательские поля с предыдущими значениями, которые можно получить через функцию _Former('VarCode', значение, 'VarValue')

'''OnBeforeBasePutCheck''' - событие срабатывает при проставлении галки на вкладке срочных заказов. Код выполняется не в транзакции и есть возможность показывать диалоговые окна. В параметре <nowiki>%code%</nowiki> указан код срочного заказа, а в параметре <nowiki>%BasePutCheckType%</nowiki> указан тип проставления: 0 - если галка, 1 - если плюс. Если результат функции -1, то отмена выполняемой функции (abort).

'''OnAfterCreateSpecialSMA''' - событие срабатывает после создания нового АПД для клиента. Код выполняется вне транзакции, потому есть возможность показывать диалоговые окна. В качестве единственного параметра %code% передается код созданного АПД.

'''OnBeforeReturnIncome''' - Событие перед приемом возврата на вкладке выдача. Код выполняется вне транзакции. Содержит %Code% - код адреса. Функция заполняет две переменные: ''$mass'' - масса возврата корреспонденции (проставляется только если значение переменной больше нуля, а если это значение больше массы корреспонденции, то будет использовано в качестве массы места) и ''$kurier'' - код вернувшего курьера (если пустое или равно нулю, то проставляется стандартный код курьера ВОЗВРАТ НА СКЛАД [15]).

'''OnBeforeCreatePickup''' - Событие перед созданием забора правой кнопкой мыши в списке заказов. Код выполняется вне транзакции. Содержит %Code% - код заказа. %FromCompany% - компания, у которой осуществляется забор (поле target), %FromAddress% - адрес забора

'''AfterTicketAnswer''' - Событие происходит после ответа на тикет. %code% - код сообщения, %TimeSpent% - кол-во потраченных минут, %ticket% - номер тикета. Доп. возможность может отключить стандартный ввод затраченного времени, для этого нужно вернуть любое значение.

== Настройка документов ==
'''CustomAddressPrnForm2''' - Кастомная реализация упрощенной печатной формы. В карточке заказа установлена галка Простые, и установлена переменная "Справочники" -> "Переменные" -> "Печать" -> "Упрощенные печатные формы" -> "Тип упрощенной печатной формы: 5"

'''GetTypeShippingPlace''' - Выполняется при помещении корреспонденции в мешок манифеста. Содержит %code% - код корреспонденции. Возвращаемое значение это код мешка (shippingpalce.code), если его указать , то это изменит мешок, в который будет помещена корреспонденция.

'''OnShelvingBarScan''' - Обработка отсканированного штрих-кода при комплектации.

'''AdditionalStringForSMA''' - задает дополнительные условия для формирования АПД (наиболее часто: разделения актов на нал. и безнал, помимо этого практически неограниченные возможности по изменению условий для отбора корреспонденций в акт, учета их доставленности и т.п.) Содержит %code% - код клиента, переменную %ActPayType% со значениями типов оплаты входящих в акт отправлений: "nal" - наличный, "bnal"- безналичный,"all" - все, а ткаже %ActDateTo% - с датой, до которой создается акт. Может возвращать строку, разделенную символами переноса строки. (На 17.09.2021 в возвращаемой строке предусмотрен 1 символ переноса, т.е. строка состоит из двух частей.) В этом случае часть строки до первого переноса будет использоваться в запросе как доп. условие отбора, часть строки после первого символа пеерноса - в качестве дополнительного условия для определения "выполненности" доставки (поле specialsma.Made). С помощью второго модификатора можно сделать например так, чтобы корреспонденции с незаполненными датой/временем вручения считались доставленными.

'''CustomBillDetaling''' - Кастомная детализация счета. Установка переменной $CancelCustomDetail в true, включает вывод стандартной детализации. В переменной $schet - код счета по которому строится детализация.

'''OnSchetChanged''' - Выполняется при удалении счета и его изменении. Содержит %code% - код счета schet.code

'''ExceptionsForAPK''' - Задает дополнительные критерии поиска корреспонденции при формировании акта передачи корреспонденции(АПК). Содержит %Boxes% - псевдоним таблицы вложений используемый в запросе. Функция возвращает !ДВЕ! части sql запроса разделенных CRLF. При отборе в АПК используется два запроса. Первый - отбирает не доставленные заказы и возвраты документов, в него будет подставлено условие слева от разделителя CRLF. Второй запрос отбирает возращенные товары, в него будет подставлено условие справа от разделителя CRLF или вся строка условий если в строке нет разделителя CRLF (оставлено для обратной совместимости, в версии программы до 1115 фильтрация была только во втором запросе). %AdditionalParam% - дополнительный параметр, который можно установить в интерпретаторе при вызове функции CreateAddressTransferAct.
пример кода по умолчанию, фильтр только по второму запросу, вложение с названием "Доставка" - не попадает в АПК
<NOWIKI><?>
SET($ExcStr,' and %Boxes%.Name not like ''%Доставка%'' ');
$ExcStr</NOWIKI>

пример для изменения фильтрации сразу у двух запросов:
<NOWIKI><?>
SET($WHERE1,''); rem('условие отбора не доставленных и возврата документов');
SET($WHERE2, ''); rem('условие отбора возврата товаров');
$WHERE1 + CHAR(13) + CHAR(10) + $WHERE2</NOWIKI>

'''OnOrderCountCalc''' -Для расчета стоимости доставки необходимо учитывать кол-во отправлений. Доп. возможность возвращает часть SQL запроса, уточняющий условия поиска. Содержит %code% - равен значению переменной "Считать кол-во отправлений по текущему месяцу" (UseCurrentMonthCount, нет - 0, да - 1)

'''OnGetZakazCount''' - подменяет стандартный подсчет количества отправлений для расчета стоимости доставки (в том чисте отменяется вызов доп.возможности OnOrderCountCalc). Должна возвращать кол-во корреспонденций. В процедуру передаются следующие переменные: %CntAccType% - вид подсчета: 0-по заказу, 1-за месяц по клиенту; %code% - код клиента (обязателен для вида подсчета 1); %ZakazDate% - дата заказа; %CountByMonthType% - способ подсчета заказов за месяц (1-по текущему месяцу; 0 - по предыдущему); %UseCurrentUrgency% - 1:подсчитывать только корреспонденцию определенного режима срочности; %Mode% - этот режим срочности (при подсчете по заказу учитываются так же связанные режимы срочности, указанные в параметре 5 режима срочности в таблице статусов); %DatePut% - дата доставки (добавлено для альтернативных видов подсчета, может быть null); %SeparateIntercityDelivery% - 1:не учитывать междугородние доставки; В функцию так же передается объект fieldlist.

'''OnSMABarcodeScan''' - событие вызывается при сканировании штрихкода АПК в списке актов. %code% - код АПК (sendmoneyact.code)

'''OnPaintSMAColumns''' - вызывается при прорисовке таблицы в форме списка АПД/АПК. В функцию передается DataSet, содержащий поля таблиц SendMoneyAct и Clients, а так же пользовательские поля клиентов, называющиеся ufX, где X - номер поля (в статусах). Функция должна возвращать строку следующей структуры:
Поле1_таблицы, Цвет_фона, Поле2_таблицы, Цвет_фона и т.п. Возврат нечетного числа параметров эквивалентен возврату пустой строки (цвет не меняется)

'''CustomZPDetail''' - кастомное дополнение к детализации зарплаты (Специальная надбавка). Вызывается из скриптовой детализации зарплаты. Предназначено для расчета и вывода в детализацию значения какой-либо специальной надбавки, определенной пользователем. Входящие параметры: %code% - код платежа в таблице kurier_pays, %kurier% - код курьера. Возвращает строку, где через запятую указаны Название надбавки и ее значение. Если эта строка не содержит двух параметров - ничего не выводится.

'''ZPAdditionalSheets''' - кастомное дополнение к детализации зарплаты - дополнительный лист(листы) на форме детализации. В функцию передается DataSet из детализации зарплаты, ссылка на объект Excel (имя - xl). Внутри функции нельзя объявлять объект TSelfAdo с именем DB (он объявлен в детализации). Номер новой страницы Excel передается в переменной $page.

'''OnAddrInventoryAfterCreateDoc''' - вызывается в транзакции, в процедуре создания документа инветаризации корреспонденции. Входящие параметры: %code% - код созданного документа инвентаризации.

'''AddrInventoryAdditionalSQL''' - позволяет модифицировать запрос на создаваемый документ инвентаризации корреспонденции. Используется для наложения дополнительных фильтров. Входящие параметры: %code% - код созданного документа инвентаризации. %header% - часть SQL запроса в которую необходимо сделать вставки, возможные варианты join, where.
Пример использования '''AddrInventoryAdditionalSQL''', добавление фильтра по пользовательскому полю.
<source lang="SQL">
<?>
if('%header%'='join', 'left join userfields uf on uf.sourcecode=b.source and uf.sourcetable=2 and uf.varvalue=1',
if('%header%'='where', 'and ifnull(uf.varvalue, "F") = "T"'
,''))
</source>
.

== Настройка вида маркера ==
Настройки находятся в "Отчеты" -> "Дополнительные возможности" - "Системные". <br />

В функции передается объект Table2Map типа [[Руководство программиста#Объект TFieldObject|TFieldObject]]. Получить поля с примерами значений из него можно например так:
showmessage(table2map._GETTABLEINFO)
(текст большое сообщения можно скопировать в буфер комбинацией Ctrl-C).

Для доступа к данным пользуйтесь только этим объектом, т.к. любое обращение к базе приведет к значительному снижению скорости работы.

Так же текущее состояние окна карты доступно через переменные:

$PlanDate - Выбранная дата, на которую планируется.

$KurierCode - Код выделенного курьера.

$MetroCode - Код выделенной станции метро (маршрута).

Обратите внимание, что все ошибки, возникающие при отрисовке, подавляются системой. Поэтому, если вы допустите ошибку в скрипте, он просто не будет работать, никаких сообщений вы не увидите. Для отладочных целей можно заменить ошибки на сообщения такой конструкцией:

set($s, try(
error('вот тут ошибка, которую вы увидите в виде сообщения');
));
if($s, showmessage($s), '');

'''MapObjectFigure''' - Доп. возможность позволяет установить вид маркера на карте. Результат определяет фигуру: 1 - перевернутый треугольник (острым концом вниз), 2 - треугольник, 3 - увеличенный перевернутый треугольник (острым концом вниз), чтобы квадрат не мог его перекрыть, 4 - квадрат, 5 - ромб, все остальное круг. Ромб поддерживается с версии 960.<br/>
Например:
if(table2map.zabor, 2, if(StrDateToFloat(table2map.DatePeriod) = $PlanDate, 3, 4))
Выводит треугольник, если отправление - забор. Иначе - если дата план отправления равна дате, на которую планируется - увеличенный перевернутый треугольник, иначе - квадрат.

'''MapObjectColor''' - Доп. возможность позволяет установить цвет маркера на карте.
При помощи данных параметров можно создать условия отображения маркеров.<br/>

Для доступа к настройкам доступны переменные:

$Color

$DefaultColor

$PlanedColor

$SelectedPlanedColor

$GetKurierColor

Например:
if((table2map.kurier<20)*(StrDateToFloat(table2map.DatePeriod) = $PlanDate), 16753920, $color)
Не запланированные отправления на текущий день будут отображаться выбранным цветом, иначе - цветом по-умолчанию.

== Речь диктора ==

'''OnGivnVoice''' - выполняется после изменения статуса выдачи. Параметр <nowiki>%code%</nowiki> содержит код выдачи, <nowiki>%State%</nowiki> содержит код устанавливаемого статуса, <nowiki>%OldState%</nowiki> - код старого статуса (0 если не было). Позволяет отключать стандартный звук ОК, если возвращает не 0.

'''OnDashboardManifestVoice''' - выполняется после сканирования адреса в интерфейсе приёма манифестов. Параметр <nowiki>%code%</nowiki> содержит код корреспонденции. Позволяет отключать стандартную диктовку программой (код курьера, вес и т.д.), если возвращает не 0.

== Настройка мобильного приложения ==

== Скрипты ==
'''OnEveryStartApp''' - выполняется при запуске программы.

'''OnEveryCloseApp''' - выполняет при закрытии программы.

'''OnBarScan''' - выполняется при получении ШК со сканера, в параметре %code% - получаем ШК. Если функция, что-то возвращает, то система будет использовать возвращенный ШК.

'''OnMapBeforeGeolocation''' - Вызывается перед отображаем адреса на карте. В функцию передается объект fieldlist.
Пример скрипта, переводящий адреса в НЕ найденные на карте, если станция метро НЕОПЕРЕДЕЛЕННАЯ.
<NOWIKI><?>
if(station=0,
_set('lon', null);
_set('lat', null);
_set('searchCoordinate', 'F');
,0)</NOWIKI>

'''OnSyncInsert''' - Выполняется для каждой добавленной записи при синхронизации с ЛК. Содержит %tablename% - название синхронизируемой таблицы.

'''OnSyncUpdate''' - Выполняется для каждой обновленной записи при синхронизации с ЛК. Содержит %tablename% - название синхронизируемой таблицы.

Если при получении новых адресов с ЛК, нужно поменять любое поле в таблице address, то необходимо использовать сразу два события OnSyncInsert и OnSyncUpdate. Адреса без вложений обрабатываются событием OnSyncInsert, адреса с вложениями будут обрабатываться событием OnSyncUpdate. Это связано с механизмом синхронизации, если в событии OnSyncInsert, проапдейтить поле в адресе с вложениями, то данные могут потеряться.
Когда адрес без вложений, то у него сразу station = 65535 и можно апдейтить. Если с вложениями, то у него сначала station = 65534, а после синхронизации вложений есть отдельный апдейт на 65535. Пример кода, для апдейта поля в адресах, события OnSyncInsert и OnSyncUpdate:
<NOWIKI>

<?>
rem(ticket 23584, 23583);
if( ('%tablename%'='address'),
query('UPDATE address a
JOIN trace t ON t.address=a.code AND t.state=1
JOIN zakaz z ON z.code=a.zakaz
SET
a.mode = IF(z.source=646, 3, 2)
WHERE
a.code = %code%
AND a.station=65535
AND (
(z.source=646 AND a.mode<>3) OR
(A.DATE_PUTN=DATE(t.Statetime) AND a.mode=1) OR
(A.DATE_PUTN=DATE_ADD(DATE(t.Statetime), INTERVAL 1 DAY) AND TIME(t.Statetime) > "21:59:59" AND a.mode=1)
)')
, '');</NOWIKI>
;

'''OnCalcSalary''' - Событие происходит после начисления зарплаты курьеру. %code% - код созданного начисления kurier_pays.code ; %dateto% - дата до которой рассчитали зарплату; И отдельно части зарплаты: %profit% -итоговая сумма; %Zarab% - сдельная часть; %Oklad% - оклад; %Friends% - выплаты за приведенных; %Other% - разное; %AgentMoney% - агентское вознаграждение; %StandingMoney% - Доплата за стаж; %Bonus%, %Shtraf% - бонусы и штрафы.

'''OnTicketSetCusr''' - Пользовательский скрипт перед назначением ответственного в тикетах. %code% - код тикета; %Cusr% - код назначаемого пользователя (может быть равно NULL)

'''OnCreateAddressForActDelivery''' - Пользовательский скрипт вызывающийся в момент формирования корреспонденции на доставку АПД/АПК. Позволяет существенно доработать формируемую корреспонденцию. %code% - код акта sendmoneyact.code, %Client% - код клиента; %delivery% - флаг определяющий корр. на доставку акта (1, значение по умолчанию) или забор акта. fieldlist - объект с полями адреса (повторяет структуру таблицы address), dataset - объект дополнительными полями функции. Объект fieldlist является классом TMyFieldList и позволяет менять значения полей. Также измененный адрес можно сохранить прямо в событии, или он будет сохранен автоматически после выполнения скрипта. Для сохранения адреса используйте метод _save.

Пример, для клиента с кодом 3360, в корреспонденцию на доставку АПК, добавляем список корреспонденций попавших в него во вложения.
<source lang="sql">
<?>
if((client=3360)*(ActType=2),
rem('Ticket 70827, 2022-09-07 Anatoly and Sergey');
set($addresscode, fieldlist._save);
query('insert boxes (address, pos, name)
select '+$addresscode+' AS address, @q := @q + 1 AS pos,
CASE WHEN a.client_id <> '' THEN a.client_id WHEN a.strbarcode<>'' THEN a.strbarcode ELSE CONCAT(a.zakaz,"-", a.number) END AS `name`
FROM addressfld af
JOIN address a ON a.code=af.`address` ,(SELECT @q := 0 ) p
WHERE
af.`AddrTransferCode` = %code% AND af.`ReceivedInTransfer` > 0');
,0);
</source>

'''OnAfterPreassemblyScan''' - событие происходит после сканирования складского товара в корреспонденцию на вкладке «Склад». %code% - код корреспонденции, %ItemCode% - код товара, %ItemCnt% - количество отсканированного товара.

'''OnGeocodeScript''' - скрипт подключения к геокодеру клиента. Используется при включенной переменной "Справочники" -> "Переменные" -> "Подключения" -> "Карты" -> "Геокодирование" -> "Протокол геокодирования: Клиентский (скрипт OnGeocodeScript)". Имеет встроенные переменные:
*$address - адрес для геокодирования;
*$town - код города;
*$street и $home - упрощенный адрес;

Скрипт должен вернуть следующие переменные :
*$lon и $lat - координаты ;
*$goodaddress - нормализованный адрес (не обязательно);

<source lang="sql">
<?>
set($response, HTTPPOST('http://XXXXXXXX',
'{"query":'+ FormatTextJSON($address)+ '}',
'','','','',
'post', 'application/json', 10000));

if($response!'',
new('TJSON', 'json');
set($e, try(
json.SetText($response);
json.OpenChild('geo_data');
json.OpenChild('mid');
set($lat, sqlfloat(json.ChildNodeValue('lat')));
set($lon, sqlfloat(json.ChildNodeValue('lon')));
));
if($e, error('Ошибка в разборе ответа: '+$e), '');
, error('Пришел пустой ответ от геокодера')
);
</source>

'''OnFilterAddressRecalc''' - Позволяет отфильтровать коды адресов, для которых можно пересчитать стоимость. Событие происходит перед расчетом стоимости доставки из интерфейса программы для: актов, счетов, заказов, и т.д. Не работает для пересчета запускаемого из самой карточки корреспонденции.
%codes% - коды адресов для пересчета стоимости доставки. Формат: (1,2,3,...). %RecalcUserCode% - код пользователя запустившего пересчет (актуально для отложенных пересчетов).
Функция должна вернуть коды адресов, допущенных к пересчету в формате: (1,2,3,...)

<source lang="sql">
<?>
rem('2023-12-04 Sergey. Отключаем перерасчет стоимости доставки у корреспонденций в статусе - проверено,
если у пользователя нет права Счета-изменять. Тикет 79954.
Блокировка работает в связке с тикетом 77995.');
new('TSelfADO', 'DB');
DB.OPEN('SELECT a.code FROM courier.address a
LEFT JOIN courier.users u ON u.code=%RecalcUserCode%
LEFT JOIN courier.`userrules` ur ON ur.`GroupId`=u.grup AND ur.`RuleType`=1 AND ur.newruleid =78 -- RSA
WHERE ((a.state1<>8) OR (a.state1=8 AND ur.state="T")) AND a.code in %code%');
DB.ParseForIn('CODE')
</source>

'''OnRecalcBoldCntInFrame''' - срабатывает в карточке тарифа при перемещении курсора зоны. Возвращает целочисленное значение, равное количеству доставленных корреспонденций у клиента за предыдущий месяц. Срабатывает только при открытии карточки тарифа из карточки клиента. %ClientCode% - код клиента. %ZoneCode% - код зоны.

'''ChangeStatusColor''' - подменяет цвет фона сообщения в строке статуса в форме приема корреспонденции. Возвращает целочисленное значение - новый цвет фона, 0 - если цвет менять не нужно. Входящие значения: %code% - входящее значение цвета. Остальные переменные - булевского типа - отражают состояние Настроек: %Renum% - Перенумеровывать, %IgnoreDblScan% - Игнорировать ошибки повторного сканирования, %PrintNakl% - Печатать накладные, %Given% - Выдавать отправления, %PrintFiles% - Печатать файлы, %BarLine% - Включить поддержку штрих-кодовой линейки, '%CreateTrans% - формировать кассовые чеки.

'''GetLusrSQL''' - переопределяет столбец "Изменивший пользователь" в истории изменений. Должен возвращать часть SQL запроса для столбца lusr. Входящее значение %code% содержит код таблицы, для которой строится SQL-запрос истории.

Руководство программиста

2025-06-20T12:26:48Z

OlegD: /* Объект TBaseUtils */

== Основные положения ==

В систему «MEASOFT» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

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

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

SET($a, a) – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

IF(a,b,c) или IF(a,b) – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

WHILE(a, b) – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

FOR($a, b, c, d) – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

NEW(ClassName, InstanceName) – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

FREE(InstanceName) – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

ShowObjects – Возвращает список созданных объектов – названия классов и имена.

ERROR(message) – Вызывает ошибку с текстом message.

SHOWMESSAGE(message) – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

SimpleAskUser(Message) – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

TRY(a) – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

REM(….) – Код в скобках игнорируется (комментарий).

EXEC(FileName, Params, Wait, WindowState) – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

=== Строковые функции ===

UpCase(s) – возвращает строку s в верхнем регистре.

LCase(s) – возвращает строку s в нижнем регистре.

Len(s) – возвращает количество символов в строке s.

Pos(s, substr [,start]) – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Параметр start - это позиция старта поиска, не обязательный параметр, по умолчанию равен 1. Поиск не чувствителен к регистру.

Param(s, i) – возвращает i-й элемент строки s, разделенной запятыми на элементы.

ParamsCount(s) - возвращает количество элементов строки s, разделенной запятыми на элементы.

SetParam(s, p, i) – заменяет на значение p i-й элемент строки s, разделенной запятыми на элементы.

Left(s, i [,full] ) – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Mid(s, i, j) - возвращает подстроку из s начиная с i символа и длиной j символов

Right(s, i [,full]) – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Reverse(s) - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

Char(i) – возвращает символ с кодом i.

Ord(s) – возвращает код первого символа строки s.

Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive]) - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

RemSpace(s) – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

SumStr(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

NumToStrSimple(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

FullNameToShort(Name) – Возвращает фамилию и инициалы по полному ФИО Name.

MonthName1(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

MonthName2(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

StrForXML(s) - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

FixedIntToStr(i, len[, char]) - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

Translate(format, [param1, param2, ...]) - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

ExtractFileName(FilePath) - возвращает имя файла с расширением из полного пути к файлу FilePath.

====Функции перекодировки====
DecodeStr(s, charset) - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

EncodeStr(s, charset) - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

Translit(s) - транслитерация строки русского текста s латиницей

UnTranslit(s) - транслитерация строки s с латиницы на русский.

==== Экранирование ====

QUOTEDSTR(s) – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

FormatTextXML(s) - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

FormatTextJSON(s) - переводит строку в формат JSON, экранирует служебные символы.

FormatTextBlob(s) - строка s содержит файл, функция перекодирует переданную строку в байты, используется для заполнения полей формата blob.

====Хеширование ====

HMACHash256(key, text) - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

MD5Hash(text) - создаёт хеш по алгоритму MD5

SignatureUrl(url) - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

CurrTime – возвращает текущее время

CurrDate – возвращает текущую дату

CurrMillisecond - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

Today - возвращает текущую дату в числовом формате.

Day(dt) – возвращает день месяца даты dt.

Month(dt) – возвращает месяц года даты dt.

Year(dt) – возвращает год даты dt.

FirstDayOfMonth(dt) – Возвращает первый день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( FirstDayOfMonth( CurrDate() ) );

LastDayOfMonth(dt) – Возвращает последний день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( LastDayOfMonth( CurrDate() ) );

DaysInMonth(month, year) – Возвращает количество дней в указанном месяце.

IncDay(dt, [count=1]) – Возвращает дату, увеличенную на count дней.

SQLDate(dt) – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

SQLDateToDate(dt) – Переводит дату из SQL-формата в обычный.

DAYSBETWEEN(dt1, dt2) – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimeBetween(t1, t2) - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0], [DefaultHolidayVarNum=1]) - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней(по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

TimePeriod(time1, time2) - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

StrDateToFloat(s, [time=false]) - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

IsAWorkDay(dt) - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

IncWorkDay(dt, [count=1],[DefaultHolidayVarNum=1]) - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней (по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

Sleep(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

INT(v) – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

FLOAT(v) – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

STR(v) – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

Date(v) – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

Time(v) – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

ROUNDUP(f) – округляет число f до ближайшего большего по модулю целого числа.

ROUNDDN(f) – округляет число f до ближайшего меньшего по модулю целого числа.

Money(f, CouldBeEmpty, ZeroFill, MakeSpace) - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.
''Подсказка: для простого округления используется функция int()''

Abs(f) - возвращает модуль числа f.

Mod(x, y) - возвращает остаток от деления целочисленного числа x на целочисленное число y.

=== Константы ===

Null – Возвращает пустое значение.

Да, True, Нет, False – константы, соответствующие булевым значениям.

=== Прочие функции ===

SQLFloat(f) – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding [, append])- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Если append = true, то производится дописывание данных в файл, а не перезаписывание (не обязательный, по умолчанию выключен).

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - Дополнительные заголовки HTTP запроса, передается в виде списка параметров через запятую и всегда образуют пару: 1 параметр - название заголовка, 2 параметр - значение. Если значение содержит запятую то его нужно экранировать в двойные кавычки. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в миллисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

LastHttpError - Выводит последний запрос выполненный с ошибкой в функции HttpPost. Содержит подробную информацию по запросу и ответу.

LastHttpResponse - Выводит последний запрос и ответ от сервера после выполнения Http-запроса в функции HttpPost.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel. Для работы без установленного MS Excel предусмотрен объект TDirectExcel.

'''''Ввод данных'''''

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Если TranslateHeader истинно, то заголовки таблицы будут автоматически переведены.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

Close – Закрывает текущий файл.

'''''Ячейки'''''

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

'''''Строки'''''

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

RowAutoFit([y1, y2]) - Устанавливает автоматическую высоту строк. Аргументы y1 и y2 необязательны и если не указаны, то процедура будет выполнена для всей страницы, в ином случае только для строк от y1 до y2.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

'''''Столбцы'''''

ColCount - Возвращает количество столбцов в листе.

AutoFit – Устанавливает автоматическую ширину столбцов.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SetColWidth (c, w) – Устанавливает ширину столбца c в w символов.

'''''Листы'''''

SetSheet(No) – Устанавливает номер текущего листа. Если лист с таким номером не существует - он будет создан (и все листы до него). Нумерация начинается с 1.

SetSheetName(Name) - Устанавливает название текущего листа.

SheetsCount – Возвращает количество листов в книге.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

SheetDelete(i) - Удаляет лист с номером i.

'''''Форматирование'''''

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

NumberFormat(x1, y1, x2, y2, Format) - Устанавливает формат вывода чисел в указанном диапазоне ячеек. Например, если Format='0.00' - числа будут выводиться c обязательными 2 знаками после десятичного разделителя.

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

SaveValuesOnly - убирает формулы на текущей странице и оставляет лишь их результативные статичные значения.

'''''Цвета'''''

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

'''''Копи-паст'''''

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

'''''Изображения'''''

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0, width=0, height=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки, width, height (не работает для DirectExcel) - ширина и высота области рисунка в пойнтах-единицах Excel

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

'''''Вывод'''''

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр copies - количество копий, по умолчанию равен 1.

Save(filename) - Сохраняет в файл filename. Если файл существует, в основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

'''''Пример использования'''''

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{| class="wikitable"
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|-
|GetSQL
|Для отладки. Возвращает последний SQL запрос переданный в методы Open, Query, GetSQLValue
|-
|ExportExcel
|Для отладки. Выгружает в эксель содержимое датасета. Можно использовать в незнакомом окружении для понимания передаваемых полей в : шаблонах, печатных формах и т.д. Аналог команды %echo% в шаблонах, на случай если она не сработает.
|-
|OnGetText
|Функция подменяет текстовый вывод значения поля при выгрузке в эксель. Первый параметр это имя поля, которое надо подменить. Второй параметр это то что необходимо вывести. Работает только с текстовыми полями.
'''''Пример использования'''''
DB.OnGetText('Зона', IF((DB.FieldByName('-Lat') ! 0) * (DB.FieldByName('-Lon') ! 0),
GetPolygonByLatLon(DB.FieldByName('-Lat'), DB.FieldByName('-Lon'), 'TYPE = 1 AND IFNULL(zone, 0) > 0 AND PRICE = ' + DB.FieldByName('-price'), 'zone')
,
''
));
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

GetDefaultPrinter - Возвращает имя текущего активного принтера.

SetDefaultPrinter(Printer) – Запоминает предыдущий активный принтер и устанавливает новый текущий принтер. Printer - имя принтера. При необходимости нескольких последовательных вызовов SetDefaultPrinter рекомендуется между вызовами использовать RestoreDefaultPrinter.

RestoreDefaultPrinter - Устанавливает активным принтер, который был текущим перед последним вызовом SetDefaultPrinter.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Для кода DataMatrix можно установить режим для печати скрытых символов с кодами 29(GS) и 232(FCN1), которые требуются для формирования Честного Знака. Для этого необходимо в начале строки указать символ "[" и все разделители 01, 21, 91, 92 так же экранировать этими скобками. Должно получиться [01]02900002317701[21]k3LInNbH_oG0Q[91]EE06[92]YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= . При формировании кода, включится режим формирования штрих-кода DataMatrix GS1, в начале будет добавлен символ с кодом 232 (FCN1), а потом будут добавлены разделители с кодом 29 (GS)
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «MEASOFT». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator][,Correction])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1.
Поле Correction позволяет указать данные для корректировочного чека, используется в системе Штрих-М. По умолчанию пустая строка. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [DeliveryDateMode=0, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; DeliveryDateMode: 0 - установить план. дату доставки текущим рабочим днем, 1 - установить план. дату доставки следующим рабочим днем, 2 - установить план. дату доставки равной планируемой дате оплаты АПД; Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД). Работа функции может быть изменена системной доп. возможностью OnCreateAddressForActDelivery.

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''GetRouteCode(AddressText, TownCode, LatLon[, Lon])''' - для адреса AddressText в городе с кодом TownCode (из таблицы Town) по географическим координатам lat, lon возвращает код роута (записи, хранящей координаты адреса в городе). Если роут не найден (для адреса в городе не найдено записи с указанными координатами) - создает новый роут и возвращает его код, если роут найден (был создан ранее) - обновляет у роута координаты. Если параметр Lon задан, то параметр LatLon должен содержать одну координату, иначе LatLon должен содержать строку вида 'lat, lon'.
В случае ошибки возвращает Null.

Пример:<br>
Set($res, GetRouteCode(address, townto, '55.114034, 36.592397'));<br>
Set($res, GetRouteCode('Троицк, Полковника милиции Курочкина ул., 11', 1, '37.467446, 55.740537'));<br>
Set($res, GetRouteCode('Обнинск, Маркса пр., 20', TownByName('Обнинск'), 55.114034, 36.592397));

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''CalcClientCnt(client_code, date, is_intown [, date_put=CurrDate(), skipajust=false])''' - функция расчета количество доставленных корреспонденций у клиента с кодом client_code за предыдущий месяц от даты date (Или за текущий месяц, подробнее смотри переменную UseCurrentMonthCount) среди внутригородских (is_intown = true) либо междугородних (is_intown = false) корреспонденций, date_put - дата доставки (для альтернативного способа подсчета, включаемого переменной UseDatePutForCalcCnt), skipajust - не учитывать принудительно введенные количества (таблица priceclientadjust типы записей 0 и 1).

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcTownPrice''' - возвращает базовую стоимость междугородней доставки, посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов, типа, срочности, массы, расстояния.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset.self".

*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*tp - тип корреспонденции;
*mode - режим доставки;
*mass - масса отправления;
*TownFrom - код города отправителя;
*TownTo - код города получателя.

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FromEmailStr''' - строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber,Print,[printer]) - Выполняет указанную печатную форму в объекте excel. Excel объект можно не указывать, тогда функция сама создаст объект экселя и разрушит его, полезно когда книгу
нужно распечатать или отправить по email (на листе данных в ячейке 1,1 укажите ключевое слово email). Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Print - печатает книгу на принтере, после печати объект excel разрушается, при использовании параметра не указываете объект excel. Printer - имя принтера, на котором печатать (по умолчанию пустая строка, что означает "печатать на принтере по умолчанию"). Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

'''SelDistAddr(s)''' – Возвращает строку для вставки в select запрос, для вывода поля с упрощенным адресом. Принимает один необязательный строковый параметр - алиас таблицы из которой будет упрощаться поле address, по умолчанию "a"

'''VoiceReadStr(str)''' – Озвучивает фразу str голосовым уведомлением доступными словами из базы. Может содержать тег "{break_off}" для того, чтобы сделать эту фразу не пропускаемой в очереди воспроизведения.

'''CalcStorageCost(ClientCodes, DateFrom, DateTo, NeedReport[, Store])''' – рассчитывает стоимость хранения на складе для выбранных клиентов (ClientCodes - коды клиентов через запятую), в период дат с DateFrom до DateTo, с прикреплением к корреспонденции отчета в зависимости от выставленного параметра NeedReport. Может содержать параметр Store - код филиала, по умолчанию пустой (расчет выполняется для всех филиалов). Возвращает коды созданных корреспонденций через запятую.

'''WriteOut(DocId, ItemId, Date, Cnt[, BC])''' – производит списание товара со склада. DocId - код (docs.code) документа списания, ItemId - код товара (item.code), Date - дата операции, Cnt - количество списываемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер. Если указан BC, то параметр ItemId игнорируется и поиск номенклатуры происходит исключительно по штрих-коду. В случае успеха, функция возвращает строку вида: код номенклатуры, списанное кол-во

'''IncomePurch(DocId, ItemId, Date, Cnt[, BC, Location = CurrentLocation])''' – производит приход товара на склад. DocId - код (docs.code) приходной накладной, ItemId - код товара (item.code), Date - дата операции, Cnt - количество приходуемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер, Location - код склада (store.code). В случае успеха, функция возвращает строку вида: код номенклатуры, введенное кол-во

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID (для провайдера iVoice - идентификатор сценария (кампании)). Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдеров BitCall и iVoice. Для BitCall по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием). Для iVoice по умолчанию подразумевается параметр 'response', при этом будет возвращен JSON с ответами абонента на заданные вопросы (в зависимости от сценария)

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, ZipPath) - Добавляет файл SrcPath в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл из строки Data в архив и располагает его по пути ZipPath. -ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

'''Функции общего назначения''':

'''ExecSimpleScript(Caption, Text)''' - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

'''FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns,ShowAll])''' - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. ShowAll - показать все дополнительные услуги, по умолчанию false и показывает только услуги с начислениями. Функция возвращает количество использованных столбцов.

'''PrintSticker(Codes, [ToBoxes=False])'''

'''PrintBlanc(Codes, BlancNumber)''' - печатать форму из раздела "Заполнить бланк". Codes - коды корреспонденций, BlancNumber - номер формы из раздела "Бланки для корреспонденции" (3)

'''GetItemByName(Name)'''

'''GetA4Printer''' - возвращает имя принтера выбранного для печати документов

'''GetStickerPrinter''' - возвращает имя принтера выбранного для печати стикеров

'''GetDuplexPrinter''' - возвращает имя принтера выбранного для двусторонней печати, если принтер не выбран, возвращает пустую строку

'''PrintAttachPDFPage(Code, FileName, Page, Printer)''' - печатает страницу из вложенного файла PDF. Code - код вложения (attachment), Page - номер страницы, Printer - 0 = принтер A4, 1 = принтер этикеток.

'''AttachPDFToText(Code, [TextFileName])''' - преобразует файл PDF из вложений в текст. Code - код вложения (attachment), TextFileName - имя текстового файла, в который записывается результат (если не указан, используется временный файл). Возвращает текст в виде строки.

'''GetActiveForm([SkipFormName])''' - возвращает код активной формы в программе где происходит сканирование. SkipFormName - не обязательны параметр, имя формы которую нужно пропустить при определении интерфейса.
'''Список интерфейсов''':
0 - неопределенный;
1 - прием корреспонденции на склад;
2 - АПД;
3 - комплектация адресов (ShelfingForm);
4 - доска приема;
9 - вкладка «Манифесты»;
10 - Инвентаризация корреспонденции;
11 - АПК;
12 - вкладка «Адреса»;
13 - вкладка «Выдача»;
14 - вкладка «Склад»;
15 - Список номенклатуры;
16 - Инвентаризация склада;
17 - Приходная накладная;
18 - Списание товара;
19 - Карточка корреспонденции.

'''AddAddressScanLog(Code[, StrBarCode, IsManual, FromInterface, ExtraInfo])''' - добавляет событие сканирование для корреспонденции с кодом Code. Необязательные параметры: StrBarCode - сканируемый ШК корреспонденции (по умолчанию пустой), IsManual - галка ручного сканирования (по умолчанию false), FromInterface - код интерфейса сканирования (StateType=81, по умолчанию 0 - неопределенный), ExtraInfo - текстовый комментарий события.

'''RuleName(alias)''' - Выдает полный путь в дерева прав по псевдониму права.

'''ShowText(Caption:string, Value:string)''' - показывает пользователю окно с заголовком Caption и с многострочным полем со значением Value. Может быть полезен при отображении логов выполненной операции.

'''ShowScanError(msg [, Speek])''' - выдает пользователю окно с текстом msg блокируя последующие действия сканирования. Если Speek - истинно, то сообщение проговаривается голосовым движком, по умолчанию выключено.

'''CheckRule(alias)''' - функция проверки разрешения у текущего пользователя системы, alias - псевдоним права. Возвращает 1, если право есть и 0, если права нет.
Пример: if(CheckRule('RSE'), ShowMessage('У пользователя есть право изменять счета'), ShowMessage('У пользователя нет права изменять счета'));

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

ClientTown - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

== Объект TFieldObject ==
Создается только автоматически. Объект для доступа к записям, используется в картах и доп.услугах.

_GETTABLEINFO - возвращает данные о полях и примеры данных объекта.

== Объект TMessage ==
Создается только автоматически. Объект используется для скриптовой обработки письма в [https://wiki.courierexe.ru/index.php/%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8F_%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8#.D0.98.D0.BC.D0.BF.D0.BE.D1.80.D1.82_.D0.B4.D0.B0.D0.BD.D0.BD.D1.8B.D1.85| заданиях импорта данных]. В себе содержит текст письма в очищенном формате и оригинальном формате HTML, отправитель письма, тему письма, дата получения и список прикрепленных файлов.

'''Message.Text''' - возвращает очищенный от HTML-тегов текст письма.

'''Message.HTMLText''' - возвращает оригинальный текст письма со всеми HTML-тегами.

'''Message.Sender''' - возвращает email-адрес отправителя письма.

'''Message.AttachmentsCount''' - возвращает количество вложенных файлов.

'''Message.DateTime''' - возвращает дату и время получения письма.

'''Message.Subject''' - возвращает тему письма.

'''Message.GetAttachmentDataString(Number)''' - возвращает вложенный файл под номером Number в виде строки.

'''Message.GetAttachmentName(Number)''' - возвращает имя вложенного файла под номером Number.

== Объект TStringList ==
Может использоваться для построчной обработки многостраничных файлов либо для организации текстовых данных. Номер строк начинается с 0.
Имеет следующий функционал:

'''Count''' - возвращает количество строк в списке.

'''Add(Value:string)''' - добавляет значение Value в конец списка.

'''Insert(Number:integer, Value:string)''' - добавляет строку Value в позицию Number.

'''Delete(Number:integer)''' - удаляет строку из списка в позиции Number.

'''Clear''' - очищает элементы списка.

'''LoadFromFile(Path:string)''' - загружает текстовый файл по пути Path.

'''Strings(Number:integer)''' - возвращает строку с номером Number.

'''SetString(Number:integer, Value:string)''' - устанавливает значение строки с номером Number в значение Value.

'''Text''' - возвращает полный список строк в виде текста.

'''CommaText([Quoted:boolean])''' - возвращает список значений через запятую. Если Quoted = true, то квотирует элементы списка. По умолчанию равен false.

'''SetCommaText(Value: string)''' - разбивает значение Value на отдельные строки и кладет в список. Разделитель - запятые.

'''IndexOf(Value:string)''' - ищет значение Value среди элементов списка и если находит, то возвращает номер строки. Возвращает -1 если значение не было найдено.

'''Sorted(Value:boolean)''' - устанавливает флаг отсортированности списка в Value. Если Value = true, то сразу же его сортирует. По умолчанию Value = false.

'''Exchange(Pos1:integer, Pos2:integer)''' - меняет элементы списка с позициями Pos1 и Pos2 местами.

'''Duplicates(Value:integer)''' - изменяет параметр управления дубликатами в списке. Если Value = 0 (значение по умолчанию), то список не реагирует на дубликаты. Если Value = 1, то список при добавлении будет игнорировать дубликаты. Если Value = 2, то список будет выдавать исключение, при добавлении дубликата в список.

'''ParamName(Number:integer[, Delimiter:string])''' - возвращает текст до первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает пустоту.

'''ParamValue(Number:integer[, Delimiter:string])''' - возвращает текст после первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает всю строку.

== Применение языка формул ==
'''в различных контекстах системы «MEASOFT» и сопутствующих проектах'''

=== MEASOFT ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с уровнем (pricelevel) меньше текущего.

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===

{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-

Руководство программиста

2025-05-05T09:25:31Z

OlegD: /* Объект TBaseUtils */

== Основные положения ==

В систему «MEASOFT» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

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

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

SET($a, a) – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

IF(a,b,c) или IF(a,b) – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

WHILE(a, b) – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

FOR($a, b, c, d) – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

NEW(ClassName, InstanceName) – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

FREE(InstanceName) – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

ShowObjects – Возвращает список созданных объектов – названия классов и имена.

ERROR(message) – Вызывает ошибку с текстом message.

SHOWMESSAGE(message) – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

SimpleAskUser(Message) – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

TRY(a) – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

REM(….) – Код в скобках игнорируется (комментарий).

EXEC(FileName, Params, Wait, WindowState) – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

=== Строковые функции ===

UpCase(s) – возвращает строку s в верхнем регистре.

LCase(s) – возвращает строку s в нижнем регистре.

Len(s) – возвращает количество символов в строке s.

Pos(s, substr [,start]) – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Параметр start - это позиция старта поиска, не обязательный параметр, по умолчанию равен 1. Поиск не чувствителен к регистру.

Param(s, i) – возвращает i-й элемент строки s, разделенной запятыми на элементы.

ParamsCount(s) - возвращает количество элементов строки s, разделенной запятыми на элементы.

SetParam(s, p, i) – заменяет на значение p i-й элемент строки s, разделенной запятыми на элементы.

Left(s, i [,full] ) – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Mid(s, i, j) - возвращает подстроку из s начиная с i символа и длиной j символов

Right(s, i [,full]) – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Reverse(s) - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

Char(i) – возвращает символ с кодом i.

Ord(s) – возвращает код первого символа строки s.

Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive]) - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

RemSpace(s) – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

SumStr(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

NumToStrSimple(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

FullNameToShort(Name) – Возвращает фамилию и инициалы по полному ФИО Name.

MonthName1(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

MonthName2(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

StrForXML(s) - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

FixedIntToStr(i, len[, char]) - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

Translate(format, [param1, param2, ...]) - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

ExtractFileName(FilePath) - возвращает имя файла с расширением из полного пути к файлу FilePath.

====Функции перекодировки====
DecodeStr(s, charset) - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

EncodeStr(s, charset) - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

Translit(s) - транслитерация строки русского текста s латиницей

UnTranslit(s) - транслитерация строки s с латиницы на русский.

==== Экранирование ====

QUOTEDSTR(s) – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

FormatTextXML(s) - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

FormatTextJSON(s) - переводит строку в формат JSON, экранирует служебные символы.

FormatTextBlob(s) - строка s содержит файл, функция перекодирует переданную строку в байты, используется для заполнения полей формата blob.

====Хеширование ====

HMACHash256(key, text) - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

MD5Hash(text) - создаёт хеш по алгоритму MD5

SignatureUrl(url) - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

CurrTime – возвращает текущее время

CurrDate – возвращает текущую дату

CurrMillisecond - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

Today - возвращает текущую дату в числовом формате.

Day(dt) – возвращает день месяца даты dt.

Month(dt) – возвращает месяц года даты dt.

Year(dt) – возвращает год даты dt.

FirstDayOfMonth(dt) – Возвращает первый день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( FirstDayOfMonth( CurrDate() ) );

LastDayOfMonth(dt) – Возвращает последний день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( LastDayOfMonth( CurrDate() ) );

DaysInMonth(month, year) – Возвращает количество дней в указанном месяце.

IncDay(dt, [count=1]) – Возвращает дату, увеличенную на count дней.

SQLDate(dt) – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

SQLDateToDate(dt) – Переводит дату из SQL-формата в обычный.

DAYSBETWEEN(dt1, dt2) – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimeBetween(t1, t2) - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0], [DefaultHolidayVarNum=1]) - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней(по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

TimePeriod(time1, time2) - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

StrDateToFloat(s, [time=false]) - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

IsAWorkDay(dt) - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

IncWorkDay(dt, [count=1],[DefaultHolidayVarNum=1]) - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней (по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

Sleep(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

INT(v) – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

FLOAT(v) – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

STR(v) – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

Date(v) – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

Time(v) – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

ROUNDUP(f) – округляет число f до ближайшего большего по модулю целого числа.

ROUNDDN(f) – округляет число f до ближайшего меньшего по модулю целого числа.

Money(f, CouldBeEmpty, ZeroFill, MakeSpace) - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.
''Подсказка: для простого округления используется функция int()''

Abs(f) - возвращает модуль числа f.

Mod(x, y) - возвращает остаток от деления целочисленного числа x на целочисленное число y.

=== Константы ===

Null – Возвращает пустое значение.

Да, True, Нет, False – константы, соответствующие булевым значениям.

=== Прочие функции ===

SQLFloat(f) – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding [, append])- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Если append = true, то производится дописывание данных в файл, а не перезаписывание (не обязательный, по умолчанию выключен).

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - Дополнительные заголовки HTTP запроса, передается в виде списка параметров через запятую и всегда образуют пару: 1 параметр - название заголовка, 2 параметр - значение. Если значение содержит запятую то его нужно экранировать в двойные кавычки. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в миллисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

LastHttpError - Выводит последний запрос выполненный с ошибкой в функции HttpPost. Содержит подробную информацию по запросу и ответу.

LastHttpResponse - Выводит последний запрос и ответ от сервера после выполнения Http-запроса в функции HttpPost.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel. Для работы без установленного MS Excel предусмотрен объект TDirectExcel.

'''''Ввод данных'''''

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Если TranslateHeader истинно, то заголовки таблицы будут автоматически переведены.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

Close – Закрывает текущий файл.

'''''Ячейки'''''

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

'''''Строки'''''

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

RowAutoFit([y1, y2]) - Устанавливает автоматическую высоту строк. Аргументы y1 и y2 необязательны и если не указаны, то процедура будет выполнена для всей страницы, в ином случае только для строк от y1 до y2.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

'''''Столбцы'''''

ColCount - Возвращает количество столбцов в листе.

AutoFit – Устанавливает автоматическую ширину столбцов.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SetColWidth (c, w) – Устанавливает ширину столбца c в w символов.

'''''Листы'''''

SetSheet(No) – Устанавливает номер текущего листа. Если лист с таким номером не существует - он будет создан (и все листы до него). Нумерация начинается с 1.

SetSheetName(Name) - Устанавливает название текущего листа.

SheetsCount – Возвращает количество листов в книге.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

SheetDelete(i) - Удаляет лист с номером i.

'''''Форматирование'''''

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

NumberFormat(x1, y1, x2, y2, Format) - Устанавливает формат вывода чисел в указанном диапазоне ячеек. Например, если Format='0.00' - числа будут выводиться c обязательными 2 знаками после десятичного разделителя.

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

SaveValuesOnly - убирает формулы на текущей странице и оставляет лишь их результативные статичные значения.

'''''Цвета'''''

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

'''''Копи-паст'''''

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

'''''Изображения'''''

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0, width=0, height=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки, width, height (не работает для DirectExcel) - ширина и высота области рисунка в пойнтах-единицах Excel

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

'''''Вывод'''''

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр copies - количество копий, по умолчанию равен 1.

Save(filename) - Сохраняет в файл filename. Если файл существует, в основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

'''''Пример использования'''''

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{| class="wikitable"
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|-
|GetSQL
|Для отладки. Возвращает последний SQL запрос переданный в методы Open, Query, GetSQLValue
|-
|ExportExcel
|Для отладки. Выгружает в эксель содержимое датасета. Можно использовать в незнакомом окружении для понимания передаваемых полей в : шаблонах, печатных формах и т.д. Аналог команды %echo% в шаблонах, на случай если она не сработает.
|-
|OnGetText
|Функция подменяет текстовый вывод значения поля при выгрузке в эксель. Первый параметр это имя поля, которое надо подменить. Второй параметр это то что необходимо вывести. Работает только с текстовыми полями.
'''''Пример использования'''''
DB.OnGetText('Зона', IF((DB.FieldByName('-Lat') ! 0) * (DB.FieldByName('-Lon') ! 0),
GetPolygonByLatLon(DB.FieldByName('-Lat'), DB.FieldByName('-Lon'), 'TYPE = 1 AND IFNULL(zone, 0) > 0 AND PRICE = ' + DB.FieldByName('-price'), 'zone')
,
''
));
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

GetDefaultPrinter - Возвращает имя текущего активного принтера.

SetDefaultPrinter(Printer) – Запоминает предыдущий активный принтер и устанавливает новый текущий принтер. Printer - имя принтера. При необходимости нескольких последовательных вызовов SetDefaultPrinter рекомендуется между вызовами использовать RestoreDefaultPrinter.

RestoreDefaultPrinter - Устанавливает активным принтер, который был текущим перед последним вызовом SetDefaultPrinter.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Для кода DataMatrix можно установить режим для печати скрытых символов с кодами 29(GS) и 232(FCN1), которые требуются для формирования Честного Знака. Для этого необходимо в начале строки указать символ "[" и все разделители 01, 21, 91, 92 так же экранировать этими скобками. Должно получиться [01]02900002317701[21]k3LInNbH_oG0Q[91]EE06[92]YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= . При формировании кода, включится режим формирования штрих-кода DataMatrix GS1, в начале будет добавлен символ с кодом 232 (FCN1), а потом будут добавлены разделители с кодом 29 (GS)
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «MEASOFT». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator][,Correction])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1.
Поле Correction позволяет указать данные для корректировочного чека, используется в системе Штрих-М. По умолчанию пустая строка. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [DeliveryDateMode=0, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; DeliveryDateMode: 0 - установить план. дату доставки текущим рабочим днем, 1 - установить план. дату доставки следующим рабочим днем, 2 - установить план. дату доставки равной планируемой дате оплаты АПД; Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД). Работа функции может быть изменена системной доп. возможностью OnCreateAddressForActDelivery.

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''GetRouteCode(AddressText, TownCode, LatLon[, Lon])''' - для адреса AddressText в городе с кодом TownCode (из таблицы Town) по географическим координатам lat, lon возвращает код роута (записи, хранящей координаты адреса в городе). Если роут не найден (для адреса в городе не найдено записи с указанными координатами) - создает новый роут и возвращает его код, если роут найден (был создан ранее) - обновляет у роута координаты. Если параметр Lon задан, то параметр LatLon должен содержать одну координату, иначе LatLon должен содержать строку вида 'lat, lon'.
В случае ошибки возвращает Null.

Пример:<br>
Set($res, GetRouteCode(address, townto, '55.114034, 36.592397'));<br>
Set($res, GetRouteCode('Троицк, Полковника милиции Курочкина ул., 11', 1, '37.467446, 55.740537'));<br>
Set($res, GetRouteCode('Обнинск, Маркса пр., 20', TownByName('Обнинск'), 55.114034, 36.592397));

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''CalcClientCnt(client_code, date, is_intown [, date_put=CurrDate(), skipajust=false])''' - функция расчета количество доставленных корреспонденций у клиента с кодом client_code за предыдущий месяц от даты date (Или за текущий месяц, подробнее смотри переменную UseCurrentMonthCount) среди внутригородских (is_intown = true) либо междугородних (is_intown = false) корреспонденций, date_put - дата доставки (для альтернативного способа подсчета, включаемого переменной UseDatePutForCalcCnt), skipajust - не учитывать принудительно введенные количества (таблица priceclientadjust типы записей 0 и 1).

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcTownPrice''' - возвращает базовую стоимость междугородней доставки, посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов, типа, срочности, массы, расстояния.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset.self".

*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*tp - тип корреспонденции;
*mode - режим доставки;
*mass - масса отправления;
*TownFrom - код города отправителя;
*TownTo - код города получателя.

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FromEmailStr''' - строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber,Print,[printer]) - Выполняет указанную печатную форму в объекте excel. Excel объект можно не указывать, тогда функция сама создаст объект экселя и разрушит его, полезно когда книгу
нужно распечатать или отправить по email (на листе данных в ячейке 1,1 укажите ключевое слово email). Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Print - печатает книгу на принтере, после печати объект excel разрушается, при использовании параметра не указываете объект excel. Printer - имя принтера, на котором печатать (по умолчанию пустая строка, что означает "печатать на принтере по умолчанию"). Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

'''SelDistAddr(s)''' – Возвращает строку для вставки в select запрос, для вывода поля с упрощенным адресом. Принимает один необязательный строковый параметр - алиас таблицы из которой будет упрощаться поле address, по умолчанию "a"

'''VoiceReadStr(str)''' – Озвучивает фразу str голосовым уведомлением доступными словами из базы. Может содержать тег "{break_off}" для того, чтобы сделать эту фразу не пропускаемой в очереди воспроизведения.

'''CalcStorageCost(ClientCodes, DateFrom, DateTo, NeedReport[, Store])''' – рассчитывает стоимость хранения на складе для выбранных клиентов (ClientCodes - коды клиентов через запятую), в период дат с DateFrom до DateTo, с прикреплением к корреспонденции отчета в зависимости от выставленного параметра NeedReport. Может содержать параметр Store - код филиала, по умолчанию пустой (расчет выполняется для всех филиалов). Возвращает коды созданных корреспонденций через запятую.

'''WriteOut(DocId, ItemId, Date, Cnt[, BC])''' – производит списание товара со склада. DocId - код (docs.code) документа списания, ItemId - код товара (item.code), Date - дата операции, Cnt - количество списываемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер. Если указан BC, то параметр ItemId игнорируется и поиск номенклатуры происходит исключительно по штрих-коду. В случае успеха, функция возвращает строку вида: код номенклатуры, списанное кол-во

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID (для провайдера iVoice - идентификатор сценария (кампании)). Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдеров BitCall и iVoice. Для BitCall по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием). Для iVoice по умолчанию подразумевается параметр 'response', при этом будет возвращен JSON с ответами абонента на заданные вопросы (в зависимости от сценария)

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, ZipPath) - Добавляет файл SrcPath в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл из строки Data в архив и располагает его по пути ZipPath. -ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

'''Функции общего назначения''':

'''ExecSimpleScript(Caption, Text)''' - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

'''FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns,ShowAll])''' - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. ShowAll - показать все дополнительные услуги, по умолчанию false и показывает только услуги с начислениями. Функция возвращает количество использованных столбцов.

'''PrintSticker(Codes, [ToBoxes=False])'''

'''PrintBlanc(Codes, BlancNumber)''' - печатать форму из раздела "Заполнить бланк". Codes - коды корреспонденций, BlancNumber - номер формы из раздела "Бланки для корреспонденции" (3)

'''GetItemByName(Name)'''

'''GetA4Printer''' - возвращает имя принтера выбранного для печати документов

'''GetStickerPrinter''' - возвращает имя принтера выбранного для печати стикеров

'''GetDuplexPrinter''' - возвращает имя принтера выбранного для двусторонней печати, если принтер не выбран, возвращает пустую строку

'''PrintAttachPDFPage(Code, FileName, Page, Printer)''' - печатает страницу из вложенного файла PDF. Code - код вложения (attachment), Page - номер страницы, Printer - 0 = принтер A4, 1 = принтер этикеток.

'''AttachPDFToText(Code, [TextFileName])''' - преобразует файл PDF из вложений в текст. Code - код вложения (attachment), TextFileName - имя текстового файла, в который записывается результат (если не указан, используется временный файл). Возвращает текст в виде строки.

'''GetActiveForm([SkipFormName])''' - возвращает код активной формы в программе где происходит сканирование. SkipFormName - не обязательны параметр, имя формы которую нужно пропустить при определении интерфейса.
'''Список интерфейсов''':
0 - неопределенный;
1 - прием корреспонденции на склад;
2 - АПД;
3 - комплектация адресов (ShelfingForm);
4 - доска приема;
9 - вкладка «Манифесты»;
10 - Инвентаризация корреспонденции;
11 - АПК;
12 - вкладка «Адреса»;
13 - вкладка «Выдача»;
14 - вкладка «Склад»;
15 - Список номенклатуры;
16 - Инвентаризация склада;
17 - Приходная накладная;
18 - Списание товара;
19 - Карточка корреспонденции.

'''AddAddressScanLog(Code[, StrBarCode, IsManual, FromInterface, ExtraInfo])''' - добавляет событие сканирование для корреспонденции с кодом Code. Необязательные параметры: StrBarCode - сканируемый ШК корреспонденции (по умолчанию пустой), IsManual - галка ручного сканирования (по умолчанию false), FromInterface - код интерфейса сканирования (StateType=81, по умолчанию 0 - неопределенный), ExtraInfo - текстовый комментарий события.

'''RuleName(alias)''' - Выдает полный путь в дерева прав по псевдониму права.

'''ShowText(Caption:string, Value:string)''' - показывает пользователю окно с заголовком Caption и с многострочным полем со значением Value. Может быть полезен при отображении логов выполненной операции.

'''ShowScanError(msg [, Speek])''' - выдает пользователю окно с текстом msg блокируя последующие действия сканирования. Если Speek - истинно, то сообщение проговаривается голосовым движком, по умолчанию выключено.

'''CheckRule(alias)''' - функция проверки разрешения у текущего пользователя системы, alias - псевдоним права. Возвращает 1, если право есть и 0, если права нет.
Пример: if(CheckRule('RSE'), ShowMessage('У пользователя есть право изменять счета'), ShowMessage('У пользователя нет права изменять счета'));

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

ClientTown - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

== Объект TFieldObject ==
Создается только автоматически. Объект для доступа к записям, используется в картах и доп.услугах.

_GETTABLEINFO - возвращает данные о полях и примеры данных объекта.

== Объект TMessage ==
Создается только автоматически. Объект используется для скриптовой обработки письма в [https://wiki.courierexe.ru/index.php/%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8F_%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8#.D0.98.D0.BC.D0.BF.D0.BE.D1.80.D1.82_.D0.B4.D0.B0.D0.BD.D0.BD.D1.8B.D1.85| заданиях импорта данных]. В себе содержит текст письма в очищенном формате и оригинальном формате HTML, отправитель письма, тему письма, дата получения и список прикрепленных файлов.

'''Message.Text''' - возвращает очищенный от HTML-тегов текст письма.

'''Message.HTMLText''' - возвращает оригинальный текст письма со всеми HTML-тегами.

'''Message.Sender''' - возвращает email-адрес отправителя письма.

'''Message.AttachmentsCount''' - возвращает количество вложенных файлов.

'''Message.DateTime''' - возвращает дату и время получения письма.

'''Message.Subject''' - возвращает тему письма.

'''Message.GetAttachmentDataString(Number)''' - возвращает вложенный файл под номером Number в виде строки.

'''Message.GetAttachmentName(Number)''' - возвращает имя вложенного файла под номером Number.

== Объект TStringList ==
Может использоваться для построчной обработки многостраничных файлов либо для организации текстовых данных. Номер строк начинается с 0.
Имеет следующий функционал:

'''Count''' - возвращает количество строк в списке.

'''Add(Value:string)''' - добавляет значение Value в конец списка.

'''Insert(Number:integer, Value:string)''' - добавляет строку Value в позицию Number.

'''Delete(Number:integer)''' - удаляет строку из списка в позиции Number.

'''Clear''' - очищает элементы списка.

'''LoadFromFile(Path:string)''' - загружает текстовый файл по пути Path.

'''Strings(Number:integer)''' - возвращает строку с номером Number.

'''SetString(Number:integer, Value:string)''' - устанавливает значение строки с номером Number в значение Value.

'''Text''' - возвращает полный список строк в виде текста.

'''CommaText([Quoted:boolean])''' - возвращает список значений через запятую. Если Quoted = true, то квотирует элементы списка. По умолчанию равен false.

'''SetCommaText(Value: string)''' - разбивает значение Value на отдельные строки и кладет в список. Разделитель - запятые.

'''IndexOf(Value:string)''' - ищет значение Value среди элементов списка и если находит, то возвращает номер строки. Возвращает -1 если значение не было найдено.

'''Sorted(Value:boolean)''' - устанавливает флаг отсортированности списка в Value. Если Value = true, то сразу же его сортирует. По умолчанию Value = false.

'''Exchange(Pos1:integer, Pos2:integer)''' - меняет элементы списка с позициями Pos1 и Pos2 местами.

'''Duplicates(Value:integer)''' - изменяет параметр управления дубликатами в списке. Если Value = 0 (значение по умолчанию), то список не реагирует на дубликаты. Если Value = 1, то список при добавлении будет игнорировать дубликаты. Если Value = 2, то список будет выдавать исключение, при добавлении дубликата в список.

'''ParamName(Number:integer[, Delimiter:string])''' - возвращает текст до первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает пустоту.

'''ParamValue(Number:integer[, Delimiter:string])''' - возвращает текст после первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает всю строку.

== Применение языка формул ==
'''в различных контекстах системы «MEASOFT» и сопутствующих проектах'''

=== MEASOFT ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с уровнем (pricelevel) меньше текущего.

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===

{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-

Руководство программиста

2025-04-29T13:24:22Z

OlegD: /* Объект TBase */

== Основные положения ==

В систему «MEASOFT» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

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

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

SET($a, a) – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

IF(a,b,c) или IF(a,b) – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

WHILE(a, b) – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

FOR($a, b, c, d) – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

NEW(ClassName, InstanceName) – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

FREE(InstanceName) – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

ShowObjects – Возвращает список созданных объектов – названия классов и имена.

ERROR(message) – Вызывает ошибку с текстом message.

SHOWMESSAGE(message) – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

SimpleAskUser(Message) – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

TRY(a) – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

REM(….) – Код в скобках игнорируется (комментарий).

EXEC(FileName, Params, Wait, WindowState) – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

=== Строковые функции ===

UpCase(s) – возвращает строку s в верхнем регистре.

LCase(s) – возвращает строку s в нижнем регистре.

Len(s) – возвращает количество символов в строке s.

Pos(s, substr [,start]) – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Параметр start - это позиция старта поиска, не обязательный параметр, по умолчанию равен 1. Поиск не чувствителен к регистру.

Param(s, i) – возвращает i-й элемент строки s, разделенной запятыми на элементы.

ParamsCount(s) - возвращает количество элементов строки s, разделенной запятыми на элементы.

SetParam(s, p, i) – заменяет на значение p i-й элемент строки s, разделенной запятыми на элементы.

Left(s, i [,full] ) – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Mid(s, i, j) - возвращает подстроку из s начиная с i символа и длиной j символов

Right(s, i [,full]) – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Reverse(s) - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

Char(i) – возвращает символ с кодом i.

Ord(s) – возвращает код первого символа строки s.

Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive]) - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

RemSpace(s) – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

SumStr(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

NumToStrSimple(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

FullNameToShort(Name) – Возвращает фамилию и инициалы по полному ФИО Name.

MonthName1(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

MonthName2(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

StrForXML(s) - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

FixedIntToStr(i, len[, char]) - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

Translate(format, [param1, param2, ...]) - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

ExtractFileName(FilePath) - возвращает имя файла с расширением из полного пути к файлу FilePath.

====Функции перекодировки====
DecodeStr(s, charset) - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

EncodeStr(s, charset) - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

Translit(s) - транслитерация строки русского текста s латиницей

UnTranslit(s) - транслитерация строки s с латиницы на русский.

==== Экранирование ====

QUOTEDSTR(s) – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

FormatTextXML(s) - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

FormatTextJSON(s) - переводит строку в формат JSON, экранирует служебные символы.

FormatTextBlob(s) - строка s содержит файл, функция перекодирует переданную строку в байты, используется для заполнения полей формата blob.

====Хеширование ====

HMACHash256(key, text) - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

MD5Hash(text) - создаёт хеш по алгоритму MD5

SignatureUrl(url) - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

CurrTime – возвращает текущее время

CurrDate – возвращает текущую дату

CurrMillisecond - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

Today - возвращает текущую дату в числовом формате.

Day(dt) – возвращает день месяца даты dt.

Month(dt) – возвращает месяц года даты dt.

Year(dt) – возвращает год даты dt.

FirstDayOfMonth(dt) – Возвращает первый день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( FirstDayOfMonth( CurrDate() ) );

LastDayOfMonth(dt) – Возвращает последний день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( LastDayOfMonth( CurrDate() ) );

DaysInMonth(month, year) – Возвращает количество дней в указанном месяце.

IncDay(dt, [count=1]) – Возвращает дату, увеличенную на count дней.

SQLDate(dt) – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

SQLDateToDate(dt) – Переводит дату из SQL-формата в обычный.

DAYSBETWEEN(dt1, dt2) – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimeBetween(t1, t2) - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0], [DefaultHolidayVarNum=1]) - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней(по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

TimePeriod(time1, time2) - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

StrDateToFloat(s, [time=false]) - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

IsAWorkDay(dt) - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

IncWorkDay(dt, [count=1],[DefaultHolidayVarNum=1]) - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней (по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

Sleep(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

INT(v) – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

FLOAT(v) – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

STR(v) – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

Date(v) – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

Time(v) – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

ROUNDUP(f) – округляет число f до ближайшего большего по модулю целого числа.

ROUNDDN(f) – округляет число f до ближайшего меньшего по модулю целого числа.

Money(f, CouldBeEmpty, ZeroFill, MakeSpace) - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.
''Подсказка: для простого округления используется функция int()''

Abs(f) - возвращает модуль числа f.

Mod(x, y) - возвращает остаток от деления целочисленного числа x на целочисленное число y.

=== Константы ===

Null – Возвращает пустое значение.

Да, True, Нет, False – константы, соответствующие булевым значениям.

=== Прочие функции ===

SQLFloat(f) – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding [, append])- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Если append = true, то производится дописывание данных в файл, а не перезаписывание (не обязательный, по умолчанию выключен).

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - Дополнительные заголовки HTTP запроса, передается в виде списка параметров через запятую и всегда образуют пару: 1 параметр - название заголовка, 2 параметр - значение. Если значение содержит запятую то его нужно экранировать в двойные кавычки. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в миллисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

LastHttpError - Выводит последний запрос выполненный с ошибкой в функции HttpPost. Содержит подробную информацию по запросу и ответу.

LastHttpResponse - Выводит последний запрос и ответ от сервера после выполнения Http-запроса в функции HttpPost.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel. Для работы без установленного MS Excel предусмотрен объект TDirectExcel.

'''''Ввод данных'''''

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Если TranslateHeader истинно, то заголовки таблицы будут автоматически переведены.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

Close – Закрывает текущий файл.

'''''Ячейки'''''

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

'''''Строки'''''

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

RowAutoFit([y1, y2]) - Устанавливает автоматическую высоту строк. Аргументы y1 и y2 необязательны и если не указаны, то процедура будет выполнена для всей страницы, в ином случае только для строк от y1 до y2.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

'''''Столбцы'''''

ColCount - Возвращает количество столбцов в листе.

AutoFit – Устанавливает автоматическую ширину столбцов.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SetColWidth (c, w) – Устанавливает ширину столбца c в w символов.

'''''Листы'''''

SetSheet(No) – Устанавливает номер текущего листа. Если лист с таким номером не существует - он будет создан (и все листы до него). Нумерация начинается с 1.

SetSheetName(Name) - Устанавливает название текущего листа.

SheetsCount – Возвращает количество листов в книге.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

SheetDelete(i) - Удаляет лист с номером i.

'''''Форматирование'''''

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

NumberFormat(x1, y1, x2, y2, Format) - Устанавливает формат вывода чисел в указанном диапазоне ячеек. Например, если Format='0.00' - числа будут выводиться c обязательными 2 знаками после десятичного разделителя.

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

SaveValuesOnly - убирает формулы на текущей странице и оставляет лишь их результативные статичные значения.

'''''Цвета'''''

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

'''''Копи-паст'''''

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

'''''Изображения'''''

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0, width=0, height=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки, width, height (не работает для DirectExcel) - ширина и высота области рисунка в пойнтах-единицах Excel

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

'''''Вывод'''''

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр copies - количество копий, по умолчанию равен 1.

Save(filename) - Сохраняет в файл filename. Если файл существует, в основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

'''''Пример использования'''''

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{| class="wikitable"
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|-
|GetSQL
|Для отладки. Возвращает последний SQL запрос переданный в методы Open, Query, GetSQLValue
|-
|ExportExcel
|Для отладки. Выгружает в эксель содержимое датасета. Можно использовать в незнакомом окружении для понимания передаваемых полей в : шаблонах, печатных формах и т.д. Аналог команды %echo% в шаблонах, на случай если она не сработает.
|-
|OnGetText
|Функция подменяет текстовый вывод значения поля при выгрузке в эксель. Первый параметр это имя поля, которое надо подменить. Второй параметр это то что необходимо вывести. Работает только с текстовыми полями.
'''''Пример использования'''''
DB.OnGetText('Зона', IF((DB.FieldByName('-Lat') ! 0) * (DB.FieldByName('-Lon') ! 0),
GetPolygonByLatLon(DB.FieldByName('-Lat'), DB.FieldByName('-Lon'), 'TYPE = 1 AND IFNULL(zone, 0) > 0 AND PRICE = ' + DB.FieldByName('-price'), 'zone')
,
''
));
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

GetDefaultPrinter - Возвращает имя текущего активного принтера.

SetDefaultPrinter(Printer) – Запоминает предыдущий активный принтер и устанавливает новый текущий принтер. Printer - имя принтера. При необходимости нескольких последовательных вызовов SetDefaultPrinter рекомендуется между вызовами использовать RestoreDefaultPrinter.

RestoreDefaultPrinter - Устанавливает активным принтер, который был текущим перед последним вызовом SetDefaultPrinter.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Для кода DataMatrix можно установить режим для печати скрытых символов с кодами 29(GS) и 232(FCN1), которые требуются для формирования Честного Знака. Для этого необходимо в начале строки указать символ "[" и все разделители 01, 21, 91, 92 так же экранировать этими скобками. Должно получиться [01]02900002317701[21]k3LInNbH_oG0Q[91]EE06[92]YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= . При формировании кода, включится режим формирования штрих-кода DataMatrix GS1, в начале будет добавлен символ с кодом 232 (FCN1), а потом будут добавлены разделители с кодом 29 (GS)
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «MEASOFT». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator][,Correction])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1.
Поле Correction позволяет указать данные для корректировочного чека, используется в системе Штрих-М. По умолчанию пустая строка. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [DeliveryDateMode=0, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; DeliveryDateMode: 0 - установить план. дату доставки текущим рабочим днем, 1 - установить план. дату доставки следующим рабочим днем, 2 - установить план. дату доставки равной планируемой дате оплаты АПД; Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД). Работа функции может быть изменена системной доп. возможностью OnCreateAddressForActDelivery.

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''GetRouteCode(AddressText, TownCode, LatLon[, Lon])''' - для адреса AddressText в городе с кодом TownCode (из таблицы Town) по географическим координатам lat, lon возвращает код роута (записи, хранящей координаты адреса в городе). Если роут не найден (для адреса в городе не найдено записи с указанными координатами) - создает новый роут и возвращает его код, если роут найден (был создан ранее) - обновляет у роута координаты. Если параметр Lon задан, то параметр LatLon должен содержать одну координату, иначе LatLon должен содержать строку вида 'lat, lon'.
В случае ошибки возвращает Null.

Пример:<br>
Set($res, GetRouteCode(address, townto, '55.114034, 36.592397'));<br>
Set($res, GetRouteCode('Троицк, Полковника милиции Курочкина ул., 11', 1, '37.467446, 55.740537'));<br>
Set($res, GetRouteCode('Обнинск, Маркса пр., 20', TownByName('Обнинск'), 55.114034, 36.592397));

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''CalcClientCnt(client_code, date, is_intown [, date_put=CurrDate(), skipajust=false])''' - функция расчета количество доставленных корреспонденций у клиента с кодом client_code за предыдущий месяц от даты date (Или за текущий месяц, подробнее смотри переменную UseCurrentMonthCount) среди внутригородских (is_intown = true) либо междугородних (is_intown = false) корреспонденций, date_put - дата доставки (для альтернативного способа подсчета, включаемого переменной UseDatePutForCalcCnt), skipajust - не учитывать принудительно введенные количества (таблица priceclientadjust типы записей 0 и 1).

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcTownPrice''' - возвращает базовую стоимость междугородней доставки, посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов, типа, срочности, массы, расстояния.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset.self".

*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*tp - тип корреспонденции;
*mode - режим доставки;
*mass - масса отправления;
*TownFrom - код города отправителя;
*TownTo - код города получателя.

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FromEmailStr''' - строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber,Print) - Выполняет указанную печатную форму в объекте excel. Excel объект можно не указывать, тогда функция сама создаст объект экселя и разрушит его, полезно когда книгу
нужно распечатать или отправить по email (на листе данных в ячейке 1,1 укажите ключевое слово email). Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Print - печатает ккнигу на принтере по умолчанию, после печати объект excel разрушается, при использовании параметра не указывате объект excel. Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

'''SelDistAddr(s)''' – Возвращает строку для вставки в select запрос, для вывода поля с упрощенным адресом. Принимает один необязательный строковый параметр - алиас таблицы из которой будет упрощаться поле address, по умолчанию "a"

'''VoiceReadStr(str)''' – Озвучивает фразу str голосовым уведомлением доступными словами из базы. Может содержать тег "{break_off}" для того, чтобы сделать эту фразу не пропускаемой в очереди воспроизведения.

'''CalcStorageCost(ClientCodes, DateFrom, DateTo, NeedReport[, Store])''' – рассчитывает стоимость хранения на складе для выбранных клиентов (ClientCodes - коды клиентов через запятую), в период дат с DateFrom до DateTo, с прикреплением к корреспонденции отчета в зависимости от выставленного параметра NeedReport. Может содержать параметр Store - код филиала, по умолчанию пустой (расчет выполняется для всех филиалов). Возвращает коды созданных корреспонденций через запятую.

'''WriteOut(DocId, ItemId, Date, Cnt[, BC])''' – производит списание товара со склада. DocId - код (docs.code) документа списания, ItemId - код товара (item.code), Date - дата операции, Cnt - количество списываемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер. Если указан BC, то параметр ItemId игнорируется и поиск номенклатуры происходит исключительно по штрих-коду. В случае успеха, функция возвращает строку вида: код номенклатуры, списанное кол-во

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID (для провайдера iVoice - идентификатор сценария (кампании)). Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдеров BitCall и iVoice. Для BitCall по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием). Для iVoice по умолчанию подразумевается параметр 'response', при этом будет возвращен JSON с ответами абонента на заданные вопросы (в зависимости от сценария)

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, ZipPath) - Добавляет файл SrcPath в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл из строки Data в архив и располагает его по пути ZipPath. -ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

'''Функции общего назначения''':

'''ExecSimpleScript(Caption, Text)''' - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

'''FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns,ShowAll])''' - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. ShowAll - показать все дополнительные услуги, по умолчанию false и показывает только услуги с начислениями. Функция возвращает количество использованных столбцов.

'''PrintSticker(Codes, [ToBoxes=False])'''

'''PrintBlanc(Codes, BlancNumber)''' - печатать форму из раздела "Заполнить бланк". Codes - коды корреспонденций, BlancNumber - номер формы из раздела "Бланки для корреспонденции" (3)

'''GetItemByName(Name)'''

'''GetA4Printer''' - возвращает имя принтера выбранного для печати документов

'''GetStickerPrinter''' - возвращает имя принтера выбранного для печати стикеров

'''GetDuplexPrinter''' - возвращает имя принтера выбранного для двусторонней печати, если принтер не выбран, возвращает пустую строку

'''PrintAttachPDFPage(Code, FileName, Page, Printer)''' - печатает страницу из вложенного файла PDF. Code - код вложения (attachment), Page - номер страницы, Printer - 0 = принтер A4, 1 = принтер этикеток.

'''AttachPDFToText(Code, [TextFileName])''' - преобразует файл PDF из вложений в текст. Code - код вложения (attachment), TextFileName - имя текстового файла, в который записывается результат (если не указан, используется временный файл). Возвращает текст в виде строки.

'''GetActiveForm([SkipFormName])''' - возвращает код активной формы в программе где происходит сканирование. SkipFormName - не обязательны параметр, имя формы которую нужно пропустить при определении интерфейса.
'''Список интерфейсов''':
0 - неопределенный;
1 - прием корреспонденции на склад;
2 - АПД;
3 - комплектация адресов (ShelfingForm);
4 - доска приема;
9 - вкладка «Манифесты»;
10 - Инвентаризация корреспонденции;
11 - АПК;
12 - вкладка «Адреса»;
13 - вкладка «Выдача»;
14 - вкладка «Склад»;
15 - Список номенклатуры;
16 - Инвентаризация склада;
17 - Приходная накладная;
18 - Списание товара;
19 - Карточка корреспонденции.

'''AddAddressScanLog(Code[, StrBarCode, IsManual, FromInterface, ExtraInfo])''' - добавляет событие сканирование для корреспонденции с кодом Code. Необязательные параметры: StrBarCode - сканируемый ШК корреспонденции (по умолчанию пустой), IsManual - галка ручного сканирования (по умолчанию false), FromInterface - код интерфейса сканирования (StateType=81, по умолчанию 0 - неопределенный), ExtraInfo - текстовый комментарий события.

'''RuleName(alias)''' - Выдает полный путь в дерева прав по псевдониму права.

'''ShowText(Caption:string, Value:string)''' - показывает пользователю окно с заголовком Caption и с многострочным полем со значением Value. Может быть полезен при отображении логов выполненной операции.

'''ShowScanError(msg [, Speek])''' - выдает пользователю окно с текстом msg блокируя последующие действия сканирования. Если Speek - истинно, то сообщение проговаривается голосовым движком, по умолчанию выключено.

'''CheckRule(alias)''' - функция проверки разрешения у текущего пользователя системы, alias - псевдоним права. Возвращает 1, если право есть и 0, если права нет.
Пример: if(CheckRule('RSE'), ShowMessage('У пользователя есть право изменять счета'), ShowMessage('У пользователя нет права изменять счета'));

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

ClientTown - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

== Объект TFieldObject ==
Создается только автоматически. Объект для доступа к записям, используется в картах и доп.услугах.

_GETTABLEINFO - возвращает данные о полях и примеры данных объекта.

== Объект TMessage ==
Создается только автоматически. Объект используется для скриптовой обработки письма в [https://wiki.courierexe.ru/index.php/%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8F_%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8#.D0.98.D0.BC.D0.BF.D0.BE.D1.80.D1.82_.D0.B4.D0.B0.D0.BD.D0.BD.D1.8B.D1.85| заданиях импорта данных]. В себе содержит текст письма в очищенном формате и оригинальном формате HTML, отправитель письма, тему письма, дата получения и список прикрепленных файлов.

'''Message.Text''' - возвращает очищенный от HTML-тегов текст письма.

'''Message.HTMLText''' - возвращает оригинальный текст письма со всеми HTML-тегами.

'''Message.Sender''' - возвращает email-адрес отправителя письма.

'''Message.AttachmentsCount''' - возвращает количество вложенных файлов.

'''Message.DateTime''' - возвращает дату и время получения письма.

'''Message.Subject''' - возвращает тему письма.

'''Message.GetAttachmentDataString(Number)''' - возвращает вложенный файл под номером Number в виде строки.

'''Message.GetAttachmentName(Number)''' - возвращает имя вложенного файла под номером Number.

== Объект TStringList ==
Может использоваться для построчной обработки многостраничных файлов либо для организации текстовых данных. Номер строк начинается с 0.
Имеет следующий функционал:

'''Count''' - возвращает количество строк в списке.

'''Add(Value:string)''' - добавляет значение Value в конец списка.

'''Insert(Number:integer, Value:string)''' - добавляет строку Value в позицию Number.

'''Delete(Number:integer)''' - удаляет строку из списка в позиции Number.

'''Clear''' - очищает элементы списка.

'''LoadFromFile(Path:string)''' - загружает текстовый файл по пути Path.

'''Strings(Number:integer)''' - возвращает строку с номером Number.

'''SetString(Number:integer, Value:string)''' - устанавливает значение строки с номером Number в значение Value.

'''Text''' - возвращает полный список строк в виде текста.

'''CommaText([Quoted:boolean])''' - возвращает список значений через запятую. Если Quoted = true, то квотирует элементы списка. По умолчанию равен false.

'''SetCommaText(Value: string)''' - разбивает значение Value на отдельные строки и кладет в список. Разделитель - запятые.

'''IndexOf(Value:string)''' - ищет значение Value среди элементов списка и если находит, то возвращает номер строки. Возвращает -1 если значение не было найдено.

'''Sorted(Value:boolean)''' - устанавливает флаг отсортированности списка в Value. Если Value = true, то сразу же его сортирует. По умолчанию Value = false.

'''Exchange(Pos1:integer, Pos2:integer)''' - меняет элементы списка с позициями Pos1 и Pos2 местами.

'''Duplicates(Value:integer)''' - изменяет параметр управления дубликатами в списке. Если Value = 0 (значение по умолчанию), то список не реагирует на дубликаты. Если Value = 1, то список при добавлении будет игнорировать дубликаты. Если Value = 2, то список будет выдавать исключение, при добавлении дубликата в список.

'''ParamName(Number:integer[, Delimiter:string])''' - возвращает текст до первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает пустоту.

'''ParamValue(Number:integer[, Delimiter:string])''' - возвращает текст после первого знака разделителя Delimiter (по умолчанию "=") из строки с номером Number. Если разделителя в строке нет, то возвращает всю строку.

== Применение языка формул ==
'''в различных контекстах системы «MEASOFT» и сопутствующих проектах'''

=== MEASOFT ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с уровнем (pricelevel) меньше текущего.

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===

{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-