Try it — Report -SummaryOfPayments

Отредактируйте параметры запроса и нажмите Выполнить для отправки запроса на сервер

Report: Отчет Детализация счетов

  • Создано 16.04.2026
  • Обновлено 25.05.2026
  • Endpoint: Report
  • Soap-method: Report -SummaryOfPayments
Описание

Функция позволяет получить отчёт по названию, в котором содержится подробная информация. Вариант отчета  «SummaryOfPayments». Детализация счетов - подробная расшифровка выставленных за указанный период счетов по предоставленным услугам и обработанным накладным

Параметры запроса
Параметр Тип Обязательно Описание
login string Логин пользователя
password string Пароль
parameters Element Список параметров
name string Наименование отчёта = SummaryOfPayments для отчета Детализация счетов
Описание параметра parameters

Параметр parameters должен содержать:

- Key: значение parameters (строго как указано);

- List: непустой массив элементов, каждый из которых — отдельный параметр в виде структуры с тремя полями:

- Key: имя параметра (например, FromDate, ToDate);

- Value: значение параметра (строка, дата и т.д.);

- ValueType: тип значения (string, dateTime и т.п.).

Пример структуры:

<p><m:parameters xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<m:Key>parameters</m:Key>
<m:List>
    <m:Key>FromDate</m:Key>
    <m:Value xsi:type="xs:dateTime">2014-09-01T00:00:00</m:Value>
    <m:ValueType>dateTime</m:ValueType>
</m:List>
<m:List>
    <m:Key>ToDate</m:Key>
    <m:Value xsi:type="xs:dateTime">2014-09-30T00:00:00</m:Value>
    <m:ValueType>dateTime</m:ValueType>
</m:List>
</m:parameters></p>

List не может быть пустым — каждый параметр должен быть описан как отдельный элемент.

Иерархия parameters:
Key: parameters
List (массив) → каждый элемент → Key, Value, ValueType

Параметр Тип Обязательно Описание
FromDate dateTime Дата, с которой формируется отчёт. Если не указана, то отчёт формируется с начала предыдущего месяца
ToDate dateTime Дата, по которую формируется отчёт. Если не указана, то отчёт формируется до конца предыдущего месяца
OrderNumber string Номер заказа, если мы хотим сформировать отчёт только по данным одного заказа
WaybillNumber string Номер накладной, если мы хотим сформировать отчёт только по данным одной накладной
Indetail boolean Выводить информацию по товарам (для PartialRedemptionOfGoods и ReturnOfGoods)
Archive boolean Выводить информацию в ахив в zip-файл (для PartialRedemptionOfGoods)
Возвращаемые параметры

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


Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок). 

Параметр Тип Обязательно Описание
Ответ по отчету детализация счетов

 Корневой контейнер ответа метода Report содержит return с Key = Report, Fields (повторяются), содержащие описание колонок и List с данными отчёта.
Описание колонок отчёта (название и тип данных). Каждый параметр представлен отдельным блоком Fields, содержащим:

  • Key — название колонки (варианты в таблице ниже зависят от типа отчёта)
  • Value — тип данных колонки (string, int, decimal, dateTime и т.д.)
  • ValueType — тип значения (всегда string)

Варианты Key для отчета Детализация счетов:

Параметр Тип Обязательно Описание
Return boolean Признак наличия возврата по доставке
Readdress boolean Признак наличия переадресации по доставке
WaybillNumber string Номер накладной
OrderNumber string Номер заказа
PickupDate dateTime Дата забора груза
ContactPerson string Контактное лицо
Origin string Место (населённый пункт или страна) отправления
Destination string Место (населённый пункт или страна) назначения
Urgency string Срочность
TypeOfCargo string Вид груза
DeliveryDate dateTime Дата доставки
RecipientPerson string Получившее лицо
Qty int Количество мест
Weight float Вес, кг.
Price float Стоимость доставки
Возвращаемые параметры List

Каждый раздел в списке List в виде структуры Element представляет собой описание документа «Группировка накладных» заполнен следующим образом:

Параметр Тип Обязательно Описание
Key string «SummaryOfWaybills»
Value string Номер группировки накладных
Properties Element Дополнительные свойства группировки накладных
Fields Element Дополнительные поля группировки накладных
List Element Список оказанных услуг по этой группировке накладных
Возвращаемый список сохраняемых свойств в Properties для группы накладных
Параметр Тип Обязательно Описание
Number string Номер документа «Группировка накладных»
Date dateTime Дата документа «Группировка накладных»
GUID string GUID (Globally Unique Identifier) документа в системе «Карго»
Возвращаемый список сохраняемых полей в Fields для группы накладных
Параметр Тип Обязательно Описание
Client string Клиент
Contract string Наименование (номер) договора
ContractDate dateTime Дата договора
ContractCurrency string Валюта договора
Comment string Комментарий к документу
Total float Общая сумма по «Группировке накладных»
TotalText string Текстовое представление для поля Total
Возвращаемые параметры вложенного List

