Список контрагентов

Обновлено 18.01.2022

123 кб

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

Сервис позволяет получить список контрагентов, связанных с учётной записью.

Cписок контрагентов

Одна учетная запись Личного кабинета (далее - ЛК) может быть связана с нескольким контрагентами, то есть посредством одной учётной записи можно от имени разных контрагентов оформлять заказы, получать информацию о взаиморасчетах и т. д.

Этот метод позволяет:

получить основную информацию о контрагентах, связанных с одной учетной записи в ЛК;
получить полную информацию о контрагентах, связанных с одной учетной записи в ЛК;
получить информацию о взаиморасчётах по каждому контрагенту;
сменить текущего контрагента для осуществления разных операций в ЛК.

Список контрагентов и контрагенты из адресной книги - это разные понятия. Метод "Список контрагентов" позволяет получить информацию по юридическим/физическим лицам, связанным с учётной записью, от имени которых может быть оформлен заказ, в то время как в адресно книге хранятся данные контрагентов, не имеющих отношения к текущей учётной записи, эти данные нужны для ускорения процесса оформления заказа.

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

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

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "cauid": "00000000-0000-0000-0000-000000000000",
   "fullInfo": true
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <cauid>00000000-0000-0000-0000-000000000000</cauid>
   <fullInfo>true</fullInfo>
</request>

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

Request

Request
Параметр	Обязательный	Тип	Описание
appkey	Да	string	Ключ приложения. Для получения ключа необходимо пройти регистрацию
sessionID	Да	string	ID сессии для запросов к данным Личного кабинета
cauid	Нет	string	UID контрагента, от имени которого должны создаваться заявки в рамках текущей сессии. Параметр позволяет изменить контрагента, выбранного по умолчанию, на другого контрагента
fullInfo	Нет	boolean	Флаг, обозначающий, что запрошена полная информация по контрагентам, а также информация по взаиморасчётам

Ответ метода

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

JSON
XML

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "counteragents":[
         {
            "balance":{
               "opening":{
                  "date":"2016-04-01 00:00:00",
                  "sum":380
               },
               "closing":{
                  "date":"2016-04-30 23:59:59",
                  "sum":0
               }
            },
            "info":{
               "sharedTo":[
                  {
                     "phone":"+7 (111) 111-11-11",
                     "name":"ФИО",
                     "email":"Pushkino_auto@dellin.ru"
                  },
                  {
                     "phone":"+7 (444) 444-44-44",
                     "name":"ФИО",
                     "email":"Petr.Petrov@dellin.ru"
                  }
               ],
               "accessLevel":2,
               "requestComment":null,
               "managerEmail":"Ivan.Ivanov@dellin.ru",
               "managerPhone":"+7 (911) 232-95-50",
               "sharedFrom":{
                  "phone":"+7 (111) 111-11-11",
                  "name":"ФИО",
                  "email":"ssidorov@dellin.ru"
               },
               "managerName":"Иванов Иван Иванович"
            },
            "isCurrent":true,
            "uid":"00000000-0000-0000-0000-000000000000",
            "juridical":true,
            "inn":"1234567890",
            "document":{
               "type":"passport",
               "serial":"0000",
               "number":"123456"
            },
            "name":"ООО \"Компания\"",
            "cashOnDeliveryAvailable":true
         }
      ]
   }
}

