Карточка клиента, включая реквизиты и внутреннюю заметку — HTTP 200
Поля вложенного объекта обязательны только при наличии этого объекта. Поля с null=да принимают или возвращают явный null. Необязательные поля могут отсутствовать из-за прав.
| Поле | Тип | Обязательно | null | Ограничения и смысл |
|---|---|---|---|---|
data |
объект | да | нет | — |
data.id |
целое число | да | нет | — |
data.name |
строка / null | да | да | — |
data.company_name |
строка / null | да | да | — |
data.is_customer |
логическое значение | да | нет | — |
data.is_supplier |
логическое значение | да | нет | — |
data.phone |
строка / null | да | да | — |
data.additional_phone |
строка / null | да | да | — |
data.email |
строка / null | да | да | — |
data.address |
строка / null | да | да | — |
data.source |
строка / null | да | да | — |
data.contacts |
массив | да | нет | — |
data.contacts[] |
объект | да | нет | — |
data.contacts[].name |
строка / null | да | да | — |
data.contacts[].position |
строка / null | да | да | — |
data.contacts[].phone |
строка / null | да | да | — |
data.custom_fields |
массив | да | нет | — |
data.custom_fields[] |
объект | да | нет | — |
data.custom_fields[].field_id |
целое число | да | нет | — |
data.custom_fields[].value |
строка / логическое значение / массив / объект / null | да | да | — |
data.custom_fields[].value (вариант 3) |
массив | нет | нет | — |
data.custom_fields[].value (вариант 3)[] |
строка | да | нет | — |
data.custom_fields[].value (вариант 4) |
объект | нет | нет | — |
data.custom_fields[].value (вариант 4).amount |
строка | да | нет | — |
data.custom_fields[].value (вариант 4).currency |
строка | да | нет | — |
data.external_id |
строка / null | да | да | — |
data.links |
объект | да | нет | — |
data.links.edit |
строка / null | да | да | — |
data.links.portal |
строка / null | да | да | — |
data.links.public |
строка / null | да | да | — |
data.version |
строка | да | нет | — |
data.updated_at |
строка / null | да | да | — |
data.inn |
строка / null | нет | да | — |
data.kpp |
строка / null | нет | да | — |
data.ogrn |
строка / null | нет | да | — |
data.bank |
объект | нет | нет | — |
data.bank.name |
строка / null | да | да | — |
data.bank.bik |
строка / null | да | да | — |
data.bank.account |
строка / null | да | да | — |
data.bank.correspondent_account |
строка / null | да | да | — |
data.internal_note |
строка / null | нет | да | — |
meta |
объект | да | нет | — |
Пример формы ответа
Все значения демонстрационные. Идентификаторы связей и доступные ссылки определяет организация.
{
"data": {
"id": 101,
"name": null,
"company_name": null,
"is_customer": true,
"is_supplier": true,
"phone": null,
"additional_phone": null,
"email": null,
"address": null,
"source": null,
"contacts": [],
"custom_fields": [],
"external_id": null,
"links": {
"edit": null,
"portal": null,
"public": null
},
"version": "1793782800",
"updated_at": null
},
"meta": {}
}