Создание отчета "Продажам по клиентам"

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

yearMonthFrom

string <date>

required

Год и месяц начала формирования отчета

yearMonthTo

string <date>

required

Год и месяц окончания формирования отчета

department

string

required

коды подразделений

Example:

/department-codes/1

assignees

array[string <iri-reference>]

optional

Ответственные

withAllClients

boolean

required

Все клиенты

Default:

false

Example

{
    "yearMonthFrom": "2019-08-24",
    "yearMonthTo": "2019-08-24",
    "department": "/department-codes/1",
    "assignees": [
        "/users/1"
    ],
    "withAllClients": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

deletedAt

string <date-time> | null

required

integer

required

>= 1

file

object

File

optional

uuid

string <uuid>

optional

name

string

optional

path

string

optional

size

integer

optional

>= 0

mimeType

string

optional

createdBy

object

Пользователи (base)

optional

updatedBy

object

Пользователи (base)

optional

deletedAt

string <date-time> | null

optional

createdAt

string <date-time>

optional

updatedAt

string <date-time>

optional

pathPreview

string

optional

status

object

Enum

required

integer

required

>= 1

title

string

required

department

object

Коды подразделений

required

Права доступа на редактирование, создание и удаление записей в данном разделе должно быть доступно только пользователю группы Администратор.
Администратор самостоятельно может предоставить доступ на управление данным разделом в случае необходимости в карточке настройки прав доступа на определенную Роль.

deletedAt

string <date-time> | null

required

integer

required

>= 1

code

string

required

Код подразделения (Уникальный код, состоящий только из букв и чисел)

Match pattern:

^[A-Z0-9]+

errorMessage

string

optional

Сообщение об ошибке

yearMonthFrom

string <date>

required

Год и месяц начала формирования отчета

yearMonthTo

string <date>

required

Год и месяц окончания формирования отчета

withAllClients

boolean

required

Все клиенты

Default:

false

assignees

array[object (Пользователи (base)) {10}]

required

Ответственные

integer

read-onlyoptional

>= 1

firstname

string

required

surname

string

required

Фамилия

phone

string <phone>

required

Телефон

Match pattern:

^((\+7|7|8)+([0-9]){10})$

string <email>

required

departmentCode

optional

Код подразделения (Идентификатор кода).Обязательно, если роль = "менеджер по продажам".

position

optional

Должность

group

optional

Группа пользователя

codes

array[object (Коды пользователей (users view)) {3}]

optional

Код менеджера (Уникальный код менеджера, состоящий только из букв и чисел).В поле “Код менеджера” не должно быть разрешено сохранять значение с дефисом, должна появляться ошибка.Обязательно, если роль = "Менеджер по продажам".

roles

array[object (Роли) {5}]

required

Example

{
    "deletedAt": "2019-08-24T14:15:22Z",
    "id": 1,
    "file": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "path": "string",
        "size": 0,
        "mimeType": "string",
        "createdBy": {
            "id": 1,
            "firstname": "string",
            "surname": "string",
            "phone": "string",
            "email": "user@example.com",
            "departmentCode": {
                "code": "string"
            },
            "position": {
                "title": "string"
            },
            "group": {
                "title": "string"
            },
            "codes": [
                {
                    "code": "string"
                }
            ],
            "roles": [
                {
                    "title": "string",
                    "allServices": true,
                    "services": [
                        {
                            "title": "string",
                            "departureCountry": {
                                "title": "string"
                            },
                            "departureCity": {
                                "title": "string",
                                "country": {
                                    "title": "string"
                                }
                            },
                            "isForwarding": false
                        }
                    ]
                }
            ]
        },
        "updatedBy": {
            "id": 1,
            "firstname": "string",
            "surname": "string",
            "phone": "string",
            "email": "user@example.com",
            "codes": [],
            "roles": []
        },
        "deletedAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "pathPreview": "string"
    },
    "status": {
        "id": 1,
        "title": "string"
    },
    "department": {
        "code": "string"
    },
    "errorMessage": "string",
    "yearMonthFrom": "2019-08-24",
    "yearMonthTo": "2019-08-24",
    "withAllClients": false,
    "assignees": [
        {
            "id": 1,
            "firstname": "string",
            "surname": "string",
            "phone": "string",
            "email": "user@example.com",
            "codes": [],
            "roles": []
        }
    ]
}

🟠400Ошибки 4XX

🔴500Ошибки 5XX