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

API
Главная / API - Контрагенты

Контрагенты

Обновлено 16.10.2017
149 кб

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

Адресная книга представляет собой список контрагентов с реквизитами, которые могут быть использованы для оформления заказов. 

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

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

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

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

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

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

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <withanonym>true</withanonym>
</request>

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

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии для запросов к данным Личного кабинета на сайте dellin.ru
WithAnonymНетstring

Признак запроса списка контрагентов, включающего анонимных получателей.

Доступные значения:

  • "true" - ответ должен включать анонимных получателей
  • "false" - ответ не должен включать анонимных получателей

Значение по умолчанию: "false"

Ответ метода

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

[  
   {  
      "counteragent": {  
         "id":"1",
         "Is_anonym":"false",
         "form":"ООО",
         "formUID":"0x92EE03691F25A9FE4BE9910CD87CA9CA",
         "name":"Ромашка",
         "type":"juridical",
         "inn":"1234567890",
         "addresses":3,
         "lastUpdate":"2015-07-04 02:27:15",
         "country_uid":"0x8f51001438c4d49511dbd774581edb7a",
         "uid":"00000000-0000-0000-0000-000000000000"
      }
   },
   {  
      "counteragent": {  
         "id":"2",
         "Is_anonym":"false",
         "form":"ООО",
         "formUID":"0x92EE03691F25A9FE4BE9910CD87CA9CA",
         "name":"Мечта",
         "type":"juridical",
         "inn":"1234567891",
         "addresses":1,
         "lastUpdate":"2015-07-04 02:27:15",
         "country_uid":"0x8f51001438c4d49511dbd774581edb7a",
         "uid":"00000000-0000-0000-0000-000000000000"
      }
   },
   {  
      "counteragent": {  
         "id":"3",
         "Is_anonym":"false",
         "form":"Ч/Л",
         "formUID":"0x8F51001438C4D49511DBD774581EDB80",
         "name":"Иванов Иван Иванович",
         "type":"physical",
         "addresses":1,
         "document": {  
            "type":"passport",
            "serial":"0000",
            "number":"000000",
            "date":"2014-01-23"
         },
         "lastUpdate":"2015-07-04 02:27:15",
         "country_uid":"0x8f51001438c4d49511dbd774581edb7a",
         "uid":"00000000-0000-0000-0000-000000000000"
      }
   },
   {  
      "counteragent": {  
         "id":"4",
         "Is_anonym":"true",
         "form":"Ч/Л",
         "formUID":"0xAB91FEEA04F6D4AD48DF42161B6C2E7A",
         "name":"Петрович",
         "Phone":"+7 (900) 000-00-00",
         "Email":"petro@mail.com",
         "type":"physical",
         "addresses":1,
         "lastUpdate":"2015-07-04 02:27:15",
         "country_uid":"0x8f51001438c4d49511dbd774581edb7a",
         "uid":"00000000-0000-0000-0000-000000000000"
      }
   }
]
<response>
   <counteragent>
      <id>1</id>
      <is_anonym>false</is_anonym>
      <form>ООО</form>
      <formuid>0x92EE03691F25A9FE4BE9910CD87CA9CA</formuid>
      <name>Ромашка</name>
      <type>juridical</type>
      <inn>1234567890</inn>
      <addresses>3</addresses>
      <lastupdate>2015-07-04 02:27:15</lastupdate>
      <country_uid>0x8f51001438c4d49511dbd774581edb7a</country_uid>
      <uid>00000000-0000-0000-0000-000000000000</uid>
   </counteragent>
   <counteragent>
      <id>2</id>
      <is_anonym>false</is_anonym>
      <form>ООО</form>
      <formuid>0x92EE03691F25A9FE4BE9910CD87CA9CA</formuid>
      <name>Мечта</name>
      <type>juridical</type>
      <inn>1234567891</inn>
      <addresses>1</addresses>
      <lastupdate>2015-07-04 02:27:15</lastupdate>
      <country_uid>0x8f51001438c4d49511dbd774581edb7a</country_uid>
      <uid>00000000-0000-0000-0000-000000000000</uid>
   </counteragent>
   <counteragent>
      <id>3</id>
      <is_anonym>false</is_anonym>
      <form>Ч/Л</form>
      <formuid>0x8F51001438C4D49511DBD774581EDB80</formuid>
      <name>Иванов Иван Иванович</name>
      <type>physical</type>
      <addresses>1</addresses>
      <document>
         <type>passport</type>
         <serial>0000</serial>
         <number>000000</number>
         <date>2014-01-23</date>
      </document>
      <lastupdate>2015-07-04 02:27:15</lastupdate>
      <country_uid>0x8f51001438c4d49511dbd774581edb7a</country_uid>
      <uid>00000000-0000-0000-0000-000000000000</uid>
   </counteragent>
   <counteragent>
      <id>4</id>
      <is_anonym>true</is_anonym>
      <form>Ч/Л</form>
      <formuid>0xAB91FEEA04F6D4AD48DF42161B6C2E7A</formuid>
      <name>Петрович</name>
      <phone>+7 (900) 000-00-00</phone>
      <email>petro@mail.com</email>
      <type>physical</type>
      <addresses>1</addresses>
      <lastupdate>2015-07-04 02:27:15</lastupdate>
      <country_uid>0x8f51001438c4d49511dbd774581edb7a</country_uid>
      <uid>00000000-0000-0000-0000-000000000000</uid>
   </counteragent>
