Получение отчета по аналитике подразделения

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

reportID

string

required

departmentCode

string

required

Query Params

page

integer

optional

The collection page number

pagination

boolean

optional

Enable or disable pagination

exists[deletedAt]

boolean

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

object

required

weight

array [object {13}]

required

Вес груза (т)

commercialUsd

array[object (Данные отчета по аналитике подразделения) {13}]

required

Коммерция в долларах ($)

commercialRub

array[object (Данные отчета по аналитике подразделения) {13}]

required

Коммерция в рублях (р.)

revenue

array[object (Данные отчета по аналитике подразделения) {13}]

required

Выручка (р.)

total

object

required

yearFrom

string <date>

required

Example:

2001

yearTo

string <date>

required

Example:

2005

departmentCode

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

required

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

deletedAt

string <date-time> | null

required

integer

required

>= 1

code

string

required

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

Match pattern:

^[A-Z0-9]+

Example

{
    "data": {
        "weight": [
            {
                "1": 0,
                "2": 0,
                "3": 0,
                "4": 0,
                "5": 0,
                "6": 0,
                "7": 0,
                "8": 0,
                "9": 0,
                "10": 0,
                "11": 0,
                "12": 0,
                "year": "2001"
            }
        ],
        "commercialUsd": [
            {
                "1": 0,
                "2": 0,
                "3": 0,
                "4": 0,
                "5": 0,
                "6": 0,
                "7": 0,
                "8": 0,
                "9": 0,
                "10": 0,
                "11": 0,
                "12": 0,
                "year": "2001"
            }
        ],
        "commercialRub": [
            {
                "1": 0,
                "2": 0,
                "3": 0,
                "4": 0,
                "5": 0,
                "6": 0,
                "7": 0,
                "8": 0,
                "9": 0,
                "10": 0,
                "11": 0,
                "12": 0,
                "year": "2001"
            }
        ],
        "revenue": [
            {
                "1": 0,
                "2": 0,
                "3": 0,
                "4": 0,
                "5": 0,
                "6": 0,
                "7": 0,
                "8": 0,
                "9": 0,
                "10": 0,
                "11": 0,
                "12": 0,
                "year": "2001"
            }
        ],
        "total": {
            "weight": {
                "1": 0,
                "2": 0,
                "3": 0,
                "4": 0,
                "5": 0,
                "6": 0,
                "7": 0,
                "8": 0,
                "9": 0,
                "10": 0,
                "11": 0,
                "12": 0
            },
            "commercialUsd": {
                "1": 0,
                "2": 0,
                "3": 0,
                "4": 0,
                "5": 0,
                "6": 0,
                "7": 0,
                "8": 0,
                "9": 0,
                "10": 0,
                "11": 0,
                "12": 0
            },
            "commercialRub": {
                "1": 0,
                "2": 0,
                "3": 0,
                "4": 0,
                "5": 0,
                "6": 0,
                "7": 0,
                "8": 0,
                "9": 0,
                "10": 0,
                "11": 0,
                "12": 0
            }
        }
    },
    "yearFrom": "2001",
    "yearTo": "2005",
    "departmentCode": {
        "deletedAt": "2019-08-24T14:15:22Z",
        "id": 1,
        "code": "string"
    }
}

🟠400Ошибки 4XX

🔴500Ошибки 5XX