НЕБО Паблик

h1. API - Контрагенты

{{toc}}

h2. Ресурс: Контрагенты

Все операции в рамках ресурса "Контрагенты" требуют [[API#Аутентификация-внешнего-приложения|аутентификации]] и [[API#Рабочая-организация|установки рабочей организации]]

h3. Модель контрагента

<pre>

<code class="json">

{

    "id": 1234,

    "contragent_type": 1,

    "fullname": "ООО Небо",

    "shortname": "ООО Небо",    

    "inn": "1655233505",

    "kpp": "165501001",

    "okved": null,

    "okpo": null,

    "ogrn": "1111690091017",

    "okato": null,

    "manager_job_title": "Директор",

    "manager_fio": "Иванов Иван Иванович",

    "phone": "8 800 200 54 04",

    "email": "help@nebopro.ru",

    "uaddress": {

        "building": {

            "name": "9",

            "code": ""

        },

        "flat": "5",

        "full": "420059, Респ Татарстан, г Казань, ул Ботаническая, 9, 5",

        "street": {

            "readOnly": false,

            "allow_edit": true,

            "index": "420059",

            "code": "16000001000017400",

            "okato": "92401380000",

            "name_formal": "Ботаническая ул",

            "name": "ул Ботаническая"

        },

        "zip": "420059",

        "geo": {

            "readOnly": false,

            "allow_edit": true,

            "index": "420000",

            "code": "1600000100000",

            "name": "г Казань / Респ Татарстан",

            "all_elements_name": {

                "city": "г Казань",

                "city_formal": "Казань г",

                "place_formal": "",

                "region": "",

                "region_formal": "",

                "subject_formal": "Татарстан Респ",

                "place": "",

                "subject": "Респ Татарстан"

            },

            "okato": "92401000000",

            "has_street": true

        },

        "formal": ",420059,Татарстан Респ,,Казань г,,Ботаническая ул,9,,5"

    },

    "faddress": {

        "building": {

            "name": "9",

            "code": ""

        },

        "flat": "5",

        "full": "420059, Респ Татарстан, г Казань, ул Ботаническая, 9, 5",

        "street": {

            "readOnly": false,

            "allow_edit": true,

            "index": "420059",

            "code": "16000001000017400",

            "okato": "92401380000",

            "name_formal": "Ботаническая ул",

            "name": "ул Ботаническая"

        },

        "zip": "420059",

        "geo": {

            "readOnly": false,

            "allow_edit": true,

            "index": "420000",

            "code": "1600000100000",

            "name": "г Казань / Респ Татарстан",

            "all_elements_name": {

                "city": "г Казань",

                "city_formal": "Казань г",

                "place_formal": "",

                "region": "",

                "region_formal": "",

                "subject_formal": "Татарстан Респ",

                "place": "",

                "subject": "Респ Татарстан"

            },

            "okato": "92401000000",

            "has_street": true

        },

        "formal": ",420059,Татарстан Респ,,Казань г,,Ботаническая ул,9,,5"

    },

    "filial": null,

    "bank_accounts": [{

        "readOnly": false,

        "allow_edit": true,

        "recipient": "ООО Небо",

        "bank_bik": "044525593",

        "kschet": "30101810200000000593",

        "bank_name": "ОАО \"АЛЬФА-БАНК\"",

        "schet": "40702810702920000360",

        "schet_name": "407...0360 в ОАО \"АЛЬФА-БАНК\"",

        "bank_city": "г. МОСКВА",

        "bank_address": "УЛ.КАЛАНЧЕВСКАЯ,27",

        "bank_phone": "(495)9742515,7555830",

        "is_master": true

    }],

    "network_status": {

        "status": 1,

        "friend_uid": null

    }

}

</code>

</pre>

* @id@ - идентификатор модели контрагента

* @contragent_type@ - тип контрагента (обязательно). Значение перечисления:

** 1 - Юридическое лицо (ООО, ЗАО, ОАО и т.п.);

** 2 - Физическое лицо (типа, сотрудника организации или материально-отвественного лица);

** 3 - Индивидуальный предприниматель.

* @shortname@, @fullname@ - краткое и полное наименование контрагента (макс. 200 и 500 символов, соответственно). Обязательно.

* @inn@ - ИНН контрагента (макс 12 символов)

* @kpp@ - КПП контрагента (макс 10 симовлов)

* @okved@ - ОКВЭД (макс 6 символов)

* @okpo@ - ОКПО (макс 10 символов)

* @ogrn@ - ОГРН (макс 15 симвоов)

* @okato@ - ОКАТО (макс 11 символов)

* @manager_job_title@ - наименование должности руководителя,

* @manager_fio@ - ФИО директора

* @phone@ - телефон

* @email@ - адрес электронной почты

* @uaddress@ и @faddress@ - юридический и физический адреса контрагента ([[API - КЛАДР|объекты КЛАДР]])

h3. Получение списка контрагентов (LIST)

Возвращает JSON со списком моделей контрагентов

URL: /core/contragents/list

Параметры: [[API#Операция-LIST|Стандартные параметры]] операции @LIST@

h3. Чтение данных контрагента (READ)

Возвращает объект модели контрагента по указанному первичному ключу

URL: /core/contragents/read

Параметры для чтения нового (пустого) объекта контрагента:

* @contragent_type@ - тип контрагента (см. описание к модели);

Параметры для чтения существующего объекта:

* @contragent_type@ - тип контрагента (см. описание к модели);

* @id@ - идентификатор контрагента

h3. Создание контрагента (CREATE)

URL: /core/contragents/create

Параметры: объект модели контрагента без поля @id@;

Возвращает ответ вида

<pre>

<code class="json">

{

    "success" true,

    "data": {

        "id": 1234

    }

}

</code>

</pre>

где @data.id@ - идентификатор созданной записи

h3. Изменение контрагента (UPDATE)

URL: /core/contragents/update

Параметры: объект модели контрагента с обязательным полем @id@;

Возвращает ответ вида

<pre>

<code class="json">

{

    "success" true

}

</code>

</pre>