НЕБО Паблик

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

{{>toc}}

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

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

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

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

<pre>
<code class="json">
{
"id": 1234,
"num": "325",
"date": "18.04.2014",
"contragent": {"id": {id: 1234},
"contract": "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": {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@ @/buh/nomenclature/list@
*params*: Стандартные параметры операции [[API#Операция-LIST|LIST]]
*return* список моделей



*name*: Чтение одного объекта данных %ИМЯ РЕСУРСА%
*desc*: Возвращает счет на оплату объект %ИМЯ РЕСУРСА% по указанному первичному ключу
*url*: @/buh/invoice-for-payment-doc/read@ @/buh/nomenclature/read@
*params*: без параметров для получения нового (пустого) объекта; @id@ - для существующего объекта

*name*: Создание %ИМЯ РЕСУРСА%
*desc*: Создает новый счет на оплату объект %ИМЯ РЕСУРСА% в рабочей организации
*url*: @/buh/invoice-for-payment-doc/create@ @/buh/nomenclature/create@
*params*: модель счета на оплату %ИМЯ РЕСУРСА% без указанного @id@

*name*: Изменение %ИМЯ РЕСУРСА%
*desc*: Изменяет данные счета на оплату в рабочей организации %ИМЯ РЕСУРСА%
*url*: @/buh/invoice-for-payment-doc/update@ @/buh/nomenclature/update@
*params*: модель счета на оплату %ИМЯ РЕСУРСА% с указанным @id@

*name*: Удаление
%ИМЯ РЕСУРСА%
*desc*: Удаляет счет на оплату позицию %ИМЯ РЕСУРСА% с указанным id (см. [[API#Операция-DELETE|DELETE]])
*url*: @/buh/invoice-for-payment-doc/delete@ @/buh/nomenclature/delete@
*params*: модель счета на оплату, %ИМЯ РЕСУРСА%, либо объект <code class="json">{"id": 123 }</code>.