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

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

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

Обновлено 29.06.2020
113 кб

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

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

Получение данных через этот сервис возможно только при наличии полного доступа к контрагенту (см. метод "Список контрагентов", описание параметра ответа "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

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

cauid

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

Примечания:

(1)  Для получения списка периодов, по которым доступна информация о взаиморасчётах, следует использовать метод "Периоды взаиморасчётов"

Ответ метода

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

{
   "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":{
               "paymentLink":"https://test.pps.gazprombank.ru/payment/start.wsm?lang=RU&merch_id=C9871DDCA9035AE7008B3A6F99612EAE&back_url_s=http://www.dellin.stage/cabinet/orders/&back_url_f=http://www.dellin.stage/cabinet/orders/?           fail_payment=1&o.order[doc_id]=2000085008385&o.user_id=132961&o.payer_uid=0x9417742b9f16abc042749fd9e5de4c21&o.doc_uid=0x819500505683398711ea40e20a435d1b&o.platform=ios&o.paymentState=not_paid",
               "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>
            <paymentLink>https://test.pps.gazprombank.ru/payment/start.wsm?lang=RU&merch_id=C9871DDCA9035AE7008B3A6F99612EAE&back_url_s=http://www.dellin.stage/cabinet/orders/&back_url_f=http://www.dellin.stage/cabinet/orders/?           fail_payment=1&o.order[doc_id]=2000085008385&o.user_id=132961&o.payer_uid=0x9417742b9f16abc042749fd9e5de4c21&o.doc_uid=0x819500505683398711ea40e20a435d1b&o.platform=ios&o.paymentState=not_paid</paymentLink>
            <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
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectДанные по взаиморасчётам
data.balanceBalanceИнформация о движении денежных средств
data.documentsarray of DocumentsИнформация о документах. Массив присутствует в ответе только в том случае, если в заданном периоде были движения документов

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

Documents
Documents
ПараметрТипОписание
sumfloat

Сумма по документу, руб.

В случае расходного кассового ордера и накладной (значение параметра ответа "data.documents.docType" - "РКО" или "накладная") значение параметра - отрицательное число, в остальных случаях - положительное число
docstringНаименование и реквизиты документа
date string

Дата создания документа

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

docType

stringВид документа
docIDstringНомер документа
descriptionstring

Полное наименование документа (1)

beginfloat

Сумма на начало периода, руб (1)

endfloat

Сумма на конец периода, руб (1)

debitfloat

Сумма к оплате, руб (1)

creditfloat

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

paymentInfo

objectИнформация по оплате документа (1)

paymentInfo.paymentLink

string

Ссылка для онлайн оплаты.

Параметр присутствует в ответе, только если оплата не была произведена (значение параметра "paymentInfo.paymentState" - "not_paid")

paymentInfo.payment

boolean

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

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

  • "true" - на основании накладной был создан ПКО;
  • "false" - на основании накладной не было создано ПКО

paymentInfo.paymentState

string

Статус оплаты накладной.

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

  • "paid" - оплачена;
  • "not_paid"- не оплачена;
  • "in_process" - платеж в обработке

paymentInfo.dataForReceipt

DataForReceipt

Контактные данные для отправки электронного чека плательщику-физическому лицу.

Параметр присутствует в ответе, только если контрагент по умолчанию/контрагент, UID которого передано в запросе (см. описание параметра ""), является плательщиком по накладной.

Данные могут быть использованы для предварительного заполнения формы оплаты

cashOrderinteger

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

docSQLuidstring
UID документа (1)
giveOutDatestring

Дата выдачи документа (1)

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

Примечания:

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

DataForReceipt

DataForReceipt

ПараметрТипОписание

phoneNumber

stringНомер телефона для отправки чека. Данные присутствуют в ответе, если соответствующая информация есть в адресной книге

email

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

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

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

Номер ошибки

http-код

Краткое описание ошибки

703001

403

Доступ к контрагентам отсутствует