<response>
   </metadata>
   <data>
      <counteragents>
         <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>
         <info>
            <sharedTo>
               <phone>+7 (111) 111-11-11</phone>
               <name>ФИО</name>
               <email>Pushkino_auto@dellin.ru</email>
            </sharedTo>
            <sharedTo>
               <phone>+7 (444) 444-44-44</phone>
               <name>ФИО</name>
               <email>Petr.Petrov@dellin.ru</email>
            </sharedTo>
            <accessLevel>2</accessLevel>
            <requestComment />
            <managerEmail>Ivan.Ivanov@dellin.ru</managerEmail>
            <managerPhone>+7 (911) 232-95-50</managerPhone>
            <sharedFrom>
               <phone>+7 (111) 111-11-11</phone>
               <name>ФИО</name>
               <email>ssidorov@dellin.ru</email>
            </sharedFrom>
            <managerName>Иванов Иван Иванович</managerName>
         </info>
         <isCurrent>true</isCurrent>
         <uid>00000000-0000-0000-0000-000000000000</uid>
         <juridical>true</juridical>
         <inn>1234567890</inn>
         <document>
            <type>passport</type>
            <serial>0000</serial>
            <number>123456</number>
         </document>
         <name>ООО "Компания"</name>
         <cashOnDeliveryAvailable>true</cashOnDeliveryAvailable>
      </counteragents>
   </data>
</response>

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

Response

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

Counteragents

Counteragents
Параметр	Тип	Описание
balance	object	Информация о движении денежных средств контрагента. Если взаиморасчетов не производилось, значение параметра - null. Параметр присутствует в ответе, только если в запросе метода был передан параметр "fullInfo" со значением "true"
balance.opening	Balance	Баланс контрагента на начало периода
balance.closing	Balance	Баланс контрагента на конец периода (или на текущий момент, если период не закрыт)
info	object	Полная информация о контрагентах. Параметр присутствует в ответе, только если в запросе метода был передан параметр "fullInfo" со значением "true"
info.sharedTo	array of Shared	Данные пользователей, которым предоставлен доступ к учетной записи ЛК
info.accessLevel	integer	Уровень предоставленного доступа. Возможные значения: 0 = запрос доступа; 1 = запрос отклонён; 2 = полный доступ; 3 = частичный доступ Для получения полного доступа необходимо подтвердить учетную запись через форму в личном кабинете сайта www.dellin.ru (направить копию паспорта или заявление) или приехать на терминал компании "Деловые Линии"
info.requestComment	string	Комментарий при отклонении доступа
info.managerEmail	string	Электронная почта менеджера клиента
info.managerPhone	string	Контактный телефон менеджера клиента
info.sharedFrom	Shared	Данные пользователя, который предоставил доступ к учетной записи ЛК
info.managerName	string	ФИО менеджера клиента
isCurrent	boolean	Признак выбранного контрагента. Если в запросе был передан параметр "cauid", то в ответе у контрагента, UID которого был передан в запросе, значение параметра "isCurrent" будет равно "true"
uid	string	Уникальный идентификатор контрагента
juridical	boolean	Признак юридического лица Возможные значения: "true" - юридическое лицо; "false" - физическое лиц. Параметр присутствует в ответе, только если в запросе метода был передан параметр "fullInfo" со значением "true"
inn	string	ИНН (для юридических лиц), если контрагент является физическим лицом (значение параметра "juridical" - "false"), то значение параметра - null. Параметр присутствует в ответе, только если в запросе метода был передан параметр "fullInfo" со значением "true"
document	object	Данные документа, удостоверяющего личность (для физических лиц), если контрагент является юридическим лицом (значение параметра "juridical" - "true"), то значение параметра - null. Параметр присутствует в ответе, только если в запросе метода был передан параметр "fullInfo" со значением "true"
document.type	string	Тип документа Возможные значения: "passport" - паспорт; "drivingLicence" - водительское удостоверение; "foreignPassport" - заграничный паспорт
document.serial	string	Серия документа
document.number	string	Номер документа. Формат номера зависит от страны
name	string	Имя/наименование контрагента
cashOnDeliveryAvailable	boolean	Признак возможности оформления контрагентом заказа с наложенным платежом

Balance

Параметр

Тип

Описание

date

string

Дата начала/конца периода.

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

sum

integer

Сумма на начало/конец периода, руб

Shared

Shared
Параметр	Тип	Описание
phone	string	Контактный телефон пользователя
name	string	ФИО пользователя
email	string	Электронная почта пользователя

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

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

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

Список контрагентов

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

Cписок контрагентов

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

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

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

Request

Ответ метода

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

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

Response

Counteragents

Balance

Shared

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