API - Денежные средства » История » Версия 10
Динар Халиуллин, 06.11.2014 16:28
1 | 1 | Александр Кварацхелия | h1. API - Денежные средства |
---|---|---|---|
2 | |||
3 | 2 | Александр Кварацхелия | {{toc}} |
4 | |||
5 | 1 | Александр Кварацхелия | h2. Ресурс: Денежные документы |
6 | |||
7 | 10 | Динар Халиуллин | Доступ через основной интерфейс Неба: |
8 | "Денежные средства" > "Деньги" |
||
9 | |||
10 | h3. Получение списка контрагентов (LIST) |
||
11 | |||
12 | Описание возвращаемого объекта JSON поля data: |
||
13 | |||
14 | <pre> |
||
15 | { |
||
16 | "comment": "", |
||
17 | "kassa_id": null, |
||
18 | "direction": { |
||
19 | "name": "\u041f\u0440\u0438\u0445\u043e\u0434", |
||
20 | "id": 2 |
||
21 | }, |
||
22 | "kassa_or_schet_name": "40702810526260009200 \u0432 andhdb", |
||
23 | "summa": 1230.00, |
||
24 | "section": "\u0411\u0410\u041d\u041a", |
||
25 | "contragent": { |
||
26 | "type": { |
||
27 | "name": "", |
||
28 | "id": 1 |
||
29 | }, |
||
30 | "name": "\u041e\u041e\u041e \"\u041d\u043e\u0432\u044b\u0439 \u043a\u043e\u043d\u0442\u0440\u0430\u0433\u0435\u043d\u0442\"", |
||
31 | "id": 10352 |
||
32 | }, |
||
33 | "section_id": 1, |
||
34 | "contract": { |
||
35 | "name": "\u041e\u0441\u043d\u043e\u0432\u043d\u043e\u0439 \u0434\u043e\u0433\u043e\u0432\u043e\u0440", |
||
36 | "id": 7781 |
||
37 | }, |
||
38 | "bank_account_id": 46, |
||
39 | "num": "2", |
||
40 | "outgo": "", |
||
41 | "income": 1230.00, |
||
42 | "date": "18.09.2014", |
||
43 | "operation": { |
||
44 | "id": 622, |
||
45 | "key": "\u0411\u0430\u043d\u043a\u041e\u043f\u043b\u0430\u0442\u0430\u041e\u0442\u041f\u043e\u043a\u0443\u043f\u0430\u0442\u0435\u043b\u044f", |
||
46 | "name": "\u041e\u043f\u043b\u0430\u0442\u0430 \u043e\u0442 \u043f\u043e\u043a\u0443\u043f\u0430\u0442\u0435\u043b\u044f" |
||
47 | }, |
||
48 | "id": "21088-1", |
||
49 | "cash_flow": null |
||
50 | } |
||
51 | </pre> |
||
52 | |||
53 | *name:* Получение списка денежных документов |
||
54 | *desc:* Возвращает список денежных документов |
||
55 | *url:* https://nebopro.ru/buh/money-documents/list |
||
56 | *Параметры:* Стандартные параметры операции LIST |
||
57 | |||
58 | h3. Чтение данных контрагента (READ) |
||
59 | |||
60 | Возвращает объект модели контрагента по указанному первичному ключу |
||
61 | *url:* https://nebopro.ru/buh/money-documents/read?id=21088 |
||
62 | |||
63 | Параметры для чтения существующего объекта: |
||
64 | * @id@ - идентификатор документа |
||
65 | |||
66 | |||
67 | |||
68 | |||
69 | |||
70 | |||
71 | |||
72 | 3 | Динар Халиуллин | h2. Ресурс: Платежные поручения |
73 | |||
74 | Все операции в рамках ресурса "Платежные поручения" требуют аутентификации и установки рабочей организации. |
||
75 | |||
76 | Доступ через основной интерфейс Неба: |
||
77 | "Денежные средства" > "Платежные поручения" |
||
78 | |||
79 | Пример возвращаемого поля data: |
||
80 | 4 | Динар Халиуллин | |
81 | 3 | Динар Халиуллин | <pre> |
82 | { |
||
83 | "payment_purpose": "Перечисление средств контрагенту", |
||
84 | "num": "10", |
||
85 | 4 | Динар Халиуллин | "summa": 2000000.00, |
86 | 3 | Динар Халиуллин | "operation": { |
87 | "id": 518715, |
||
88 | "name": "Оплата поставщику с расчетного счета" |
||
89 | }, |
||
90 | 4 | Динар Халиуллин | "date": "30.10.2014", |
91 | 3 | Динар Халиуллин | "company": { |
92 | "id": 8036, |
||
93 | "name": "Вымышленная компания" |
||
94 | 4 | Динар Халиуллин | }, |
95 | 3 | Динар Халиуллин | "contragent": { |
96 | "id": 18572, |
||
97 | "name": "Вымышленный контрагент" |
||
98 | }, |
||
99 | 4 | Динар Халиуллин | "id": 3133, |
100 | 3 | Динар Халиуллин | "contract": { |
101 | 4 | Динар Халиуллин | "id": 17589, |
102 | 3 | Динар Халиуллин | "name": "Основной договор" |
103 | } |
||
104 | } |
||
105 | </pre> |
||
106 | |||
107 | h3. Получение списка контрагентов (LIST) |
||
108 | |||
109 | *name*: Получение списка платежных поручений |
||
110 | *desc*: Возвращает список платежных поручений, сформированный пользователем |
||
111 | 5 | Динар Халиуллин | *url*: https://nebopro.ru/buh/bank-payment-order/list |
112 | 6 | Динар Халиуллин | *Параметры*: Стандартные параметры операции LIST |
113 | 5 | Динар Халиуллин | |
114 | h3. Получение списка контрагентов (READ) |
||
115 | 3 | Динар Халиуллин | |
116 | *name*: Просмотр существующего платежного поручения |
||
117 | 1 | Александр Кварацхелия | *desc*: Возвращает содержимое платежного поручения с конкретным id |
118 | 10 | Динар Халиуллин | *url*: https://nebopro.ru/buh/bank-payment-order/read?id=3133 |
119 | 3 | Динар Халиуллин | |
120 | Параметры для чтения существующего объекта: |
||
121 | * @id@ - идентификатор документа |
||
122 | 7 | Динар Халиуллин | |
123 | 1 | Александр Кварацхелия | |
124 | h3. Создание платежного поручения (CREATE) |
||
125 | 7 | Динар Халиуллин | |
126 | 10 | Динар Халиуллин | *url:* /buh/bank-payment-order/create |
127 | *Параметры:* объект модели платежное поручение без поля id; |
||
128 | 7 | Динар Халиуллин | |
129 | Модель платежного поручения: |
||
130 | |||
131 | <pre> |
||
132 | |||
133 | { |
||
134 | "payment_purpose": "Назначение платежа", |
||
135 | "num": "1", |
||
136 | "summa": 100500, |
||
137 | "operation": { |
||
138 | "id": 193, |
||
139 | "name": "Оплата поставщику с расчетного счета" |
||
140 | }, |
||
141 | "date": "23.10.2014", |
||
142 | "company": { |
||
143 | "id": 3, |
||
144 | "name": "ООО \"Новые горизонты\"" |
||
145 | }, |
||
146 | "contragent": { |
||
147 | "id": 2, |
||
148 | "name": "ООО Поставщик" |
||
149 | }, |
||
150 | "id": 2, |
||
151 | "contract": { |
||
152 | "id": 2, |
||
153 | "name": "Основной договор с ООО Поставщик №1 от 01.01.2014" |
||
154 | } |
||
155 | } |
||
156 | |||
157 | </pre> |
||
158 | |||
159 | Возвращает ответ вида: |
||
160 | |||
161 | <pre> |
||
162 | { |
||
163 | 1 | Александр Кварацхелия | "data": { |
164 | 9 | Динар Халиуллин | "id": 3 |
165 | }, |
||
166 | "success": true |
||
167 | 7 | Динар Халиуллин | } |
168 | </pre> |
||
169 | |||
170 | h3. Изменение платежного поручения (UPDATE) |
||
171 | |||
172 | *url:* /buh/bank-payment-order/update |
||
173 | *параметры:* объект модели платежного поручения с обязательным полем id; |
||
174 | |||
175 | Возвращает ответ вида: |
||
176 | |||
177 | <pre> |
||
178 | { |
||
179 | "success": true |
||
180 | } |
||
181 | </pre> |
||
182 | |||
183 | h3. Изменение платежного поручения (DELETE) |
||
184 | |||
185 | *url:* /buh/bank-payment-order/delete |
||
186 | *параметры:* объект модели платежного поручения с обязательным полем id; |
||
187 | |||
188 | Возвращает ответ вида: |
||
189 | |||
190 | <pre> |
||
191 | { |
||
192 | "success": true |
||
193 | } |
||
194 | </pre> |