Skip to content

Класс: Клиент (client)

Apostol Developer edited this page May 12, 2022 · 6 revisions

API

POST /api/v1/client/[ type | method | count | set | get | list ]

Конечные точки классов

Параметры запроса

Имя Тип Значение Описание
id UUID Обязательный для действия изменить. Идентификатор объекта.
parent UUID Необязательный. Идентификатор объекта родителя.
type STRING Необязательный. Код типа.
code STRING Рекомендуемый. ИНН - для юридического лица или имя пользователя (login).
userid UUID Необязательный. Идентификатор учётной записи клиента. Если указать 0, то учётная запись будет создана автоматически.
name JSON Рекомендуемый. Наименование компании/Ф.И.О.
phone JSON Необязательный. Справочник телефонов.
email JSON Необязательный. Электронные адреса.
info JSON Необязательный. Дополнительная информация.
description STRING Необязательный. Описание.

Формат name:

Ключ Тип Описание
name STRING Рекомендуемый. Полное наименование организации/Ф.И.О одной строкой
short STRING Рекомендуемый. Краткое наименование организации
first STRING Рекомендуемый. Имя
last STRING Рекомендуемый. Фамилия
middle STRING Рекомендуемый. Отчество

Формат phone: произвольный. Формат email: произвольный. Формат info: произвольный.

Формат ответа

Поле Тип Описание
code STRING Код клиента.
userId UUID Идентификатор учётной записи клиента.
fullname STRING Полное наименование компании/Ф.И.О.
shortname STRING Краткое наименование компании.
lastname STRING Фамилия.
firstname STRING Имя.
middlename STRING Отчество.
phone JSON Справочник телефонов.
email JSON Электронные адреса.
info JSON Дополнительная информация.
locale UUID Идентификатор локали.
localecode STRING Код локали.
localename STRING Наименование локали.
Clone this wiki locally