</response>

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

Response
ПараметрТипОписание
counteragentResponse.CounteragentИнформация о контрагентах из адресной книги

Response.Counteragent
ПараметрТипОписание
idstringID контрагента
Is_anonymstring

Признак анонимного получателя. Возвращается, только если в запросе был передан параметр "WithAnonym" со значением "true".

Возможные варианты:

  • "true" – анонимный получатель
  • "false" – не анонимный получатель
formstringОрганизационно-правовая форма контрагента
formUIDstringUID ОПФ. Заполняется на основании "Справочника ОПФ"
namestringНаименование контрагента (для АП - имя АП)
PhonestringНомер телефона АП. Возвращается, только если контрагент является АП
EmailstringАдрес электронной почты АП. Возвращается, только если контрагент является АП
typestringТип контрагента: юридическое или физическое лицо
innstringИНН контрагента. Параметр присутствует в ответе, если тип контрагента = юридическое лицо
adressesintegerКоличество адресов доставки контрагента
documentobjectИнформация о физическом лице. Параметр присутствует в ответе, если тип контрагента = физическое лицо
document.typestring

Тип документа.

Доступные значения:

  • "passport" - паспорт
  • "drivingLicence" - водительское удостоверение
  • "foreignPassport" - заграничный паспорт
document.serialstringСерия документа
document.numberstringНомер документа
document.datestringДата выдачи документа
lastUpdatestringДата последнего обновления информации о данном контрагенте
country_uidstringUID страны из "Справочника стран"
uidstring

UID контрагента. Присутствует, если данному контрагенту из адресной книги соответствует контрагент из списка, получаемого с помощью метода "Получение списка контрагентов". Если отсутствует - параметр содержит "null".

Создание и редактирование контрагентов

Метод позволяет создавать новых контрагентов и редактировать информацию о них. Запрос метода отличается в зависимости от вида создаваемого контрагента: юридическое или физическое лицо. 

Юридические лица

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

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

Адрес метода: https://api.dellin.ru/v1/customers/book/counteragents/update.json

{
   "appkey": "00000000-0000-0000-000000000000",
   "sessionID": "00000000-0000-0000-0000-000000000000",
   "form": "0x8F51001438C4D49511DBD774581EDB80",
   "customForm": {
      "formName": "ОБРУГ",
      "countryUID": "0x00000000000000000000000000000000",
      "juridical": true
   },
   "name": "Ромашка",
   "inn": "1234567890",
   "juridicalAddress": {
      "street": "7800000000004380000000000",
      "customStreet": {
         "code": "7800000000000000000000000",
         "street": "Восточная"
      },
      "house": "4",
      "building": "2",
      "structure": "3А",
      "flat": "Б-234"
   }
}

