Проект

Общее

Профиль

API - Счета на оплату » История » Версия 1

Александр Кварацхелия, 18.04.2014 16:49

1 1 Александр Кварацхелия
h1. API - Счета на оплату
2
3
{{>toc}}
4
5
h2. Ресурс: Счет на оплату
6
7
Доступ через основной интерфейс Неба: "Продажи" > "Счета на оплату".
8
9
Все операции в рамках работы со счетами на оплату требуют [[API#Аутентификация-внешнего-приложения|аутентификации]] и [[API#Рабочая-организация|установки рабочей организации]].
10
11
h3. Модель счета на оплату
12
13
<pre>
14
<code class="json">
15
{
16
    "id": 1234,
17
    "num": "325",
18
    "date": "18.04.2014",
19
    "contragent": {id: 1234},
20
    "contract: null,
21
    "sclad": null,
22
23
    "account_for_transfer": {"id": 1234},
24
25
    "nds_included": true,
26
    "rows": [],
27
    "summa": 10000.00,
28
    "comment": "Комментарий"
29
}
30
</code>
31
</pre>
32
33
* @id@ - идентификатор счета на оплату
34
* @num@ - номер счета (макс. 50 символов, необязательно). Если номер счета не указан, система попытается сгенерировать номер сама
35
* @date@ - дата выставления счета в формате "dd.mm.yyyy" (обязательно)
36
* @contragent@ - ссылка на контрагента (минимально <code class="json">{"id": 1234}</code> или <code class="json">null</code>)
37
* @contract@ - ссылка на договор с контрагентом (минимально <code class="json">{"id": 1234}</code> или <code class="json">null</code>)
38
* @sclad@ - [[|Склад]], с которого будет выполняться отгрузка товара (минимально <code class="json">{"id": 1234}</code> или <code class="json">null</code>)
39
* @account_for_transfer@ - [[|Банковский счет организации]], на который должна поступить оплата (минимально <code class="json">{"id": 1234}</code> или <code class="json">null</code>)
40
* @nds_included@ - true/false в зависимости, включен ли НДС в цену или нет (по умолчанию, true)
41
* @summa@ - общая сумма по документу
42
* @comment@ - комментарий к счету (необязательно)
43
44
h3. Модель строки счета на оплату
45
46
<pre>
47
<code class="json">
48
{
49
    "nomenclature": {id: 1234},
50
    "name_ex": "",
51
    "count": 1,
52
    "price": 3000.00,
53
    "NDS_rate": {"id": 1},
54
    "NDS_sum": 457.63,
55
    "summa": 3000.00
56
}
57
</code>
58
</pre>
59
60
61
62
h3. Операции
63
64
*name*: Получение списка номенклатуры
65
*desc*: Возвращает список объектов из справочника номенклатуры рабочей организации
66
*url*: @/buh/nomenclature/list@
67
*params*: Стандартные параметры операции [[API#Операция-LIST|LIST]]
68
*return* список моделей 
69
 
70
*name*: Чтение данных %ИМЯ РЕСУРСА%
71
*desc*: Возвращает объект %ИМЯ РЕСУРСА% по указанному первичному ключу
72
*url*: @/buh/nomenclature/read@
73
*params*: без параметров для получения нового (пустого) объекта; @id@ - для существующего объекта
74
75
*name*: Создание %ИМЯ РЕСУРСА%
76
*desc*: Создает новый объект %ИМЯ РЕСУРСА% в рабочей организации
77
*url*: @/buh/nomenclature/create@
78
*params*: модель %ИМЯ РЕСУРСА% без указанного @id@
79
80
*name*: Изменение %ИМЯ РЕСУРСА%
81
*desc*: Изменяет данные %ИМЯ РЕСУРСА%
82
*url*: @/buh/nomenclature/update@
83
*params*: модель %ИМЯ РЕСУРСА% с указанным @id@
84
85
*name*: Удаление %ИМЯ РЕСУРСА%
86
*desc*: Удаляет позицию %ИМЯ РЕСУРСА% с указанным id (см. [[API#Операция-DELETE|DELETE]])
87
*url*: @/buh/nomenclature/delete@
88
*params*: модель %ИМЯ РЕСУРСА%, либо объект <code class="json">{"id": 123 }</code>.