API - Контрагенты » История » Версия 1
Александр Кварацхелия, 17.04.2014 16:16
| 1 | 1 | Александр Кварацхелия | h1. API - Контрагенты |
|---|---|---|---|
| 2 | |||
| 3 | {{toc}} |
||
| 4 | |||
| 5 | h2. Ресурс: Контрагенты |
||
| 6 | |||
| 7 | Все операции в рамках ресурса "Контрагенты" требуют [[API#Аутентификация-внешнего-приложения|аутентификации]] и [[API#Рабочая-организация|установки рабочей организации]] |
||
| 8 | |||
| 9 | h3. Модель контрагента |
||
| 10 | |||
| 11 | <pre> |
||
| 12 | <code class="json"> |
||
| 13 | { |
||
| 14 | "id": 1234, |
||
| 15 | "contragent_type": 1, |
||
| 16 | |||
| 17 | "fullname": "ООО Небо", |
||
| 18 | "shortname": "ООО Небо", |
||
| 19 | |||
| 20 | "inn": "1655233505", |
||
| 21 | "kpp": "165501001", |
||
| 22 | "okved": null, |
||
| 23 | "okpo": null, |
||
| 24 | "ogrn": "1111690091017", |
||
| 25 | "okato": null, |
||
| 26 | |||
| 27 | "manager_job_title": "Директор", |
||
| 28 | "manager_fio": "Иванов Иван Иванович", |
||
| 29 | "phone": "8 800 200 54 04", |
||
| 30 | "email": "help@nebopro.ru", |
||
| 31 | |||
| 32 | "uaddress": { |
||
| 33 | "building": { |
||
| 34 | "name": "9", |
||
| 35 | "code": "" |
||
| 36 | }, |
||
| 37 | "flat": "5", |
||
| 38 | "full": "420059, Респ Татарстан, г Казань, ул Ботаническая, 9, 5", |
||
| 39 | "street": { |
||
| 40 | "readOnly": false, |
||
| 41 | "allow_edit": true, |
||
| 42 | "index": "420059", |
||
| 43 | "code": "16000001000017400", |
||
| 44 | "okato": "92401380000", |
||
| 45 | "name_formal": "Ботаническая ул", |
||
| 46 | "name": "ул Ботаническая" |
||
| 47 | }, |
||
| 48 | "zip": "420059", |
||
| 49 | "geo": { |
||
| 50 | "readOnly": false, |
||
| 51 | "allow_edit": true, |
||
| 52 | "index": "420000", |
||
| 53 | "code": "1600000100000", |
||
| 54 | "name": "г Казань / Респ Татарстан", |
||
| 55 | "all_elements_name": { |
||
| 56 | "city": "г Казань", |
||
| 57 | "city_formal": "Казань г", |
||
| 58 | "place_formal": "", |
||
| 59 | "region": "", |
||
| 60 | "region_formal": "", |
||
| 61 | "subject_formal": "Татарстан Респ", |
||
| 62 | "place": "", |
||
| 63 | "subject": "Респ Татарстан" |
||
| 64 | }, |
||
| 65 | "okato": "92401000000", |
||
| 66 | "has_street": true |
||
| 67 | }, |
||
| 68 | "formal": ",420059,Татарстан Респ,,Казань г,,Ботаническая ул,9,,5" |
||
| 69 | }, |
||
| 70 | "faddress": { |
||
| 71 | "building": { |
||
| 72 | "name": "9", |
||
| 73 | "code": "" |
||
| 74 | }, |
||
| 75 | "flat": "5", |
||
| 76 | "full": "420059, Респ Татарстан, г Казань, ул Ботаническая, 9, 5", |
||
| 77 | "street": { |
||
| 78 | "readOnly": false, |
||
| 79 | "allow_edit": true, |
||
| 80 | "index": "420059", |
||
| 81 | "code": "16000001000017400", |
||
| 82 | "okato": "92401380000", |
||
| 83 | "name_formal": "Ботаническая ул", |
||
| 84 | "name": "ул Ботаническая" |
||
| 85 | }, |
||
| 86 | "zip": "420059", |
||
| 87 | "geo": { |
||
| 88 | "readOnly": false, |
||
| 89 | "allow_edit": true, |
||
| 90 | "index": "420000", |
||
| 91 | "code": "1600000100000", |
||
| 92 | "name": "г Казань / Респ Татарстан", |
||
| 93 | "all_elements_name": { |
||
| 94 | "city": "г Казань", |
||
| 95 | "city_formal": "Казань г", |
||
| 96 | "place_formal": "", |
||
| 97 | "region": "", |
||
| 98 | "region_formal": "", |
||
| 99 | "subject_formal": "Татарстан Респ", |
||
| 100 | "place": "", |
||
| 101 | "subject": "Респ Татарстан" |
||
| 102 | }, |
||
| 103 | "okato": "92401000000", |
||
| 104 | "has_street": true |
||
| 105 | }, |
||
| 106 | "formal": ",420059,Татарстан Респ,,Казань г,,Ботаническая ул,9,,5" |
||
| 107 | }, |
||
| 108 | |||
| 109 | "filial": null, |
||
| 110 | |||
| 111 | |||
| 112 | "bank_accounts": [{ |
||
| 113 | "readOnly": false, |
||
| 114 | "allow_edit": true, |
||
| 115 | "recipient": "ООО Небо", |
||
| 116 | "bank_bik": "044525593", |
||
| 117 | "kschet": "30101810200000000593", |
||
| 118 | "bank_name": "ОАО \"АЛЬФА-БАНК\"", |
||
| 119 | "schet": "40702810702920000360", |
||
| 120 | "schet_name": "407...0360 в ОАО \"АЛЬФА-БАНК\"", |
||
| 121 | "bank_city": "г. МОСКВА", |
||
| 122 | "bank_address": "УЛ.КАЛАНЧЕВСКАЯ,27", |
||
| 123 | "bank_phone": "(495)9742515,7555830", |
||
| 124 | "is_master": true |
||
| 125 | }], |
||
| 126 | |||
| 127 | "network_status": { |
||
| 128 | "status": 1, |
||
| 129 | "friend_uid": null |
||
| 130 | } |
||
| 131 | } |
||
| 132 | </code> |
||
| 133 | </pre> |
||
| 134 | |||
| 135 | * @id@ - идентификатор модели контрагента |
||
| 136 | * @contragent_type@ - тип контрагента (обязательно). Значение перечисления: |
||
| 137 | ** 1 - Юридическое лицо (ООО, ЗАО, ОАО и т.п.); |
||
| 138 | ** 2 - Физическое лицо (типа, сотрудника организации или материально-отвественного лица); |
||
| 139 | ** 3 - Индивидуальный предприниматель. |
||
| 140 | |||
| 141 | * @shortname@, @fullname@ - краткое и полное наименование контрагента (макс. 200 и 500 символов, соответственно). Обязательно. |
||
| 142 | * @inn@ - ИНН контрагента (макс 12 символов) |
||
| 143 | * @kpp@ - КПП контрагента (макс 10 симовлов) |
||
| 144 | * @okved@ - ОКВЭД (макс 6 символов) |
||
| 145 | * @okpo@ - ОКПО (макс 10 символов) |
||
| 146 | * @ogrn@ - ОГРН (макс 15 симвоов) |
||
| 147 | * @okato@ - ОКАТО (макс 11 символов) |
||
| 148 | |||
| 149 | * @manager_job_title@ - наименование должности руководителя, |
||
| 150 | * @manager_fio@ - ФИО директора |
||
| 151 | * @phone@ - телефон |
||
| 152 | * @email@ - адрес электронной почты |
||
| 153 | |||
| 154 | * @uaddress@ и @faddress@ - юридический и физический адреса контрагента ([[API - КЛАДР|объекты КЛАДР]]) |
||
| 155 | |||
| 156 | |||
| 157 | h3. Получение списка контрагентов |
||
| 158 | |||
| 159 | *URL*: /api/contragents/list |
||
| 160 | *Параметры*: [[API#Операция-LIST|Стандартные параметры]] операции @LIST@ |