Каждый раздел в списке List документа «Группировка накладных» представляет собой описание оказываемой услуги в виде структуры Element и заполнен следующим образом: 

Параметр Тип Обязательно Описание
Key string «ServiceName»
Value string Наименование услуги
Properties Element Дополнительные свойства услуги
Rows Element Строки отчёта, каждая из которых соответствует конкретной накладной, попавшей в группу накладных. Они представлены в виде структуры Row. В структуре Row конкретные данные по накладной находятся в списке Cells.
Содержимое и порядок данных в Cells соответствует списку колонок, описанному ниже.
Возвращаемый список сохраняемых свойств в Properties для услуги
Параметр Тип Обязательно Описание
Total float Суммарная стоимость всех доставок по этой услуге
TotalWithRebate float Суммарная стоимость всех доставок по этой услуге после применения скидки
DiscountPercent float Процент скидки
GUID string GUID (Globally Unique Identifier) услуги в системе Карго. Актуальный услуг доступен в GetReferenceData: Services.
Примеры запроса/ответа
<soap:Envelope
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header/>
  <soap:Body>
    <m:Report
      xmlns:m="http://www.cargo3.ru">
      <m:login>LOGIN</m:login>
      <m:password>PASSWORD</m:password>
      <m:name>SummaryOfPayments</m:name>
      <m:parameters>
        <m:Key>Parameters</m:Key>
        <m:List>
          <m:Key>FromDate</m:Key>
          <m:Value xsi:type="xs:dateTime">2014-09-01T00:00:00</m:Value>
          <m:ValueType>dateTime</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>ToDate</m:Key>
          <m:Value xsi:type="xs:dateTime">2014-09-30T00:00:00</m:Value>
          <m:ValueType>dateTime</m:ValueType>
        </m:List>
      </m:parameters>
    </m:Report>
  </soap:Body>
</soap:Envelope>
<soap:Envelope
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header/>
  <soap:Body>
    <m:ReportResponse
      xmlns:m="http://www.cargo3.ru">
      <m:return
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <m:Key>Report</m:Key>
        <m:Fields>
          <m:Key>Return</m:Key>
          <m:Value xsi:type="xs:string">boolean</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>Readdress</m:Key>
          <m:Value xsi:type="xs:string">boolean</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>WaybillNumber</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>OrderNumber</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>PickupDate</m:Key>
          <m:Value xsi:type="xs:string">dateTime</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>ContactPerson</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>Origin</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>Destination</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>Urgency</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>TypeOfCargo</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>DeliveryDate</m:Key>
          <m:Value xsi:type="xs:string">dateTime</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>RecipientPerson</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>Qty</m:Key>
          <m:Value xsi:type="xs:string">int</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>Weight</m:Key>
          <m:Value xsi:type="xs:string">float</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>Price</m:Key>
          <m:Value xsi:type="xs:string">float</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:List>
          <m:Key>SummaryOfWaybills</m:Key>
          <m:Value xsi:type="xs:string">498-00000118294</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Properties>
            <m:Key>Number</m:Key>
            <m:Value xsi:type="xs:string">498-00000118294</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Date</m:Key>
            <m:Value xsi:type="xs:dateTime">2014-08-31T23:59:59</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Properties>
          <m:Fields>
            <m:Key>Client</m:Key>
            <m:Value xsi:type="xs:string">CLIENT</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Contract</m:Key>
            <m:Value xsi:type="xs:string">CONTRACT</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>ContractDate</m:Key>
            <m:Value xsi:type="xs:dateTime">2014-04-01T00:00:00</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>ContractCurrency</m:Key>
            <m:Value xsi:type="xs:string">RUR</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>ContractCurrencyCode</m:Key>
            <m:Value xsi:type="xs:string">643</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Comment</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Total</m:Key>
            <m:Value xsi:type="xs:decimal">125834.73</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>TotalText</m:Key>
            <m:Value xsi:type="xs:string">Сто двадцать пять тысяч восемьсот тридцать четыре Рубля 73 копейки</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:List>
            <m:Key>ServiceName</m:Key>
            <m:Value xsi:type="xs:string">Обработка возврата</m:Value>
            <m:ValueType>string</m:ValueType>
            <m:Properties>
              <m:Key>Total</m:Key>
              <m:Value xsi:type="xs:decimal">400</m:Value>
              <m:ValueType>float</m:ValueType>
            </m:Properties>
            <m:Rows>
              <m:Cells xsi:type="xs:boolean">false</m:Cells>
              <m:Cells xsi:type="xs:boolean">false</m:Cells>
              <m:Cells xsi:type="xs:string">495-42469-3805</m:Cells>
              <m:Cells xsi:type="xs:string">495-0007626010</m:Cells>
              <m:Cells xsi:type="xs:dateTime">2014-07-08T00:00:00</m:Cells>
              <m:Cells xsi:type="xs:string"/>
              <m:Cells xsi:type="xs:string">Москва г</m:Cells>
              <m:Cells xsi:type="xs:string">Москва г</m:Cells>
              <m:Cells xsi:type="xs:string">Суточная</m:Cells>
              <m:Cells xsi:type="xs:string">Груз</m:Cells>
              <m:Cells xsi:type="xs:dateTime">2014-08-07T22:19:34</m:Cells>
              <m:Cells xsi:type="xs:string">Возврат</m:Cells>
              <m:Cells xsi:type="xs:decimal">1</m:Cells>
              <m:Cells xsi:type="xs:decimal">4.3</m:Cells>
              <m:Cells xsi:type="xs:decimal">25</m:Cells>
            </m:Rows>
            <m:Rows>
              <m:Cells xsi:type="xs:boolean">false</m:Cells>
              <m:Cells xsi:type="xs:boolean">false</m:Cells>
              <m:Cells xsi:type="xs:string">999-0001740356</m:Cells>
              <m:Cells xsi:type="xs:string">999-0001740356</m:Cells>
              <m:Cells xsi:type="xs:dateTime">2014-08-20T00:00:00</m:Cells>
              <m:Cells xsi:type="xs:string"/>
              <m:Cells xsi:type="xs:string">Москва г</m:Cells>
              <m:Cells xsi:type="xs:string">Москва г</m:Cells>
              <m:Cells xsi:type="xs:string">Суточная</m:Cells>
              <m:Cells xsi:type="xs:string">Груз</m:Cells>
              <m:Cells xsi:type="xs:dateTime">2014-08-21T16:40:00</m:Cells>
              <m:Cells xsi:type="xs:string">Маретин</m:Cells>
              <m:Cells xsi:type="xs:decimal">1</m:Cells>
              <m:Cells xsi:type="xs:decimal">0.2</m:Cells>
              <m:Cells xsi:type="xs:decimal">6.65</m:Cells>
            </m:Rows>
