НЕБО Паблик

h1. API - Денежные средства

{{toc}}

h2. Ресурс: Денежные документы

Доступ через основной интерфейс Неба: 

"Денежные средства" > "Деньги"

h3. Получение списка денежных документов (LIST)

Описание возвращаемого объекта JSON поля data:

<pre>

{

    "comment": "",

    "kassa_id": null,

    "direction": {

        "name": "\u041f\u0440\u0438\u0445\u043e\u0434",

        "id": 2

    },

    "kassa_or_schet_name": "40702810526260009200 \u0432 andhdb",

    "summa": 1230.00,

    "section": "\u0411\u0410\u041d\u041a",

    "contragent": {

        "type": {

            "name": "",

            "id": 1

        },

        "name": "\u041e\u041e\u041e \"\u041d\u043e\u0432\u044b\u0439 \u043a\u043e\u043d\u0442\u0440\u0430\u0433\u0435\u043d\u0442\"",

        "id": 10352

    },

    "section_id": 1,

    "contract": {

        "name": "\u041e\u0441\u043d\u043e\u0432\u043d\u043e\u0439 \u0434\u043e\u0433\u043e\u0432\u043e\u0440",

        "id": 7781

    },

    "bank_account_id": 46,

    "num": "2",

    "outgo": "",

    "income": 1230.00,

    "date": "18.09.2014",

    "operation": {

        "id": 622,

        "key": "\u0411\u0430\u043d\u043a\u041e\u043f\u043b\u0430\u0442\u0430\u041e\u0442\u041f\u043e\u043a\u0443\u043f\u0430\u0442\u0435\u043b\u044f",

        "name": "\u041e\u043f\u043b\u0430\u0442\u0430 \u043e\u0442 \u043f\u043e\u043a\u0443\u043f\u0430\u0442\u0435\u043b\u044f"

    },

    "id": "21088-1",

    "cash_flow": null

}

</pre>

*name:* Получение списка денежных документов

*desc:* Возвращает список денежных документов

*url:* https://nebopro.ru/buh/money-documents/list

*Параметры:* Стандартные параметры операции LIST

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

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

*url:* https://nebopro.ru/buh/money-documents/read?id=21088

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

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

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

URL: https://nebopro.ru/buh/money-documents/create

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

h3. Обновление денежного документ (UPDATE)

URL: https://nebopro.ru/buh/money-documents/update

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

Модель:

<pre>

{

"id": 21088

"section": "bank"

}

</pre>

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

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

* @section@ - тип документа (bank, kassa или other)

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

<pre>

{

    "success": true

}

</pre>

h3. Удаление денежного документа (DELETE)

URL: https://nebopro.ru/buh/money-documents/delete

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

Модель:

<pre>

{

"id": 2898

"section": "kassa"

}

</pre>

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

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

* @section@ - тип документа (bank, kassa или other)

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

<pre>

{

    "success" true

}

</pre>

h2. Ресурс: Платежные поручения

Все операции в рамках ресурса "Платежные поручения" требуют аутентификации и установки рабочей организации.

Доступ через основной интерфейс Неба: 

"Денежные средства" > "Платежные поручения"

Пример возвращаемого поля data:

<pre>

{

    "payment_purpose": "Перечисление средств контрагенту",

    "num": "10",

    "summa": 2000000.00,

    "operation": {

        "id": 518715,

        "name": "Оплата поставщику с расчетного счета"

    },

    "date": "30.10.2014",

    "company": {

        "id": 8036,

        "name": "Вымышленная компания"

    },

    "contragent": {

        "id": 18572,

        "name": "Вымышленный контрагент"

    },

    "id": 3133,

    "contract": {

        "id": 17589,

        "name": "Основной договор"

    }

}

</pre>

h3. Получение списка платежных поручений (LIST)

*name*: Получение списка платежных поручений

*desc*: Возвращает список платежных поручений, сформированный пользователем

*url*: https://nebopro.ru/buh/bank-payment-order/list

*Параметры*: Стандартные параметры операции LIST

h3. Чтение данных платежного поручения (READ)

*name*: Просмотр существующего платежного поручения

*desc*: Возвращает содержимое платежного поручения с конкретным id

*url*: https://nebopro.ru/buh/bank-payment-order/read?id=3133

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

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

h3. Создание платежного поручения (CREATE)

*url:* /buh/bank-payment-order/create 

*Параметры:* объект модели платежное поручение без поля id;

Модель платежного поручения:

<pre>

{

    "payment_purpose": "Назначение платежа",

    "num": "1",

    "summa": 100500,

    "operation": {

        "id": 193,

        "name": "Оплата поставщику с расчетного счета" 

    },

    "date": "23.10.2014",

    "company": {

        "id": 3,

        "name": "ООО \"Новые горизонты\"" 

    },

    "contragent": {

        "id": 2,

        "name": "ООО Поставщик" 

    },

    "id": 2,

    "contract": {

        "id": 2,

        "name": "Основной договор с ООО Поставщик №1 от 01.01.2014" 

    }

}

</pre>

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

<pre>

{

    "data": {

        "id": 3

    },

    "success": true

}

</pre>

h3. Изменение платежного поручения (UPDATE)

*url:* /buh/bank-payment-order/update

*параметры:* объект модели платежного поручения с обязательным полем id;

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

<pre>

{

  "success": true

}

</pre>

h3. Изменение платежного поручения (DELETE)

*url:* /buh/bank-payment-order/delete

*параметры:* объект модели платежного поручения с обязательным полем id;

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

<pre>

{

  "success": true

}

</pre>