Карточка и реквизиты

Карточка контрагента

GET https://do.freshoffice.ru/company/get?id=368132

Возвращает контрагента целиком одним запросом: основные поля карточки, все email и телефоны, реквизиты и контактные лица с их средствами связи. Удобно, чтобы проверить, что уже есть у записи, прежде чем дополнять её.

Query Parameters

Name Type Description
id Int ID контрагента

Ответ

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 0,
  "pages": 0,
  "page": 0,
  "value": "{
    \"company\":  { \"id\": 368132, \"name\": \"Продстар\", \"person\": 1, \"address\": \"...\", \"url\": \"...\", \"user_id\": 37, \"type_id\": 1, \"status_id\": 3, ... },
    \"emails\":   [ { ...email... } ],
    \"phones\":   [ { ...телефон... } ],
    \"requisites\": [ { ...реквизиты... } ],
    \"contacts\": [ { ...контактное лицо с Phones/Emails... } ]
  }"
}
// status "Error" - контрагент не найден или удалён

Поля company совпадают с колонками списка контрагентов. В emails и phones попадают и адреса/телефоны контактных лиц — у них заполнен id_contact_man.

Добавление реквизитов

POST https://do.freshoffice.ru/company/requisites/insert

Добавляет реквизиты юридическому лицу: коды, адреса, руководителя, банк. Первые реквизиты контрагента становятся основными — по ним работает фильтр tax_id в списке контрагентов. Официальные данные удобно взять из карточки по ИНН.

Request Body

Name Type Description
id_company* Int ID контрагента
inn, kpp, ogrn_client, okpo, okved, oktmo, okato String Коды
kr_name, full_name String Краткое и полное наименование с формой собственности
adres_yur, adres_fact, pocht_adr String Юридический, фактический и почтовый адреса
dir_name, dir_status String Руководитель и должность
gl_buh String Главный бухгалтер
bank_name, bik, ks, rs String Банк, БИК, корреспондентский и расчётный счета
requis_prim String Примечание
use_default String True — основные реквизиты. Если не передан: True для первых реквизитов контрагента, иначе False 
{
    "id_company": 368132,
    "inn": "7801234567",
    "kpp": "780101001",
    "ogrn_client": "1027800000000",
    "kr_name": "ООО \"Продстар\"",
    "full_name": "Общество с ограниченной ответственностью \"Продстар\"",
    "adres_yur": "г Санкт-Петербург, ул Примерная, д 1",
    "dir_name": "Александров Евгений Борисович",
    "dir_status": "Генеральный директор"
}

Те же поля принимает блок Paymentdetails при добавлении контрагента — реквизиты создаются вместе с компанией.

Пример

curl --location --request POST 'https://do.freshoffice.ru/company/requisites/insert' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id_company": 368132,
    "inn": "7801234567",
    "kpp": "780101001",
    "kr_name": "ООО \"Продстар\""
  }'

Ответ

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 0,
  "pages": 0,
  "page": 0,
  "value": "5120"
}
// value - ID новых реквизитов, 0 - ошибка (текст в поле error)
Предыдущая
Обновление
Следующая
Официальные данные (ИНН)