Добавление
Добавление документа
POST https://do.freshoffice.ru/document/insert
Создаёт документ (счёт, договор и т.д.) у контрагента. Если номер не передан — автоматически генерируется следующий номер для этого типа документа.
Request Body
| Name | Type | Description |
|---|---|---|
| document* | JSON |
200: OK Стандартный объект ответа
{
"status": "success",
"error": "",
"code": null,
"rows": 0,
"pages": 0,
"page": 0,
"value": "91234"
}
JSON
Все доступные параметры нового объекта
- company_id - * Код контрагента
- type_id - * Код типа документа (см. справочники)
- number - Номер документа. Если не передан — генерируется автоматически
- date - Дата документа, например 2026-08-26. По умолчанию — сегодня
- sum - Сумма документа
- note - Примечание
- status_id - Код признака/статуса документа
- deal_id - Код сделки
- contact_id - Код контактного лица
- user_id - Код ответственного. По умолчанию — владелец токена
- requisites_id - Код реквизитов своей компании
- company_requisites_id - Код реквизитов контрагента
- base_doc_id - Код документа-основания
- date_expire - Срок действия, например 2026-09-26
- tags - Теги через запятую
{
"company_id": 368132,
"type_id": 1,
"sum": 150000,
"date": "2026-08-26",
"note": "Счет за поставку упаковки, август"
}
Примечание
Обязательные параметры
company_id (Код контрагента)
type_id (Код типа документа)
Номер документа проверяется на уникальность в рамках типа — если передать уже существующий номер, вернётся ошибка.
Пример
cURL
NodeJS (Request)
curl --location --request POST 'https://do.freshoffice.ru/document/insert' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
"company_id": 368132,
"type_id": 1,
"sum": 150000,
"note": "Счет за поставку упаковки, август"
}
'
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://do.freshoffice.ru/document/insert',
'headers': {
'Authorization': 'Bearer XXXX-XXXXXXX-XXXXXXX',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"company_id": 368132,
"type_id": 1,
"sum": 150000,
"note": "Счет за поставку упаковки, август"
})
};
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": "91234"
}
// value - ID идентификатор нового документа
Предыдущая
Следующая