Перейти к содержимому

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

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

SOAP Endpoint: Report Обновлено: 2026-05-25
  • Endpoint: Report
  • SOAP-метод: Report -Summaryofcod
  • Группа: Report
  • Создано: 25.05.2026 · Обновлено: 25.05.2026

Описание

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

Параметры запроса

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

Описание параметра parameters

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

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

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

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

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

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

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

xml 
<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>

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
нет
Данные агента

Пример запроса (XML Request)

xml 
<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>

Пример ответа (XML Response)

xml 
<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>

Смежные методы

Report -GoodsOrderDiscrepancy

Позволяет получить данные о расхождениях заказов и поступлений

Report - PartialRedemptionOfGoods

Функция позволяет получить отчёт по названию, в котором содержится подробная информация.  «PartialRedemptionOfGoods»....

Report -SummaryOfPayments