Обновление
Частичное обновление документа
POST https://do.freshoffice.ru/document/update
Меняются только переданные поля — всё остальное в документе остаётся как было.
Request Body
| Name | Type | Description |
|---|---|---|
| document* | JSON |
200: OK Стандартный объект ответа
{
"status": "success",
"error": "",
"code": null,
"rows": 0,
"pages": 0,
"page": 0,
"value": "1"
}
JSON
Все доступные параметры
- id - * Код документа
- number - Номер документа (требует одновременно type_id)
- sum - Сумма документа
- date - Дата документа
- note - Примечание (заменяет старое)
- status_id - Код признака/статуса документа
- type_id - Код типа документа
- deal_id - Код сделки
- contact_id - Код контактного лица
- user_id - Код ответственного
- date_expire - Срок действия
- tags - Теги через запятую (заменяют старые)
{
"id": 91234,
"sum": 175000,
"note": "Счет уточнен: добавлена доставка"
}
Примечание
Обязательный параметр — только id (код документа) плюс хотя бы одно обновляемое поле.
При смене номера обязательно передайте и type_id — номер проверяется на уникальность в рамках типа документа. Числовые поля со значением 0 считаются «не переданными» — поэтому сумму нельзя обнулить, а note и tags при передаче полностью заменяют старое значение.
Пример
cURL
NodeJS (Request)
curl --location --request POST 'https://do.freshoffice.ru/document/update' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": 91234,
"sum": 175000
}
'
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://do.freshoffice.ru/document/update',
'headers': {
'Authorization': 'Bearer XXXX-XXXXXXX-XXXXXXX',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"id": 91234,
"sum": 175000
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
Ответ
{
"status": "success",
"error": "",
"code": null,
"rows": 0,
"pages": 0,
"page": 0,
"value": "1"
}
// value: 1 - документ обновлен, 0 - ошибка (текст в поле error)
Предыдущая
Следующая