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

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

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

Обновлено 13.01.2020
116 кб

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

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

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

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

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

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

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

{   
   "appkey":"00000000-0000-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-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":"2016-04-01 00:00:00",
         "sum":380
      },
      "closing":{
         "date":"2016-04-30 23:59:59",
         "sum":0
      }
   },
   "document":[
      {
         "sum":1042.5,
         "doc":"Накладная 16-00031037176 от 1 апреля 2016 г.",
         "date":"2016-04-01 17:29:33",
         "docType":"Накладная",
         "docID":"16-00031037176",
         "description":"Накладная 16-00031037176 от 1 апреля 2016 г.",
         "begin":380,
         "end":1422.5,
         "debit":1042.5,
         "credit":0,
         "payment":true,
         "cashOrder":1,
         "freightName":"Мебель",
         "quantity":1,
         "weight":3,
         "volume":0.1,
         "overSizedQuantity":0,
         "overSizedWeight":0,
         "overSizedVolume":0,
         "maxLength":0.02,
         "maxWidth":3,
         "maxHeight":0.02,
         "docSQLuid":"0xac62ce6428515cce4086e2efa77c06dd",
         "giveOutDate":"2016-04-06 17:17:53"
      },
      {
         "sum":-1042.5,
         "doc":"Приходный кассовый ордер 03022000156 от 6 апреля 2016 г.",
         "date":"2016-04-06 17:19:13",
         "docType":"ПКО",
         "docID":"03022000156"
      },
      {
         "sum":-380,
         "doc":"Приходный кассовый ордер 03022000158 от 6 апреля 2016 г.",
         "date":"2016-04-06 17:25:00",
         "docType":"ПКО",
         "docID":"03022000158"
      }
   ]
}
<response>
   <balance>
      <opening>
         <date>2016-04-01 00:00:00</date>
         <sum>380</sum>
      </opening>
      <closing>
         <date>2016-04-30 23:59:59</date>
         <sum>0</sum>
      </closing>
   </balance>
   <document>
      <sum>1042.5</sum>
      <doc>Накладная 16-00031037176 от 1 апреля 2016 г.</doc>
      <date>2016-04-01 17:29:33</date>
      <docType>Накладная</docType>
      <docID>16-00031037176</docID>
      <description>Накладная 16-00031037176 от 1 апреля 2016 г.</description>
      <begin>380</begin>
      <end>1422.5</end>
      <debit>1042.5</debit>
      <credit>0</credit>
      <payment>true</payment>
      <cashOrder>1</cashOrder>
      <freightName>Мебель</freightName>
      <quantity>1</quantity>
      <weight>3</weight>
      <volume>0.1</volume>
      <overSizedQuantity>0</overSizedQuantity>
      <overSizedWeight>0</overSizedWeight>
      <overSizedVolume>0</overSizedVolume>
      <maxLength>0.02</maxLength>
      <maxWidth>3</maxWidth>
      <maxHeight>0.02</maxHeight>
      <docSQLuid>0xac62ce6428515cce4086e2efa77c06dd</docSQLuid>
      <giveOutDate>2016-04-06 17:17:53</giveOutDate>
   </document>
   <document>
      <sum>-1042.5</sum>
      <doc>Приходный кассовый ордер 03022000156 от 6 апреля 2016 г.</doc>
      <date>2016-04-06 17:19:13</date>
      <docType>ПКО</docType>
      <docID>03022000156</docID>
   </document>
   <document>
      <sum>-380</sum>
      <doc>Приходный кассовый ордер 03022000158 от 6 апреля 2016 г.</doc>
      <date>2016-04-06 17:25:00</date>
      <docType>ПКО</docType>
      <docID>03022000158</docID>
   </document>
</response>

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

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

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

Response.Document
ПараметрТипОписание
sumfloatСумма по документу, руб
docstringНаименование и реквизиты документа
date stringДата создания документа
docTypestringВид документа
docIDstringНомер документа
descriptionstring

Полное наименование документа*

beginfloat

Сумма на начало периода, руб*

endfloat

Сумма на конец периода, руб*

debitfloat

Сумма к оплате, руб*

creditfloat

Сумма задолженности, руб*

paymentinteger

Информация о ПКО (приходном кассовом ордере)*

Возможные значения:

1 - на основании накладной был создан ПКО;

0 - на основании накладной не было создано ПКО

cashOrderinteger

Номер чека (платёжного документа)*

freightNamestring

Характер груза*

quantityinteger

Количество грузовых мест*

weightfloat

Вес груза, кг*

volumefloat

Объём груза, м3*

overSizedQuantityfloatКоличество негабаритных мест*
overSizedWeightfloatВес негабаритной части груза, кг*
overSizedVolumefloatОбъём негабаритной части груза, м3*
maxLengthfloatМаксимальная длина груза, м*
maxWidthfloatМаксимальная ширина груза, м*
maxHeightfloatМаксимальная высота груза, м*
docSQLuidstring
UID документа*
giveOutDatestring
Дата выдачи документа*

* Параметр присутствует в ответе, только если значение параметра docType - "Накладная"

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

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

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

{  
   "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-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-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]), за которые доступна информация о взаиморасчетах