Try it — Report -Summaryofcod
SOAP Request

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

Report: Отчет агента

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

Отчет позволяет получить данные агента

Параметры запроса
Параметр Тип Обязательно Описание
login string Логин пользователя
password string Пароль
parameters Element
name string Наименование отчёта = summaryofcod для отчета агента
Описание параметра 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 Номер накладной, если мы хотим сформировать отчёт только по данным одной накладной
Возвращаемые параметры

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

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

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

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

Данные отчета возвращаются в Rows - Строки отчёта, каждая из которых соответствует конкретной накладной, попавшей в группу накладных. Они представлены в виде структуры Row. В структуре Row конкретные данные по накладной находятся в списке Cells.

Содержимое и порядок данных в Cells соответствует списку колонок, описанному ниже.

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

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

Варианты Key для Fields отчета:

Параметр Тип Обязательно Описание
Nom int Порядковый номер
AgentNumber string Номер агента
ClientNumber string Номер клиента
WaybillNumber string Номер накладной
WaybillData dateTime Дата накладной
Recipient string Получатель
RecipientPhone string Телефон получателя
RecipientGeography string География получателя
RecipientAddress string Адрес получателя
DeliveryDate dateTime Дата доставки груза
Weight float Вес
SumDeclared decimal Объявленная стоимость
SumCOD decimal Сумма наложенного платежа наличными
SumCODСS decimal Сумма наложенного платежа по экварингу
SumReturn decimal Сумма возврата
Список сохраняемых свойств в Properties общая информация по документу

Варианты Key для Properties отчета:

Параметр Тип Обязательно Описание
ReportAgentNumber string Номер отчета агента
Number string Номер отчета агента
Date dateTime Дата документа
Client string Контрагент
Contract string Договор контрагента
Agent string Компания предоставляющая услуги
Period string Период отчета
Comment string Общий комментарий по отчету
ALLSumCOD float Сумма наложенного платежа наличными из отчета агента
ALLSumCODCS float
ALLSumReturn float Сумма возврата
ALLSumDelivery float Сумма стоимости услуг по доставке
SumInWords string Стоимость услуг прописью
SumNDSInWords string Сумма НДС прописью
FIOPrincipal string Данные подписанта
FIOAgent string Данные агента
Примеры запроса/ответа 
<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>summaryofcod</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: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>Nom</m:Key>
          <m:Value xsi:type="xs:string">int</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>AgentNumber</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>ClientNumber</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>WaybillData</m:Key>
          <m:Value xsi:type="xs:string">string</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>Recipient</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>RecipientPhone</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>RecipientGeography</m:Key>
          <m:Value xsi:type="xs:string">string</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>RecipientAddress</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">string</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>SumDeclared</m:Key>
          <m:Value xsi:type="xs:string">decimal</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>SumCOD</m:Key>
          <m:Value xsi:type="xs:string">decimal</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>SumCODCS</m:Key>
          <m:Value xsi:type="xs:string">decimal</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>SumReturn</m:Key>
          <m:Value xsi:type="xs:string">decimal</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:List>
          <m:Key>ReportAgentNumber</m:Key>
          <m:Value xsi:type="xs:string">498-00000046178</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Properties>
            <m:Key>Number</m:Key>
            <m:Value xsi:type="xs:string">498-00000046178</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Date</m:Key>
            <m:Value xsi:type="xs:string">10 ноября 2018 г.</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Agent</m:Key>
            <m:Value xsi:type="xs:string">ООО "Курьер-Регион Столица"</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Client</m:Key>
            <m:Value xsi:type="xs:string">ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Contract</m:Key>
            <m:Value xsi:type="xs:string">Договор № ???</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Period</m:Key>
            <m:Value xsi:type="xs:string">с 26.10.2018 по 10.11.2018</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>Comment</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>ALLSumCOD</m:Key>
            <m:Value xsi:type="xs:decimal">953333.7</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>ALLSumCODCS</m:Key>
            <m:Value xsi:type="xs:decimal">0</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>ALLSumReturn</m:Key>
            <m:Value xsi:type="xs:decimal">0</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>ALLSumDelivery</m:Key>
            <m:Value xsi:type="xs:decimal">14300.58</m:Value>
            <m:ValueType>float</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>SumInWords</m:Key>
            <m:Value xsi:type="xs:string">Четырнадцать тысяч триста Рублей 58 копеек</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>SumNDSInWords</m:Key>
            <m:Value xsi:type="xs:string">Две тысячи сто восемьдесят один Рубль 44 копейки</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>FIOPrincipal</m:Key>
            <m:Value xsi:type="xs:string">Подписант</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Properties>
            <m:Key>FIOAgent</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Properties>
          <m:Rows>
            <m:Cells xsi:type="xs:decimal">1</m:Cells>
            <m:Cells xsi:type="xs:string"/>
            <m:Cells xsi:type="xs:string">ARU04573226-01</m:Cells>
            <m:Cells xsi:type="xs:string">21.10.2018</m:Cells>
            <m:Cells xsi:type="xs:string">495-AA-B446603496</m:Cells>
            <m:Cells xsi:type="xs:string">Ольга Кузнецова</m:Cells>
            <m:Cells xsi:type="xs:string">+7(925)848-78-13</m:Cells>
            <m:Cells xsi:type="xs:string">Москва г</m:Cells>
            <m:Cells xsi:type="xs:string">Москва г Люблинская, 52 к.1, 29</m:Cells>
            <m:Cells xsi:type="xs:string">23.10.2018</m:Cells>
            <m:Cells xsi:type="xs:decimal">0.9</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:Rows>
          <m:Rows>
            <m:Cells xsi:type="xs:decimal">2</m:Cells>
            <m:Cells xsi:type="xs:string"/>
            <m:Cells xsi:type="xs:string">ARU04573494-01</m:Cells>
            <m:Cells xsi:type="xs:string">21.10.2018</m:Cells>
            <m:Cells xsi:type="xs:string">495-AA-B446603573</m:Cells>
            <m:Cells xsi:type="xs:string">Юнис</m:Cells>
            <m:Cells xsi:type="xs:string">+7(926)144-30-56</m:Cells>
            <m:Cells xsi:type="xs:string">Москва г</m:Cells>
            <m:Cells xsi:type="xs:string">Ул.Снежная, 28,</m:Cells>
            <m:Cells xsi:type="xs:string">23.10.2018</m:Cells>
            <m:Cells xsi:type="xs:decimal">2</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:Rows>
        </m:List>
      </m:return>
    </m:ReportResponse>
  </soap:Body>
</soap:Envelope>