НЕБО Паблик

h1. API - Счета на оплату

{{>toc}}

h2. Ресурс: Счет на оплату

Доступ через основной интерфейс Неба: "Продажи" > "Счета на оплату".

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

h3. Модель счета на оплату

<pre>

<code class="json">

{

    "id": 1234,

    "num": "325",

    "date": "18.04.2014",

    "contragent": {"id": 1234},

    "contract": null,

    "sclad": null,

    "account_for_transfer": {"id": 1234},

    "nds_included": true,

    "rows": [],

    "summa": 10000.00,

    "comment": "Комментарий"

}

</code>

</pre>

* @id@ - идентификатор счета на оплату

* @num@ - номер счета (макс. 50 символов, необязательно). Если номер счета не указан, система попытается сгенерировать номер сама

* @date@ - дата выставления счета в формате "dd.mm.yyyy" (обязательно)

* @contragent@ - ссылка на контрагента (минимально <code class="json">{"id": 1234}</code> или <code class="json">null</code>)

* @contract@ - ссылка на договор с контрагентом (минимально <code class="json">{"id": 1234}</code> или <code class="json">null</code>)

* @sclad@ - [[|Склад]], с которого будет выполняться отгрузка товара (минимально <code class="json">{"id": 1234}</code> или <code class="json">null</code>)

* @account_for_transfer@ - [[|Банковский счет организации]], на который должна поступить оплата (минимально <code class="json">{"id": 1234}</code> или <code class="json">null</code>)

* @nds_included@ - true/false в зависимости, включен ли НДС в цену или нет (по умолчанию, true)

* @summa@ - общая сумма по документу

* @comment@ - комментарий к счету (необязательно)

h3. Модель строки счета на оплату

<pre>

<code class="json">

{

    "nomenclature": {"id": 1234},

    "name_ex": null,

    "count": 1,

    "price": 3000.00,

    "NDS_rate": {"id": 1},

    "NDS_sum": 457.63,

    "summa": 3000.00

}

</code>

</pre>

* @nomenclature@ - обязательная ссылка на объект номенклатуры

* @name_ex@ - расширенное название позиции номенклатуры (только для услуг) или null,

* @count@ - количество 

* @price@ - цена

* @NDS_rate@ - ставка НДС (объект вида <code class="json">{"id": 1234}</code>, обязательно)

* @NDS_sum@ - сумма НДС по строке

* @summa@ - сумма по строке

h3. Операции

*name*: Получение списка

*desc*: Возвращает список счетов на оплату из текущей рабочей организации

*url*: @/buh/invoice-for-payment-doc/list@

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

*return* список моделей

*name*: Чтение одного объекта

*desc*: Возвращает счет на оплату по указанному первичному ключу

*url*: @/buh/invoice-for-payment-doc/read@

*params*: без параметров для получения нового (пустого) объекта; @id@ - для существующего объекта

*name*: Создание

*desc*: Создает новый счет на оплату в рабочей организации

*url*: @/buh/invoice-for-payment-doc/create@

*params*: модель счета на оплату без указанного @id@

*name*: Изменение

*desc*: Изменяет данные счета на оплату в рабочей организации

*url*: @/buh/invoice-for-payment-doc/update@

*params*: модель счета на оплату с указанным @id@

*name*: Удаление 

*desc*: Удаляет счет на оплату с указанным id (см. [[API#Операция-DELETE|DELETE]])

*url*: @/buh/invoice-for-payment-doc/delete@

*params*: модель счета на оплату, либо объект <code class="json">{"id": 123 }</code>.