Адрес метода: https://api.dellin.ru/v1/customers/book/counteragents/update.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <form>0x8F51001438C4D49511DBD774581EDB80</form>
   <customform>
      <formname>ОБРУГ</formname>
      <countryuid>0x00000000000000000000000000000000</countryuid>
      <juridical>true</juridical>
   </customform>
   <name>Ромашка</name>
   <inn>1234567890</inn>
   <juridicaladdress>
      <street>7800000000004380000000000</street>
      <customStreet>
         <code>7800000000000000000000000</code>
         <street>Восточная</street>
      </customStreet>
      <house>4</house>
      <building>2</building>
      <structure>3А</structure>
      <flat>Б-234</flat>
   </juridicaladdress>
</request>
Описание параметров
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии для запросов к данным Личного кабинета на сайте dellin.ru
formДа*string

UID ОПФ. Заполняется на основании "Справочника ОПФ".

*Только если не указан параметр "customForm". В противном случае параметр должен отсутствовать

customFormДа*object

Данные об ОПФ. Используется, если в "Справочнике ОПФ" нет нужной ОПФ.

*Только если не указан параметр "form". В противном случае параметр должен отсутствовать

customForm.formNameДаstringНаименование ОПФ
customForm.countryUIDДаstringUID страны. Заполняется на основании "Справочника стран"
customForm.juridicalДаboolean

Доступные значения:

  • "true" - юридическое лицо
  • "false" - физическое лицо
nameДаstringНаименование юридического лица
innДаstringИНН юридического лица
juridicalAddressДаRequest.JuridicalAddressДанные о юридическом адресе

Request.JuridicalAddress
ПараметрR*ТипОписание
streetДа*string

Код КЛАДР улицы. Заполняется на основании "Справочника улиц".

*Только если не указан параметр "Request.JuridicalAddress.CustomStreet". В противном случае параметр должен отсутствовать

customStreetДа*object

Данные об улице. Используется, если в "Справочнике улиц" нет нужной улицы.

*Только если не указан параметр "Request.JuridicalAddress.Street". В противном случае параметр должен отсутствовать

customStreet.codeДаstring

Код КЛАДР населенного пункта (см. "Справочник населенных пунктов")

customStreet.streetДаstring

Название улицы

houseДаstringНомер дома
buildingНетstringКорпус дома
structureНетstringСтроение
flatНетstringКвартира/офис

Ответ метода

Пример ответа
{
   "success": {
      "counteragentId": "1"
   }
}
<response>
   <success>
      <counteragentid>1</counteragentid>
   </success>
</response>

Описание параметров 
Response
ПараметрТипОписание
successobjectУспешная операция по добавлению контрагента
success.counteragentIdstringID созданного контрагента в системе

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

Если в запросе отсутствуют обязательные поля или заданы неверные значения параметров, тогда вернется пакет с описанием ошибок. 

Пример ответа
{
   "errors": {
      "form":"не задана правовая форма"
   }
}
<response>
   <errorrs><form>не задана правовая форма</form>
   </errorrs>
</response>

Физические лица

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

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

Адрес метода: https://api.dellin.ru/v1/customers/book/counteragents/update.json 

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "form":"0xAB91FEEA04F6D4AD48DF42161B6C2E7A",
   "name":"Петров А.А."
   "document": {
      "type":"passport", 
      "serial":"XXXX", 
      "number":"XXXX", 
      "date":"YYYY-MM-DD"
   }
}

Адрес метода: https://api.dellin.ru/v1/customers/book/counteragents/update.xml  

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <form>0xAB91FEEA04F6D4AD48DF42161B6C2E7A</form>
   <name>Петров А.А.</name>
   <document>
      <type>passport</type>
      <serial>XXXX</serial>
      <number>XXXX</number>
      <date>YYYY-MM-DD</date>
   </document>
</request>

Описание параметров 
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии для запросов к данным Личного кабинета на сайте dellin.ru
formДаstringUID ОПФ. Заполняется на основании "Справочника ОПФ"
nameДаstringИмя контрагента
documentДаobjectИнформация о документе физического лица
document.typeДаstring

Тип документа.

