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

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

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

Описание

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

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

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

Описание параметра 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
нет
Номер накладной, если мы хотим сформировать отчёт только по данным одной накладной
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.

Пример запроса (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>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>

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

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

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

Report -GoodsOrderDiscrepancy

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

Report - PartialRedemptionOfGoods

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

Report - ReturnOfGoods

Позволяет получить информацию по возвратным накладным