# 11. Приложения

**Интеграция. XML Файл.**

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

Название файла in\_RLRP\_Code\_Название из УС.xml:

* in\_RLRP - обязательное
* Code – код кассы, необязательное -используется только для сетевой версии, состоит из 3-х символов латинских/кириллических и/или целых чисел.

Название из УС – обязательное, название, сгенерированное в учетной системе, содержимое без ограничений, контроль уникальности на стороне учетной системы.

Перечень блоков:

| **Описание**                                                                        | **Параметр** | **Обязательность** | **Тип**                                                                         |
| ----------------------------------------------------------------------------------- | ------------ | ------------------ | ------------------------------------------------------------------------------- |
| Блок Person                                                                         |              |                    |                                                                                 |
| Идентификатор контрагента                                                           | Id           | Да                 | GUID                                                                            |
| Фамилия контрагента                                                                 | LastName     | Да                 | строка, до 100 кириллических символов                                           |
| Имя контрагента                                                                     | FirstName    | Да                 | строка, до 100 кириллических символов                                           |
| Отчество контрагента                                                                | MiddleName   | Нет                | строка, до 100 кириллических символов                                           |
| Резидентство                                                                        | IsResident   | Да                 | 0 – нерезидент, 1 - резидент                                                    |
| Тип документа удостоверяющего личность контрагента                                  | DocType      | Да                 | строка, до 7 кириллических символов                                             |
| <p>Серия паспорта гражданина РФ</p><p>(без пробелов) контрагента</p>                | DocSerial    | Да                 | целое число, 4 символов                                                         |
| <p>Номер паспорта гражданина РФ</p><p>(без пробелов) контрагента</p>                | DocNumber    | Да                 | целое число, 6 символов                                                         |
| <p>Номер телефона контрагента</p><p>(только российский оператор сотовой связи)</p>  | PhoneNumber  | Да                 | целое число, 10 символов                                                        |
| Информация о документе, удостоверяющем личность гражданина РФ                       | DocFull      | Да                 | строка, до 200 символов                                                         |
| Дата рождения контрагента                                                           | DateOfBirth  | нет                | Дата, ДД.ММ.ГГГГ                                                                |
| Блок Document                                                                       |              |                    |                                                                                 |
| Идентификатор документа                                                             | Id           | Да                 | GUID                                                                            |
| Номер документа на оплату                                                           | Number       | Да                 | ^.\[^'"\\\\/:\*?<>\|+]{0,69}$                                                   |
| Дата документа на оплату                                                            | Date         | Да                 | ДД/ММ/ГГГГ                                                                      |
| Сумма итоговая по документу на оплату                                               | Total        | Да                 | число, разделитель дробной части точка, либо запятая.2 знака после разделителя  |
| <p>Блок Position<br>Строки табличной части из документа на оплату блок Position</p> |              |                    |                                                                                 |
| Идентификатор номенклатуры (лома металла)                                           | ScrapId      | Да                 | GUID                                                                            |
| Номенклатура в документе (название лома металла)                                    | ScrapName    | Да                 | строка, до 100 символов                                                         |
| Цена по номенклатуре в документе                                                    | Cost         | Да                 | Число, разделитель дробной части точка, либо запятая. 2 знака после разделителя |
| Брутто по номенклатуре в документе                                                  | Gross        | Да                 | Число, разделитель дробной части точка, либо запятая. 3 знака после разделителя |
| Нетто по номенклатуре в документе                                                   | Net          | Да                 | Число, разделитель дробной части точка, либо запятая. 3 знака после разделителя |
| Засор по номенклатуре в документе                                                   | Clog         | Да                 | число                                                                           |

Возможные типы документов, удостоверяющих личность Person.DocType – паспорт

<figure><img src="/files/Q8ns7Isfqs0tz1RGJuJf" alt=""><figcaption></figcaption></figure>

Контрагент нерезидент.

Если параметр «IsResident» содержит 0 (нерезидент), тогда в системе Алмаз-Онлайн»:

* Поле «Номер» паспорта может содержать как число, так и символы латиницы или кириллицы
* Поля «Номер» и «Серия» паспорта может не содержать символов.

Спецификация формата файла статус платежа

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

Название файла RLRP\_Code\_DocumentId\_Status.xml:

* RLRP - обязательное
* Code – код кассы, необязательное -используется только для сетевой версии, состоит из 3 символов латинских/кириллических и/или целых чисел.
* DocumentId – обязательное, идентификатор документа соответствует идентификатору документа из файла (см. ниже таблица)
* Status – обязательное, соответствует одному из статусов возможных состояний платежа (InWork, InPay, OkPay, ErrorPay, GlobalError)

Содержимое файла:

1\. Корневой элемент

2\. Версию схемы

3\. Служебную информацию

4\. Состояние платежа PaymentState содержит один из статусов

5\. Если есть описание (ошибки, или дополнительная информация), содержится в блоке Description

| **Описание**                                                                | **Параметр**     | **Обязательность** | **Тип**                             |
| --------------------------------------------------------------------------- | ---------------- | ------------------ | ----------------------------------- |
| Блок Document                                                               |                  |                    |                                     |
| Идентификатор документа                                                     | Id               | Да                 | GUID                                |
| Номер документа на оплату                                                   | Number           | Да                 | строка, до 100 символов             |
| Состояние платежа                                                           | State            | Да                 | строка, до 100 символов             |
| Результат                                                                   | Result           | Да                 | целое число                         |
| Блок Description                                                            |                  |                    |                                     |
| Текст статуса ошибки                                                        | ErrorText        | нет                | строка                              |
| Причина ошибочного статуса Зачисления                                       | PaymentStateText | нет                | строка, 100 символов                |
| ID заявки на Зачисление в АПК НКО. Если PaymentState = 200 либо 100, либо 0 | PaymentID        | нет                | Целое число                         |
| **Платежный шлюз (согласно договору) через который проведен платеж:**       |                  |                    |                                     |
| Транскапиталбанк                                                            |                  |                    |                                     |
| Идентификатор Api – платежного шлюза ТКБ                                    | ApiId            | Да                 | 0d16a17d-1190-4b32-833cc100b7862bd2 |
| Тип Api – платежного шлюза ТКБ                                              | ApiType          | Да                 | WireBank                            |
| Единая касса                                                                |                  |                    |                                     |
| Идентификатор Api – платежного шлюза Единая касса                           | ApiId            | Да                 | 34984d55-23f7-46bc-9e9f2553e6952eaa |
| Тип Api платежного шлюза Единая Касса                                       | ApiType          | Да                 | Xplat\_mp2c                         |
| Сургутнефтегазбанк                                                          |                  |                    |                                     |
| Идентификатор Api – платежного шлюза СНГБ                                   | ApiId            | Да                 | ApiType                             |
| Тип Api платежного шлюза СНГБ                                               | ApiType          | Да                 | SNGB                                |
| Открытие                                                                    |                  |                    |                                     |
| Идентификатор Api – платежного шлюза банка Открытие                         | ApiId            | Да                 | 7d50e196-e4d5-432b-b60cce4460b08616 |
| Тип Api платежного шлюза банка Открытие                                     | ApiId            | Да                 | OPEN                                |
| ВТБ                                                                         |                  |                    |                                     |
| Идентификатор Api – платежного шлюза Paymo                                  | ApiId            | Да                 | 1D01A11E-7DC5-4D88BA71-0FDD8780288B |
| Тип Api платежного шлюза Paymo                                              | ApiId            | Да                 | Paymo                               |

Возможные состояние платежа (Result/ PaymentState / Статус):

* 1 - Принят в работу - InWork
* 5 - Платеж отправлен в обработку - InPay
* 6 - Платеж проведен успешно - OkPay
* 7 - Платеж отклонен - ErrorPay
* 8 – Ошибка - GlobalError

<figure><img src="/files/F3shdZo2Zm6gJjv0FXAO" alt=""><figcaption></figcaption></figure>

Решение проблемы неоднозначности разметки с помощью экранирования

Недопустимые символы в xml

" < > ‘&

| **Знак**                     | **Объект** | **Примечания**                                                                                                                                                                                                                                                                                                                                                              |
| ---------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| & (амперсанд)                | &          | Должен использоваться для значений атрибутов и содержимого элемента.                                                                                                                                                                                                                                                                                                        |
| > (знак "больше")            | >          | Должен использоваться для значения атрибута, но ">" допустим в качестве содержимого элемента, если ему не предшествует "<".                                                                                                                                                                                                                                                 |
| < (знак "меньше")            | <          | Должен использоваться для значения атрибута, но < допустим в качестве содержимого элемента, при условии > не следует.                                                                                                                                                                                                                                                       |
| "(прямая кавычка)            | "          | Должен использоваться для значения атрибута, но прямая кавычка (") допустима в качестве содержимого элемента. Значения атрибутов могут быть заключены в прямые одиночные кавычки (') или прямые двойные кавычки (""). Первый символ определяет оболочку значения атрибута, а альтернативный знак кавычек можно затем использовать в качестве литерала в значении.           |
| ' (одиночная прямая кавычка) | '          | Должен использоваться для значения атрибута, но прямая одиночная кавычка (') допустима в качестве содержимого элемента. Значения атрибутов могут быть заключены в прямые одиночные кавычки (') или прямые двойные кавычки (""). Первый символ определяет оболочку значения атрибута, а альтернативный знак кавычек можно затем использовать в качестве литерала в значении. |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://almaz-online.gitbook.io/rukovodstvo-polzovatelya-po-rabote-v-sisteme/11.-prilozheniya.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