Доступные значения:

  • "passport" - паспорт
  • "drivingLicence" - водительское удостоверение
  • "foreignPassport" - заграничный паспорт
document.serialДаstringСерия документа

document.number

ДаstringНомер документа
document.dateНетstringДата выдачи документа в формате "ГГГГ-ММ-ДД"

Чтобы добавить в адресную книгу контрагента-АП, необходимо отправить следующий запрос:

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

Адрес метода: https://api.dellin.ru/v1/customers/book/counteragents/update.json 

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "is_anonym":"true",
   "form":"0xAB91FEEA04F6D4AD48DF42161B6C2E7A", 
   "name":"Петрович",
   "Phone":"+7 (900) 000-00-00",
   "Email":"petro@mail.com"
}

Адрес метода: https://api.dellin.ru/v1/customers/book/counteragents/update.xml  

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <is_anonym>true</is_anonym>
   <form>0xAB91FEEA04F6D4AD48DF42161B6C2E7A</form>
   <name>Петрович</name>
   <phone>+7 (900) 000-00-00</phone>
   <email>petro@mail.com</email>
</request>
Описание параметров 
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии для запросов к данным Личного кабинета на сайте dellin.ru
is_anonymНетstring

Признак контрагента-АП.

Доступные значения:

  • "true" – контрагент является АП
  • "false" – контрагент не является АП

Значение по умолчанию: "false"

formДаstringUID ОПФ. Заполняется на основании "Справочника ОПФ". Если "is_anonym" = "true", то значение параметра должно либо отсутствовать, либо быть равным "0xAB91FEEA04F6D4AD48DF42161B6C2E7A" (частное лицо, Россия)
nameДаstringИмя АП
PhoneДаstring

Номер телефона АП

EmailНетstringАдрес электронной почты АП

Ответ метода

Пример ответа
{
   "success": {
      "counteragentId": "1"
   }
}
<response>
   <success>
      <counteragentid>1</counteragentid>
   </success>
</response>
Ответ метода для юридического и для физического лица совпадает. Описание параметров ответа приведено в главе "Юридические лица".

Редактирование данных контрагента

Для изменения данных контрагента, не являющегося АП, необходимо передать в запросе идентификатор этого клиента и те данные, которые нужно изменить. 

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

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

Адрес метода: https://api.dellin.ru/v1/customers/book/counteragents/update.json 

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID": "00000000-0000-0000-0000-000000000000",
   "counteragentID":"1",
   "form":"0x8F51001438C4D49511DBD774581EDB80" 
}

Адрес метода:  https://api.dellin.ru/v1/customers/book/counteragents/update.xml  

<response>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <counteragentid>1</counteragentid>
   <form>0x8F51001438C4D49511DBD774581EDB80</form>
</response>
Описание параметров 
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии для запросов к данным Личного кабинета на сайте dellin.ru
counteragentIdДаstringID контрагента, информацию о котором нужно отредактировать
formДаstringUID новой ОПФ. Заполняется на основании "Справочника ОПФ"

Ответ метода

Пример ответа
{
   "success": {
      "counteragentId": "1"
   }
}
<response>
   <success>
      <counteragentid>1</counteragentid>
   </success>
</response>
Описание параметров 
Response
ПараметрТипОписание
successobjectУспешная операция по добавлению контрагента
success.counteragentIdstringID контрагента, информацию о котором отредактировали. Именно этот ID необходимо использовать в дальнейшем

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

Если в запросе не передан полный набор данных, необходимый для изменения информации о контрагенте, тогда вернется пакет с описанием ошибок. 

Пример ответа
{
   "errors": {
      "document": {
         "type": "не задан тип документа",
         "serial": "не указана серия документа",
         "number": "не указан номер документа",
         "date": "не задана дата выдачи документа"
      }
   }
}
<response>
   <errors>
      <document>
         <type>не задан тип документа</type>
         <serial>не указана серия документа</serial>
         <number>не указан номер документа</number>
         <date>не задана дата выдачи документа</date>
      </document>
   </errors>
</response>
Параметры объекта "document" подробно описаны в главе "Физические лица".
Обратите внимание, что редактирование данных уже созданного контрагента, являющегося АП, невозможно.