Поиск по сайту

API
Главная / API - Взаиморасчеты

Взаиморасчеты

Обновлено 09.08.2017
89 кб

Общие сведения

Сервис позволяет получать информацию о движении денежных средств в разрезе накладных и оплаченных счетов.

Обратите внимание, что для получения данных через этот сервис у вашего аккаунта в личном кабинете должен быть доступ хотя бы к одному контрагенту (подробнее о доступе).

Калькулятор взаиморасчетов с детализацией

Запрос метода

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

Адрес метода: https://api.dellin.ru/v1/customers/mutual_calculations.json

{   
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "cauid":"00000000-0000-0000-0000-000000000000",
   "month":12,
   "year":2013
}

Адрес метода: https://api.dellin.ru/v1/customers/mutual_calculations.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <cauid>00000000-0000-0000-0000-000000000000</cauid>
   <month>12</month>
   <year>2013</year>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

cauid

НетstringUID контрагента, по которому требуется получить информацию о взаиморасчётах. Если не передан, то расчет идёт для контрагента по умолчанию (подробнее в описании метода "Получение списка контрагентов")
monthДаintegerМесяц, за который нужно получить информацию
yearДаintegerГод, за который нужно получить информацию

Ответ метода

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

{  
   "balance":{  
      "opening":{  
         "date":"2013-12-01 00:00:00",
         "sum":"0.0"
      },
      "closing":{  
         "date":"2013-12-31 23:59:59",
         "sum":"20.0"
      }
   },
   "document":[  
      {  
         "date":"2013-12-04 13:15:38",
         "doc":"Движение    банк 000000000000 from 04.12.2013 13:15:38",
         "sum":"100.0"
      },
      {  
         "date":"2013-12-12 15:16:13",
         "doc":"Накладная 13-00000000000 from 09.12.2013 18:16:22",
         "sum":"-100.0"
      },
      {  
         "date":"2013-12-21 15:09:06",
         "doc":"Приходный кассовый ордер    000000000000 from 21.12.2013 15:08:48",
         "sum":"220.0"
      },
      {  
         "date":"2013-12-26 17:48:29",
         "doc":"Накладная 13-00000000000 from 19.12.2013 23:56:02",
         "sum":"-200.0"
      }
   ]
}
<response>
   <balance>
      <opening>
         <date>2013-12-01 00:00:00</date>
         <sum>0.0</sum>
      </opening>
      <closing>
         <date>2013-12-31 23:59:59</date>
         <sum>20.0</sum>
      </closing>
   </balance>
   <document>
      <date>2013-12-04 13:15:38</date>
      <doc>Движение    банк 000000000000 from 04.12.2013 13:15:38</doc>
      <sum>100.0</sum>
   </document>
   <document>
      <date>2013-12-12 15:16:13</date>
      <doc>Накладная 13-00000000000 from 09.12.2013 18:16:22</doc>
      <sum>-100.0</sum>
   </document>
   <document>
      <date>2013-12-21 15:09:06</date>
      <doc>Приходный кассовый ордер    000000000000 from 21.12.2013 15:08:48</doc>
      <sum>220.0</sum>
   </document>
   <document>
      <date>2013-12-26 17:48:29</date>
      <doc>Накладная 13-00000000000 from 19.12.2013 23:56:02</doc>
      <sum>-200.0</sum>
   </document>
</response>

Описание параметров

Response
ПараметрТипОписание
balanceResponse.BalanceИнформация о движении денежных средств
documentarray of Response.DocumentИнформация о документах. Массив присутствует в ответе только в том случае, если в заданном периоде были движения документов

Response.Balance
ПараметрТипОписание
openingobjectБаланс на начало периода
opening.datestringДата начала периода
opening.sumstringСумма на начало периода
closingobjectБаланс на конец периода
closing.datestringДата окончания периода
closing.sumstringСумма на конец периода

Response.Document
ПараметрТипОписание
datestringДата создания документа
docstringНаименование и реквизиты документа
sumstringСумма по документу

Обработка ошибок

Если у Вас нет доступа к контрагентам, или не выбран текущий контрагент, Вы получите ответ вида: 

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

{  
   "error":{  
      "code":"403",
      "description":"Не выбран текущий контрагент. Возможно у вас нет доступа к контрагентам."
   }
}
<response>
   <error>
      <code>403</code>
      <description>Не выбран текущий контрагент. Возможно у вас нет доступа к контрагентам.</description>
   </error>
</response>

Период доступных взаиморасчетов

Данный метод позволяет получить информацию о периоде, за который можно получить информацию о взаиморасчетах с помощью метода "Калькулятор взаиморасчетов с детализацией".

Запрос метода

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

Адрес метода: https://api.dellin.ru/v1/customers/mutual_period.json

{   
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "cauid":"00000000-0000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/customers/mutual_period.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <cauid>00000000-0000-0000-0000-000000000000</cauid>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

cauid

НетstringUID контрагента, по которому требуется получить информацию о периоде доступных взаиморасчётов

Ответ метода

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

{
   "years": {
      "2016": {
         "months": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
      },
      "2017": {
         "months": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
      }
   }
}
<response>
   <years>
      <2016>
         <months>1</months>
         <months>2</months>
         <months>3</months>
         <months>4</months>
         <months>5</months>
         <months>6</months>
         <months>7</months>
         <months>8</months>
         <months>9</months>
         <months>10</months>
         <months>11</months>
         <months>12</months>
      </2016>
      <2017>
         <months>1</months>
         <months>2</months>
         <months>3</months>
         <months>4</months>
         <months>5</months>
         <months>6</months>
         <months>7</months>
         <months>8</months>
         <months>9</months>
         <months>10</months>
         <months>11</months>
         <months>12</months>
      </2017>
   </years>
</response>

Описание параметров

Response
ПараметрТипОписание
yearsResponse.YearsПеречень лет, за которые доступна информация о взаиморасчетах

Response.Years
ПараметрТипОписание
[Year]object

Наименование объекта вместо "[Year]" содержит номер года (например "2016").

Объект содержит информацию о месяцах указанного года, за которые доступна информация о взаиморасчетах

[Year].monthsarray of integerПеречень номеров месяцев в рамках указанного года ([Year]), за которые доступна информация о взаиморасчетах