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

Обновлено 07.03.2024

120 кб

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

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

Получение данных через этот сервис возможно только при наличии полного доступа к контрагенту (см. метод "Список контрагентов", описание параметра ответа "info.accessLevel").

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

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

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

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "cauid":"00000000-0000-0000-0000-000000000000",
   "month":1,
   "year":2020
}

Адрес метода: https://api.dellin.ru/v2/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>1</month>
   <year>2020</year>
</request>

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

Request

Request
Параметр	Обязательный	Тип	Описание
appkey	Да	string	Ключ приложения. Для получения ключа необходимо пройти регистрацию
sessionID	Да	string	ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
cauid	Нет	string	UID контрагента, по которому требуется получить информацию о взаиморасчётах. У учётной записи должен быть полный доступ к контрагенту (см. метод "Получение списка контрагентов", описание параметра ответа "info.accessLevel"). Если параметр отсутствует в запросе, то в ответе будет передана информация по контрагенту по умолчанию
month	Да	integer	Месяц, за который нужно получить информацию (1)
year	Да	integer	Год, за который нужно получить информацию (1)
Примечания: (1) Для получения списка периодов, по которым доступна информация о взаиморасчётах, следует использовать метод "Периоды взаиморасчётов"

Ответ метода

Структура ответа

JSON
XML

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "balance":{
         "opening":{
            "date":"2016-04-01 00:00:00",
            "sum":380
         },
         "closing":{
            "date":"2016-04-30 23:59:59",
            "sum":0
         }
      },
      "documents":[
         {
            "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,
            "paymentInfo":{
               "payment":true,
               "paymentState":"paid",
               "dataForReceipt":{
                  "phoneNumber":"+79110000000",
                  "email":"meow@mail.ru"
               }
            },
            "cashOrder":1,
            "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>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <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>
      <documents>
         <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>
         <paymentInfo>
            <payment>true</payment>
            <paymentState>paid</paymentState>
            <dataForReceipt>
               <phoneNumber>+79110000000</phoneNumber>
               <email>meow@mail.ru</email>
            </dataForReceipt>
         </paymentInfo>
         <cashOrder>1</cashOrder>
         <docSQLuid>0xac62ce6428515cce4086e2efa77c06dd</docSQLuid>
         <giveOutDate>2016-04-06 17:17:53</giveOutDate>
      </documents>
      <documents>
         <sum>1042.5</sum>
         <doc>Приходный кассовый ордер 03022000156 от 6 апреля 2016 г.</doc>
         <date>2016-04-06 17:19:13</date>
         <docType>ПКО</docType>
         <docID>03022000156</docID>
      </documents>
      <documents>
         <sum>380</sum>
         <doc>Приходный кассовый ордер 03022000158 от 6 апреля 2016 г.</doc>
         <date>2016-04-06 17:25:00</date>
         <docType>ПКО</docType>
         <docID>03022000158</docID>
      </documents>
   </data>
</response>

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

Response

Response
Параметр	Тип	Описание
metadata	object	Системная информация
metadata.status	integer	Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_at	string	Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
data	object	Данные по взаиморасчётам
data.balance	Balance	Информация о движении денежных средств
data.documents	array of Documents	Информация о документах. Массив присутствует в ответе только в том случае, если в заданном периоде были движения документов

Balance

Balance
Параметр	Тип	Описание
opening	object	Баланс на начало периода
opening.date	string	Дата начала периода
opening.sum	float	Сумма на начало периода, руб
closing	object	Баланс на конец периода
closing.date	string	Дата окончания периода
closing.sum	float	Сумма на конец периода, руб

Documents

Documents
Параметр	Тип	Описание
sum	float	Сумма по документу, руб. В случае расходного кассового ордера и накладной (значение параметра ответа "data.documents.docType" - "РКО" или "накладная") значение параметра - отрицательное число, в остальных случаях - положительное число
doc	string	Наименование и реквизиты документа
date	string	Дата создания документа Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
docType	string	Вид документа
docID	string	Номер документа
description	string	Полное наименование документа (1)
begin	float	Сумма на начало периода, руб (1)
end	float	Сумма на конец периода, руб (1)
debit	float	Сумма к оплате, руб (1)
credit	float	Сумма задолженности, руб (1)
paymentInfo	object	Информация по оплате документа (1)
paymentInfo.payment	boolean	Информация о ПКО (приходном кассовом ордере). Возможные значения: "true" - на основании накладной был создан ПКО; "false" - на основании накладной не было создано ПКО
paymentInfo.paymentState	string	Статус оплаты накладной. Возможные значения: "paid" - оплачена; "not_paid"- не оплачена; "in_process" - платеж в обработке
paymentInfo.dataForReceipt	DataForReceipt	Контактные данные для отправки электронного чека плательщику-физическому лицу. Параметр присутствует в ответе, только если контрагент по умолчанию / контрагент, UID которого передан в запросе (см. описание параметра "cauid"), является плательщиком по накладной. Данные могут быть использованы для предварительного заполнения формы оплаты
cashOrder	integer	Номер чека (платёжного документа) (1)
docSQLuid	string	UID документа (1)
giveOutDate	string	Дата выдачи документа (1) Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
Примечания: Параметр присутствует в ответе, только если значение параметра docType - "Накладная"

DataForReceipt

DataForReceipt
Параметр	Тип	Описание
phoneNumber	string	Номер телефона для отправки чека. Данные присутствуют в ответе, если соответствующая информация есть в адресной книге
email	string	Адрес электронной почты для отправки чека. Данные присутствуют в ответе, если соответствующая информация есть в адресной книге

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

Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:

Номер ошибки	http-код	Краткое описание ошибки
703001	403	Доступ к контрагентам отсутствует

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

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

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

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

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

Структура запроса

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

Request

Ответ метода

Структура ответа

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

Response

Balance

Documents

DataForReceipt

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