...
            
            <m:Rows>
              <m:Cells xsi:type="xs:boolean">false</m:Cells>
              <m:Cells xsi:type="xs:boolean">false</m:Cells>
              <m:Cells xsi:type="xs:string">495-42469-4048</m:Cells>
              <m:Cells xsi:type="xs:string">495-0007909347</m:Cells>
              <m:Cells xsi:type="xs:dateTime">2014-08-21T00:00:00</m:Cells>
              <m:Cells xsi:type="xs:string"/>
              <m:Cells xsi:type="xs:string">Москва г</m:Cells>
              <m:Cells xsi:type="xs:string">Москва г</m:Cells>
              <m:Cells xsi:type="xs:string">Суточная</m:Cells>
              <m:Cells xsi:type="xs:string">Груз</m:Cells>
              <m:Cells xsi:type="xs:dateTime">2014-08-21T12:00:00</m:Cells>
              <m:Cells xsi:type="xs:string">Тарасов</m:Cells>
              <m:Cells xsi:type="xs:decimal">1</m:Cells>
              <m:Cells xsi:type="xs:decimal">5</m:Cells>
              <m:Cells xsi:type="xs:decimal">100</m:Cells>
            </m:Rows>
          </m:List>
          <m:List>
            <m:Key>ServiceName</m:Key>
            <m:Value xsi:type="xs:string">Хранение товаров свыше 45 суток</m:Value>
            <m:ValueType>string</m:ValueType>
            <m:Properties>
              <m:Key>Total</m:Key>
              <m:Value xsi:type="xs:decimal">10232.82</m:Value>
              <m:ValueType>float</m:ValueType>
            </m:Properties>
            <m:Rows>
              <m:Cells xsi:type="xs:boolean">false</m:Cells>
              <m:Cells xsi:type="xs:boolean">false</m:Cells>
              <m:Cells xsi:type="xs:string">495-0007972445</m:Cells>
              <m:Cells xsi:type="xs:string"/>
              <m:Cells xsi:type="xs:dateTime">2014-08-29T00:00:00</m:Cells>
              <m:Cells xsi:type="xs:string"/>
              <m:Cells xsi:type="xs:string">Москва г</m:Cells>
              <m:Cells xsi:type="xs:string">Москва г</m:Cells>
              <m:Cells xsi:type="xs:string">Срочная</m:Cells>
              <m:Cells xsi:type="xs:string">Груз</m:Cells>
              <m:Cells xsi:nil="true"/>
              <m:Cells xsi:type="xs:string"/>
              <m:Cells xsi:type="xs:decimal">23</m:Cells>
              <m:Cells xsi:type="xs:decimal">0.1</m:Cells>
              <m:Cells xsi:type="xs:decimal">10232.82</m:Cells>
            </m:Rows>
          </m:List>
        </m:List>
      </m:return>
    </m:ReportResponse>
  </soap:Body>
</soap:Envelope>