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

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

Периоды взаиморасчётов

Обновлено 26.06.2020
78 кб

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

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

Периоды взаиморасчётов

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

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

Адрес метода: https://api.dellin.ru/v2/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/v2/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
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

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

cauid

Нетstring

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

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "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>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <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>
   </data>
</response>

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

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

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

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

dataobjectИнформация о периодах, за которые доступна информация о взаиморасчетах
data.yearsYears

Годы, за которые доступна информация о взаиморасчетах

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

Год, за который доступна информация о взаиморасчётах (наименование объекта вместо "[Year]" содержит номер года, например, "2016")

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

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

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

Номер ошибки

http-код

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

704001

403

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