Проект

Общее

Профиль

API - Денежные средства » История » Версия 7

Динар Халиуллин, 06.11.2014 15:48

1 1 Александр Кварацхелия
h1. API - Денежные средства
2
3 2 Александр Кварацхелия
{{toc}}
4
5 1 Александр Кварацхелия
h2. Ресурс: Денежные документы
6
7
h2. Ресурс: Платежные поручения
8
9 3 Динар Халиуллин
Все операции в рамках ресурса "Платежные поручения" требуют аутентификации и установки рабочей организации.
10
11
Доступ через основной интерфейс Неба: 
12
"Денежные средства" > "Платежные поручения"
13
14
Пример возвращаемого поля data:
15
16
<pre>
17
{
18 4 Динар Халиуллин
    "payment_purpose": "Перечисление средств контрагенту",
19 3 Динар Халиуллин
    "num": "10",
20
    "summa": 2000000.00,
21
    "operation": {
22
        "id": 518715,
23 4 Динар Халиуллин
        "name": "Оплата поставщику с расчетного счета"
24 3 Динар Халиуллин
    },
25
    "date": "30.10.2014",
26
    "company": {
27
        "id": 8036,
28 4 Динар Халиуллин
        "name": "Вымышленная компания"
29 3 Динар Халиуллин
    },
30
    "contragent": {
31
        "id": 18572,
32 4 Динар Халиуллин
        "name": "Вымышленный контрагент"
33 3 Динар Халиуллин
    },
34
    "id": 3133,
35
    "contract": {
36
        "id": 17589,
37 4 Динар Халиуллин
        "name": "Основной договор"
38 3 Динар Халиуллин
    }
39 4 Динар Халиуллин
}
40 3 Динар Халиуллин
</pre>
41
42
h3. Получение списка контрагентов (LIST)
43
44
*name*: Получение списка платежных поручений
45
*desc*: Возвращает список платежных поручений, сформированный пользователем
46
*url*: https://nebopro.ru/buh/bank-payment-order/list
47
*Параметры*: Стандартные параметры операции LIST
48
49 5 Динар Халиуллин
h3. Получение списка контрагентов (READ)
50 6 Динар Халиуллин
51 5 Динар Халиуллин
*name*: Просмотр существующего платежного поручения
52
*desc*: Возвращает содержимое платежного поручения с конкретным id
53 3 Динар Халиуллин
https://nebopro.ru/buh/bank-payment-order/read?id=3133
54
55
Параметры для чтения существующего объекта:
56
* @id@ - идентификатор документа
57
58
59 7 Динар Халиуллин
h3. Создание платежного поручения (CREATE)
60
61
url: /buh/bank-payment-order/create 
62
Параметры: объект модели платежное поручение без поля id;
63
64
Модель платежного поручения:
65
66
<pre>
67
68
{
69
    "payment_purpose": "Назначение платежа",
70
    "num": "1",
71
    "summa": 100500,
72
    "operation": {
73
        "id": 193,
74
        "name": "Оплата поставщику с расчетного счета" 
75
    },
76
    "date": "23.10.2014",
77
    "company": {
78
        "id": 3,
79
        "name": "ООО \"Новые горизонты\"" 
80
    },
81
    "contragent": {
82
        "id": 2,
83
        "name": "ООО Поставщик" 
84
    },
85
    "id": 2,
86
    "contract": {
87
        "id": 2,
88
        "name": "Основной договор с ООО Поставщик №1 от 01.01.2014" 
89
    }
90
}
91
92
</pre>
93
94
Возвращает ответ вида:
95
96
<pre>
97
{
98
    "success" true,
99
    "data": {
100
        "id": 4
101
    }
102
}
103
</pre>
104
105
h3. Изменение платежного поручения (UPDATE)
106
107
*url:* /buh/bank-payment-order/update
108
*параметры:* объект модели платежного поручения с обязательным полем id;
109
110
Возвращает ответ вида:
111
112
<pre>
113
{
114
  "success": true
115
}
116
</pre>
117
118
h3. Изменение платежного поручения (DELETE)
119
120
*url:* /buh/bank-payment-order/delete
121
*параметры:* объект модели платежного поручения с обязательным полем id;
122
123
Возвращает ответ вида:
124
125
<pre>
126
{
127
  "success": true
128
}
129
</pre>
130
131 1 Александр Кварацхелия
h2. Ресурс: Банковская выписка