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

API
Главная / API - Settlements periods

Settlements periods

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

Mutual settlements periods

The method allows getting the list of periods for which information on mutual settlements is available.

Method request

Request example

Method address: 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"
}

Method address: 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>

Description of parameters

Request
Request
ParameterRequiredTypeDescription
appkeyYesstring

Application key. To get the key, register

sessionID

YesstringTo get the session ID, use the User Authorization method

cauid

NostringUID of counterparty on which the list of periods is required (see "Available counterparties" method). If parameter is not passed in the request, then information on the default counterparty will be passed in the response

Method response

Response example

{
   "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>

Description of parameters

Response
Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusintegerEmulated status http-code. If successful, code 200 is returned
metadata.generated_atstring

Server response date and time.

Format: YYYY-MM-DD HH:MM:SS

dataobjectMutual settlements periods info
data.YearsYearsList of years for which information about the mutual settlements is available

Years
Response.Years
ParameterTypeDescription
[Year]object

The year for which the information about the settlements is available (name of the object is the number of the year for example "2016")

[Year].monthsarray of integer

List of months within the specified year ([Year]) for which information about the mutual settlements is available

Error handling

Except for common API errors the method response may contain the following errors:

Error numberhttp-codeError title
TitleTranslation

704001

403Доступ к контрагентам отсутствуетNo access to the counterparties