ROSSKO API

version           http://api.rossko.ru

/GetSettlements


SOAP http://api.rossko.ru/service/v2.1/GetSettlements

Данный сервис используется для получения информации по взаиморасчетам и реализациям.

Реализации выводятся с лимитом (20) на страницу. Для просмотра других результатов используйте параметр offset.

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

ПараметрТипОбязателенОписание
KEY1 string Да Ключ авторизации (1).
Можно получить в личном кабинете или через персонального менеджера. Пример: cba94510b02ecccef994b52711c84413
KEY2 string Да Ключ авторизации (2).
Можно получить в личном кабинете или через персонального менеджера. Пример: 8c7b4ba7acc716fe5bd7a80c513ad930
contractor string Идентификатор конкретного контрагента, если у вас их несколько.
Получить и сохранить можно при первом обращении в сервис GetSettlements. Пример: 3db1ebdd-a33c-12e2-t597-66e541e1f9ed
offset integer Смещение относительно кол-ва результатов (20) на страницу.
startDate date Дата начала выборки. Дата указывается в формате Y-m-d (2017-05-31).
При указании данного параметра - параметр endDate обязателен.
endDate date Дата конца выборки (включительно). Дата указывается в формате Y-m-d (2017-05-31).
При указании данного параметра - параметр startDate обязателен.
status string Выборка реализаций по статусу. Возможные варианты:
   Проведено
   Оплачено
   Не оплачено
   Просрочено
   Обрабатывается

Пример запроса

PHP 
$connect = array(
    'wsdl'    => 'http://api.rossko.ru/service/v2.1/GetSettlements',
    'options' => array(
        'connection_timeout' => 1,
        'trace' => true
    )
);

$param = array(
    'KEY1' => 'you_key_1',
    'KEY2' => 'you_key_2'
);

$query  = new SoapClient($connect['wsdl'], $connect['options']);
$result = $query->GetSettlements($param);

print_r($result);

Ответ

200:

Стандартный ответ
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.rossko.ru/">
   <SOAP-ENV:Body>
      <ns1:GetSettlementsResponse>
         <ns1:SettlementsResult>
            <ns1:success>true</ns1:success>
            <ns1:Info>
               <ns1:balance>-1234.56</ns1:balance>
               <ns1:type>Предоплата</ns1:type>
               <ns1:currency>руб</ns1:currency>
               <ns1:Customers>
                  <ns1:id>2db1ebed-a39c-11e2-a497-62e541d0f9ee</ns1:id>
                  <ns1:name>ЧАСТНОЕ ЛИЦО</ns1:name>
                  <ns1:balance>1500.00</ns1:balance>
               </ns1:Customers>
               <ns1:Customers>
                  <ns1:id>ed3876f3-a390-23r2-h596-32e441w0f4ed</ns1:id>
                  <ns1:name>ООО СТО</ns1:name>
                  <ns1:balance>-2734,56</ns1:balance>
               </ns1:Customers>
            </ns1:Info>
            <ns1:Summary>
               <ns1:overdueDays>10</ns1:overdueDays>
               <ns1:overdueSum>1234.56</ns1:overdueSum>
               <ns1:List>
                  <ns1:date>19.10.2020</ns1:date>
                  <ns1:sumDebt>1234.56</ns1:sumDebt>
                  <ns1:Contractor>
                     <ns1:name>ООО СТО</ns1:name>
                     <ns1:debt>1234.56</ns1:debt>
                  </ns1:Contractor>
               </ns1:List>
               <ns1:List>
                  <ns1:date>20.10.2020</ns1:date>
                  <ns1:sumDebt>789.01</ns1:sumDebt>
                  <ns1:Contractor>
                     <ns1:name>ООО СТО</ns1:name>
                     <ns1:debt>789.01</ns1:debt>
                  </ns1:Contractor>
               </ns1:List>
            </ns1:Summary>
            <ns1:Documents>
               <ns1:total>2</ns1:total>
               <ns1:limit>20</ns1:limit>
               <ns1:offset>0</ns1:offset>
               <ns1:List>
                  <ns1:date>2018-05-04T12:09:31Z</ns1:date>
                  <ns1:name>Оплата наличными ОТГЛЧ028548</ns1:name>
                  <ns1:credit>0.00</ns1:credit>
                  <ns1:balance>1563.32</ns1:balance>
                  <ns1:payer>ЧАСТНОЕ ЛИЦО</ns1:payer>
                  <ns1:status>Проведено</ns1:status>
               </ns1:List>
               <ns1:List>
                  <ns1:date>2016-12-31T23:59:59Z</ns1:date>
                  <ns1:name>Оплата наличными ОТГЛЧ028549</ns1:name>
                  <ns1:credit>36.68</ns1:credit>
                  <ns1:balance>-36.68</ns1:balance>
                  <ns1:payer>ООО СТО</ns1:payer>
                  <ns1:status>Проведено</ns1:status>
               </ns1:List>
            </ns1:Documents>
         </ns1:SettlementsResult>
      </ns1:GetSettlementsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Параметры ответа

ПараметрТипОбязателенОписание
success boolean Да Результат запроса
message string Сообщение описывающее ошибку
Info array Содержит в себе общую информацию о взаиморасчетах
balance string Да Общий баланс
limit string Кредит лимит
type string Да Тип взаиморасчетов:
   Оплата по факту
   Лимит кредит
   Предоплата
paymentDelay integer Отсрочка оплаты в днях
currency string Да Валюта
Customers array Содержит в себе информацию о контрагентах
id string Да Идентификатор контрагента
name string Да Наименование контрагента
balance string Да Баланс контрагента
Summary array Содержит в себе информацию о задолженности
overdueDays string Кол-во дней задолженности
overdueSum string Сумма задолженности
List array Содержит в себе информацию о ближайших датах выплаты задолженности
date date Да Дата оплаты задолженности
sumDebt string Да Сумма подлежащая оплате
Contractor array Содержит в себе детальную информацию по каждому контрагенту
name string Да Наименование контрагента
debt string Да Задолженность контрагента
Documents array Содержит в себе информацию по реализациям
total integer Да Всего реализаций
limit integer Да Лимит на страницу
offset integer Да Смещение относительно лимита
List array Содержит в себе подробную информацию по реализациям
date date Да Дата реализации
name string Да Наименование документа
credit string Да Сумма реализации
balance string Да Баланс на момент реализации
payer string Да Контрагент
orderId integer Номер заказа
status string Да Возможные варианты:
   Проведено
   Оплачено
   Не оплачено
   Просрочено
   Обрабатывается
daysRemaining string Осталось дней до оплаты (если не оплачено)
Items array Содержит в себе информацию о товарах
name sting Да Наименование
count int Да Колличество
price sting Да Цена