{
"openapi": "3.0.1",
"info": {
"title": "api/firms",
"version": "1.0.0"
},
"servers": [
{
"url": "/"
},
{
"url": "https://api.ati.su"
}
],
"security": [
{
"BearerAuth": []
}
],
"paths": {
"/v1.2/account": {
"get": {
"tags": [
"Account"
],
"summary": "Получение информации о своей фирме",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/account": {
"get": {
"tags": [
"Account"
],
"summary": "Получение информации о своей фирме",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPascalCase"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/contact": {
"get": {
"tags": [
"Contacts"
],
"summary": "Метод получения текущего контакта фирмы",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/contacts": {
"get": {
"tags": [
"Contacts"
],
"summary": "Метод получения всех контактов фирмы",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPublic"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Contacts"
],
"summary": "Метод редактирования контакта фирмы",
"requestBody": {
"description": "Контакт для изменения",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmContact"
}
],
"description": "Контакт для изменения",
"nullable": true
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmContact"
}
],
"description": "Контакт для изменения",
"nullable": true
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmContact"
}
],
"description": "Контакт для изменения",
"nullable": true
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmContact"
}
],
"description": "Контакт для изменения",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/{atiId}/contacts/{contactId}/summary": {
"get": {
"tags": [
"ContactSummary"
],
"summary": "Получение краткой информации о контакте фирмы",
"parameters": [
{
"name": "atiId",
"in": "path",
"description": "Идентификатор фирмы",
"required": true,
"schema": {
"type": "string",
"description": "Идентификатор фирмы",
"nullable": true
}
},
{
"name": "contactId",
"in": "path",
"description": "Идентификатор контакта фирмы",
"required": true,
"schema": {
"type": "integer",
"description": "Идентификатор контакта фирмы",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactSummaryPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/{atiId}/contacts/summary": {
"get": {
"tags": [
"ContactSummary"
],
"summary": "Получение краткой информации о всех контактах фирмы",
"parameters": [
{
"name": "atiId",
"in": "path",
"description": "Идентификатор фирмы",
"required": true,
"schema": {
"type": "string",
"description": "Идентификатор фирмы",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactSummaryPublic"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/contact/{atiId}/{contactId}/email": {
"get": {
"tags": [
"Contacts"
],
"summary": "Получить email контакта",
"parameters": [
{
"name": "atiId",
"in": "path",
"description": "Идентификатор фирмы",
"required": true,
"schema": {
"type": "string",
"description": "Идентификатор фирмы",
"nullable": true
}
},
{
"name": "contactId",
"in": "path",
"description": "Идентификатор контакта",
"required": true,
"schema": {
"type": "integer",
"description": "Идентификатор контакта",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/requisites/{requisiteId}": {
"get": {
"tags": [
"Requisites"
],
"summary": "Метод получения реквизитов по ID",
"parameters": [
{
"name": "requisiteId",
"in": "path",
"description": "Идентификатор реквизита",
"required": true,
"schema": {
"type": "string",
"description": "Идентификатор реквизита",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FirmRequisitePublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/requisites": {
"get": {
"tags": [
"Requisites"
],
"summary": "Метод получения реквизитов фирмы",
"parameters": [
{
"name": "atiId",
"in": "query",
"description": "Код фирмы в ATI.SU",
"schema": {
"type": "string",
"description": "Код фирмы в ATI.SU",
"nullable": true
}
},
{
"name": "withShortRequisite",
"in": "query",
"description": "С короткими реквизитами",
"schema": {
"type": "boolean",
"description": "С короткими реквизитами",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FirmRequisitePublic"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/{atiId}/requisites": {
"get": {
"tags": [
"Requisites"
],
"summary": "Метод получения реквизитов фирмы",
"parameters": [
{
"name": "atiId",
"in": "path",
"description": "Код фирмы в ATI.SU",
"required": true,
"schema": {
"type": "string",
"description": "Код фирмы в ATI.SU",
"nullable": true
}
},
{
"name": "withShortRequisite",
"in": "query",
"description": "С короткими реквизитами",
"schema": {
"type": "boolean",
"description": "С короткими реквизитами",
"default": false
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FirmRequisitePublic"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/summary": {
"get": {
"tags": [
"AccountSummary"
],
"summary": "Получение краткой информации о своей фирме",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/summary/{atiId}": {
"get": {
"tags": [
"AccountSummary"
],
"summary": "Получение краткой информации по фирме (по идентификатору)",
"parameters": [
{
"name": "atiId",
"in": "path",
"description": "Идентификатор фирмы",
"required": true,
"schema": {
"type": "string",
"description": "Идентификатор фирмы",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/summaries": {
"post": {
"tags": [
"AccountSummary"
],
"summary": "Получение краткой информации по фирмам (по идентификаторам)",
"requestBody": {
"description": "Список идентификаторов фирм",
"content": {
"application/json-patch+json": {
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Список идентификаторов фирм",
"nullable": true
}
},
"application/json": {
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Список идентификаторов фирм",
"nullable": true
}
},
"text/json": {
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Список идентификаторов фирм",
"nullable": true
}
},
"application/*+json": {
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Список идентификаторов фирм",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountSummaryPublic"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/comments": {
"get": {
"tags": [
"FirmComment"
],
"summary": "Получение всех своих комментариев о других фирмах",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FirmCommentPublic"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"FirmComment"
],
"summary": "Добавление комментария о фирме",
"requestBody": {
"description": "Комментарий для добавления",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmCommentPublicPost"
}
],
"description": "Комментарий для добавления",
"nullable": true
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmCommentPublicPost"
}
],
"description": "Комментарий для добавления",
"nullable": true
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmCommentPublicPost"
}
],
"description": "Комментарий для добавления",
"nullable": true
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmCommentPublicPost"
}
],
"description": "Комментарий для добавления",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FirmCommentPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"FirmComment"
],
"summary": "Изменение комментария о фирме",
"requestBody": {
"description": "Комментарий для изменения",
"content": {
"application/json-patch+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmCommentPublic"
}
],
"description": "Комментарий для изменения",
"nullable": true
}
},
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmCommentPublic"
}
],
"description": "Комментарий для изменения",
"nullable": true
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmCommentPublic"
}
],
"description": "Комментарий для изменения",
"nullable": true
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FirmCommentPublic"
}
],
"description": "Комментарий для изменения",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FirmCommentPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/comments/{atiId}": {
"get": {
"tags": [
"FirmComment"
],
"summary": "Получение своего комментария о фирме, указанной в atiId",
"parameters": [
{
"name": "atiId",
"in": "path",
"description": "Идентификатор фирмы",
"required": true,
"schema": {
"type": "string",
"description": "Идентификатор фирмы",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FirmCommentPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/comments/byfirms": {
"post": {
"tags": [
"FirmComment"
],
"summary": "Получение своих комментариев о фирмах, указанных в atiIds",
"requestBody": {
"description": "Идентификаторы фирм",
"content": {
"application/json-patch+json": {
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Идентификаторы фирм"
}
},
"application/json": {
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Идентификаторы фирм"
}
},
"text/json": {
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Идентификаторы фирм"
}
},
"application/*+json": {
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Идентификаторы фирм"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FirmCommentPublic"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1.0/firms/comments/{commentId}": {
"get": {
"tags": [
"FirmComment"
],
"summary": "Получение своего комментария о фирме по идентификатору комментария commentId",
"parameters": [
{
"name": "commentId",
"in": "path",
"description": "Идентификатор комментария",
"required": true,
"schema": {
"type": "string",
"description": "Идентификатор комментария",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FirmCommentPublic"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"FirmComment"
],
"summary": "Удаление комментария о фирме по идентификатору комментария commentId",
"parameters": [
{
"name": "commentId",
"in": "path",
"description": "Идентификатор комментария",
"required": true,
"schema": {
"type": "string",
"description": "Идентификатор комментария",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"402": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"504": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ErrorResponse": {
"type": "object",
"properties": {
"error": {
"type": "string",
"nullable": true
},
"reason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UserRights": {
"enum": [
0,
1,
2,
4,
8,
16,
32,
64,
128,
256,
512,
1024,
2048,
4096,
8192,
131072,
262144,
2097152,
8388608,
8534011,
16777216,
25313275,
27670527,
27672575
],
"type": "integer",
"format": "int64",
"description": "Права контакта"
},
"ContactRightNestingType": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32",
"description": "Тип доступа
0 - только свое подразделение
1 - только свое и дочернее подразделение
2 - все подразделения"
},
"FirmCommentPublic": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор комментария",
"format": "uuid"
},
"ati_id": {
"type": "string",
"description": "Идентификатор фирмы, оставившей комментарий",
"nullable": true
},
"user_id": {
"type": "integer",
"description": "Идентификатор контакта",
"format": "int32",
"nullable": true
},
"commented_firm_ati_id": {
"type": "string",
"description": "Идентификатор фирмы, о которой оставили комментарий",
"nullable": true
},
"comment": {
"type": "string",
"description": "Текст комментария",
"nullable": true
},
"added_date": {
"type": "string",
"description": "Дата добавления комментария",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"FirmCommentPublicPost": {
"type": "object",
"properties": {
"ati_id": {
"type": "string",
"description": "Идентификатор фирмы, оставившей комментарий",
"nullable": true
},
"user_id": {
"type": "integer",
"description": "Идентификатор контакта",
"format": "int32",
"nullable": true
},
"commented_firm_ati_id": {
"type": "string",
"description": "Идентификатор фирмы, о которой оставили комментарий",
"nullable": true
},
"comment": {
"type": "string",
"description": "Текст комментария",
"nullable": true
},
"added_date": {
"type": "string",
"description": "Дата добавления комментария",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TaxationTypes": {
"enum": [
0,
1,
2,
4,
8
],
"type": "integer",
"format": "int32"
},
"FiasLevel": {
"enum": [
0,
1,
3,
4,
5,
6,
7,
90,
91
],
"type": "integer",
"format": "int32"
},
"FirmAddressPublic": {
"type": "object",
"properties": {
"address_id": {
"type": "string",
"description": "Идентификатор адреса",
"format": "uuid"
},
"ati_id": {
"type": "string",
"description": "Код в ATI.SU фирмы",
"nullable": true
},
"country_id": {
"type": "integer",
"description": "Идентификатор страны",
"format": "int32",
"nullable": true
},
"region_id": {
"type": "integer",
"description": "Идентификатор региона",
"format": "int32",
"nullable": true
},
"city_id": {
"type": "integer",
"description": "Идентификатор Города",
"format": "int32",
"nullable": true
},
"city_name": {
"type": "string",
"description": "Название города",
"nullable": true
},
"post_index": {
"type": "string",
"description": "Почтовый индекс",
"nullable": true
},
"street_type_id": {
"type": "integer",
"description": "Тип улицы",
"format": "int32"
},
"street_name": {
"type": "string",
"description": "Улица",
"nullable": true
},
"house_no": {
"type": "string",
"description": "Номер дома",
"nullable": true
},
"part_no": {
"type": "string",
"description": "Корпус дома",
"nullable": true
},
"litera": {
"type": "string",
"description": "Литера",
"nullable": true
},
"office_no": {
"type": "string",
"description": "Номер офиса",
"nullable": true
},
"post_contact": {
"type": "string",
"description": "Получатель почты",
"nullable": true
},
"add_date": {
"type": "string",
"description": "Дата добавления",
"format": "date-time",
"nullable": true
},
"attributes": {
"type": "integer",
"description": "Аттрибуты",
"format": "int32"
},
"send_type_id": {
"type": "integer",
"description": "?",
"format": "int32"
},
"note": {
"type": "string",
"description": "Примечание",
"nullable": true
},
"formatted_text": {
"type": "string",
"description": "?",
"nullable": true
},
"is_post_address": {
"type": "boolean",
"description": "Является почтовым адресом"
},
"fias_id": {
"type": "string",
"description": "Идентификатор в ФИАС",
"format": "uuid",
"nullable": true
},
"fias_level": {
"allOf": [
{
"$ref": "#/components/schemas/FiasLevel"
}
],
"description": "Уровень в ФИАС",
"nullable": true
}
},
"additionalProperties": false,
"description": "Адрес фирмы"
},
"Signee": {
"type": "object",
"properties": {
"signee_id": {
"type": "string",
"description": "Идентификатор подписанта.",
"format": "uuid"
},
"requisite_id": {
"type": "string",
"description": "Идентификатор реквизита, которому принадлежит эта запись.",
"format": "uuid"
},
"full_name": {
"type": "string",
"description": "ФИО (обязательно в родительном падеже).",
"nullable": true
},
"position": {
"type": "string",
"description": "Должность (обязательно в родительном падеже).",
"nullable": true
},
"act_upon": {
"type": "string",
"description": "На основании чего действует (обязательно в родительном падеже).",
"nullable": true
},
"is_default": {
"type": "boolean",
"description": "Выбирать по умолчанию."
},
"deletion_date": {
"type": "string",
"description": "Дата удаления.",
"format": "date-time",
"nullable": true
},
"full_name_and_position": {
"type": "string",
"description": "Поле, объединяющее FullName и Position. Не является автовычисляемым (т.е. не является конкатенацией полей FullName и Position), создано для других нужд.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Подписант (лицо, поставившее свою подпись под документом)."
},
"PersonPassportScanFile": {
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "Ccылка",
"nullable": true
},
"id": {
"type": "string",
"description": "Идентификатор",
"nullable": true
},
"size": {
"type": "integer",
"description": "Размер",
"format": "int32"
},
"name": {
"type": "string",
"description": "Название",
"nullable": true
}
},
"additionalProperties": false,
"description": "Файл со сканом паспорта"
},
"PersonPassport": {
"type": "object",
"properties": {
"series": {
"type": "string",
"description": "Серия",
"nullable": true
},
"number": {
"type": "string",
"description": "Номер",
"nullable": true
},
"date_of_issue": {
"type": "string",
"description": "Дата выдачи",
"format": "date-time"
},
"department_code": {
"type": "string",
"description": "Код подразделения",
"nullable": true
},
"issued_by": {
"type": "string",
"description": "Выдан",
"nullable": true
},
"registration": {
"type": "string",
"description": "Адрес регистрации",
"nullable": true
},
"scan_files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PersonPassportScanFile"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Паспорт физического лица"
},
"FirmRequisitePublic": {
"type": "object",
"properties": {
"requisite_id": {
"type": "string",
"description": "Идентификтаор реквизита",
"format": "uuid"
},
"ati_id": {
"type": "string",
"description": "Код в ATI.SU фирмы",
"nullable": true
},
"requisite_type_id": {
"type": "integer",
"description": "Тип реквизита",
"format": "int32"
},
"requisite_name": {
"type": "string",
"description": "Название реквизита",
"nullable": true
},
"legal_name": {
"type": "string",
"description": "Юридическое именование фирмы",
"nullable": true
},
"own_ship_id": {
"type": "integer",
"description": "Идентификатор формы собственности",
"format": "int32"
},
"fio": {
"type": "string",
"description": "ФИО владельца",
"nullable": true
},
"inn": {
"type": "string",
"description": "ИНН",
"nullable": true
},
"ogrn": {
"type": "string",
"description": "ОГРН, для реквизитов в валюте (USD и EUR) в этом поле храниться VAT",
"nullable": true
},
"phone": {
"type": "string",
"description": "Телефон",
"nullable": true
},
"fax": {
"type": "string",
"description": "Факс",
"nullable": true
},
"email": {
"type": "string",
"description": "Электронный адрес",
"nullable": true
},
"kpp": {
"type": "string",
"description": "КПП",
"nullable": true
},
"rs": {
"type": "string",
"description": "Расчетный счет",
"nullable": true
},
"ks": {
"type": "string",
"description": "КС",
"nullable": true
},
"bik": {
"type": "string",
"description": "БИК",
"nullable": true
},
"bank": {
"type": "string",
"description": "Наименование банка",
"nullable": true
},
"codes": {
"type": "string",
"description": "Коды",
"nullable": true
},
"is_read_only": {
"type": "boolean",
"description": "Реквизиты только для чтения"
},
"okpo": {
"type": "string",
"description": "ОКПО",
"nullable": true
},
"is_vat_payer": {
"type": "boolean",
"description": "Плательщик НДС"
},
"last_use_date": {
"type": "string",
"description": "Дата последнего использования в системе",
"format": "date-time",
"nullable": true
},
"is_active": {
"type": "boolean",
"description": "Активный реквизит",
"default": true
},
"is_visible": {
"type": "boolean",
"description": "Будет ли виден реквизит пользователю в будущем \r\nНужен для одноразовых реквизитов, например, при создании счета с оплатой по банковской карте (там создается реквизит из пары полей)",
"default": true
},
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/FirmAddressPublic"
}
],
"description": "Юридический адрес",
"nullable": true
},
"post_address": {
"allOf": [
{
"$ref": "#/components/schemas/FirmAddressPublic"
}
],
"description": "Почтовый адрес",
"nullable": true
},
"legal_address_id": {
"type": "string",
"description": "Идентификатор юридического адреса в системе",
"format": "uuid"
},
"post_address_id": {
"type": "string",
"description": "Идентификатор почтового адреса в системе",
"format": "uuid"
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"description": "Список подписантов",
"nullable": true
},
"person_passport": {
"allOf": [
{
"$ref": "#/components/schemas/PersonPassport"
}
],
"description": "Паспорт физического лица",
"nullable": true
},
"available_in_ati_docs": {
"type": "boolean",
"description": "Доступно в АТИ Доках",
"readOnly": true
}
},
"additionalProperties": false
},
"PayedServicePublic": {
"type": "object",
"properties": {
"ati_id": {
"type": "string",
"nullable": true
},
"service_id": {
"type": "integer",
"description": "Идентификатор лицензии",
"format": "int32"
},
"service_name": {
"type": "string",
"description": "Название лицензии",
"nullable": true
},
"dependencies": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Включенные лицензии",
"nullable": true
}
},
"additionalProperties": false
},
"FirmActiveServicePublic": {
"type": "object",
"properties": {
"service_id": {
"type": "integer",
"description": "Идентификатор лицензии",
"format": "int32"
},
"service_name": {
"type": "string",
"description": "Название лицензии",
"nullable": true
},
"service_amount": {
"type": "integer",
"description": "Количество лицензии",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"RiAttributes": {
"enum": [
0,
1,
2,
4,
8,
16,
32,
64,
256,
512,
1024,
2048,
4096,
8192,
16384,
32768,
65536,
262144
],
"type": "integer",
"description": "Представляет атрибуты пользователя (таблица ri_users поле Attribute).",
"format": "int32"
},
"CityAttributes": {
"enum": [
0,
4
],
"type": "integer",
"format": "int32"
},
"City": {
"type": "object",
"properties": {
"city_id": {
"type": "integer",
"description": "Идентификатор города",
"format": "int32"
},
"region_id": {
"type": "integer",
"description": "Идентификатор региона, в котором находится город",
"format": "int32",
"nullable": true
},
"country_id": {
"type": "integer",
"description": "Идентификатор страны, в которой находится город",
"format": "int32",
"nullable": true
},
"full_name": {
"type": "string",
"description": "Полное название города",
"nullable": true,
"readOnly": true
},
"short_name": {
"type": "string",
"description": "Краткое название города",
"nullable": true,
"readOnly": true
},
"is_regional_center": {
"type": "boolean",
"description": "Является ли город региональным центром",
"readOnly": true
},
"city_size": {
"type": "integer",
"description": "Идентификатор размера города",
"format": "int32"
},
"fias_id": {
"type": "string",
"description": "Идентификатор города по ФИАС",
"format": "uuid",
"nullable": true
},
"attributes": {
"allOf": [
{
"$ref": "#/components/schemas/CityAttributes"
}
],
"description": "Аттрибуты города"
},
"city_name": {
"type": "string",
"description": "Название города",
"nullable": true
},
"region_name": {
"type": "string",
"description": "Название региона, в котором находится город",
"nullable": true
},
"country_name": {
"type": "string",
"description": "Название страны, в которой находится город",
"nullable": true
},
"country_code_name": {
"type": "string",
"description": "Кодовое название страны, в которой находится город",
"nullable": true
}
},
"additionalProperties": false
},
"FirmStatus": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"format": "int32"
},
"PassportPublic": {
"type": "object",
"properties": {
"ati_id": {
"type": "string",
"description": "Идентификатор фирмы",
"nullable": true
},
"total_score": {
"type": "number",
"description": "Сумма баллов пользователя ATI.SU",
"format": "double"
},
"ati_data_match_point": {
"type": "number",
"description": "Данные фирмы в ATI.SU (название, город) совпадают с настоящими данными фирмы",
"format": "double"
},
"account_lifetime_point": {
"type": "number",
"description": "За срок \"существования\" фирмы",
"format": "double"
},
"business_activity_point": {
"type": "number",
"description": "Свидетельство ведения фирмой текущей хозяйственной деятельности.",
"format": "double"
},
"round_table_point": {
"type": "number",
"description": "Балл по решению общественного движения пользователей ATI.SU \"Круглый стол\"",
"format": "double"
},
"claim_point": {
"type": "number",
"description": "Балл за имеющиеся Претензии к пользователю",
"format": "double"
},
"prof_activity_point": {
"type": "number",
"description": "За проф. деятельность в ATI.SU.",
"format": "double"
},
"ati_administration_point": {
"type": "number",
"description": "По решению администрации ATI.SU",
"format": "double"
},
"clones_point": {
"type": "number",
"description": "Балл за клонов участника системы",
"format": "double"
},
"egr_point": {
"type": "number",
"description": "По данным Единых Государственных Реестров Юридических Лиц и ИП",
"format": "double"
},
"mass_registration_point": {
"type": "number",
"description": "Юридическое лицо зарегистрировано по адресу массовой регистрации",
"format": "double"
},
"mass_founder_point": {
"type": "number",
"description": "Учредитель юридического лица является учредителем множества других юридических лиц",
"format": "double"
},
"firm_lifetime_point": {
"type": "number",
"description": "За давность регистрации в АвтоТрансИнфо",
"format": "double"
},
"ri_users_attributes": {
"allOf": [
{
"$ref": "#/components/schemas/RiAttributes"
}
],
"description": "Аттрибуты фирмы"
},
"recommendations_count": {
"type": "integer",
"description": "Количество рекомендаций",
"format": "int32"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/FirmStatus"
}
],
"description": "Статус отвечает за цвет подложки звезд"
},
"status_description": {
"type": "string",
"description": "Описание статуса",
"nullable": true
}
},
"additionalProperties": false,
"description": "Структура \"Паспорт\""
},
"AccountContactPublic": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор контакта",
"format": "int32"
},
"name": {
"type": "string",
"description": "Имя контакта",
"nullable": true
},
"fixed_rate_agreement_accepted": {
"type": "boolean",
"description": "Контакт принял соглашение о фиксированной ставке."
},
"telephone": {
"type": "string",
"description": "Телефон контакта",
"nullable": true
},
"telephone_brand": {
"type": "string",
"description": "Брэнд телефона контакта",
"nullable": true
},
"telephone_region": {
"type": "string",
"description": "Русское название телефона контакта",
"nullable": true
},
"lo_users_attributes": {
"type": "integer",
"description": "Атрибут пользователя",
"format": "int32"
},
"email": {
"type": "string",
"description": "Электронная почта контакта",
"nullable": true
},
"icq": {
"type": "string",
"description": "Icq контакта",
"nullable": true
},
"mobile": {
"type": "string",
"description": "Мобильный телефона контакта",
"nullable": true
},
"mobile_brand": {
"type": "string",
"description": "Брэнд мобильного телефона контакта",
"nullable": true
},
"mobile_region": {
"type": "string",
"description": "Русское название мобильного телефона контакта",
"nullable": true
},
"skype_name": {
"type": "string",
"description": "Скайп контакта",
"nullable": true
},
"fax": {
"type": "string",
"description": "Факс контакта",
"nullable": true
},
"mobile_operator": {
"type": "string",
"description": "Мобильный оператор",
"nullable": true
},
"region_id": {
"type": "string",
"description": "Идентификатор региона контакта",
"nullable": true
},
"city_id": {
"type": "integer",
"description": "Идентификатор города контакта",
"format": "int32",
"nullable": true
},
"is_visibled": {
"type": "boolean",
"description": "Параметр определяет, является ли контакт видимым или скрытым. От скрытого контакта нельзя добавить груз"
},
"is_email_visibled": {
"type": "boolean",
"description": "Параметр определяет, является ли электронный адрес видимым или скрытым"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/City"
}
],
"description": "Структура \"Город\" контакта",
"nullable": true
},
"access_rights": {
"type": "integer",
"description": "Права доступа",
"format": "int32"
},
"note": {
"type": "string",
"description": "Заметка о контакте",
"nullable": true
},
"has_personal_password": {
"type": "boolean",
"description": "Наличие личного пароля у контакта"
}
},
"additionalProperties": false
},
"AccountPublic": {
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "Логин пользователя",
"nullable": true
},
"admin_email": {
"type": "string",
"description": "Адресс электронной почты администратора фирмы",
"nullable": true
},
"add_date": {
"type": "string",
"description": "Дата создания аккаунта",
"format": "date-time"
},
"firm_type_id": {
"type": "integer",
"description": "Идентификатор профиля деятельности",
"format": "int32"
},
"firm_type": {
"type": "string",
"description": "Профиль деятельности",
"nullable": true
},
"payed_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PayedServicePublic"
},
"description": "Структура \"Оплаченные услуги\"",
"nullable": true
},
"firm_active_services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FirmActiveServicePublic"
},
"nullable": true
},
"payed_services_end_date": {
"type": "string",
"description": "Дата окончания оплаченных услуг",
"format": "date-time"
},
"has_payed_services": {
"type": "boolean",
"description": "Оплачены ли у фирмы какие-либо лицензии",
"readOnly": true
},
"is_reset_similarity_point": {
"type": "boolean",
"description": "Был сброшен балл за соответствие в связи с продолжительной неактивностью фирмы",
"readOnly": true
},
"time_zone_id": {
"type": "string",
"description": "Текстовое описание часового пояса",
"nullable": true
},
"has_documents": {
"type": "boolean",
"description": "Флаг о наличии документов связанных с фирмой в таблице FirmDocuments"
},
"account_id": {
"type": "string",
"description": "Код фирмы в ATI.SU",
"nullable": true
},
"contact_id": {
"type": "integer",
"description": "Идентификатор контакта",
"format": "int32",
"nullable": true
},
"full_firm_name": {
"type": "string",
"description": "Полное название фирмы, учитывается название фирмы, ОПФ и брэнд.\r\n\r\nБрэнд не включается в полное название для форм собственности\r\n\r\n (другая)\r\n ПБОЮЛ\r\n ПБЮЛ\r\n ФЛП\r\n физ.лицо",
"nullable": true
},
"firm_name": {
"type": "string",
"description": "Название фирмы",
"nullable": true
},
"brand": {
"type": "string",
"description": "Брэнд фирмы",
"nullable": true
},
"ownership": {
"type": "string",
"description": "Организационно-правовая форма фирмы",
"nullable": true
},
"ownership_id": {
"type": "integer",
"description": "Идентификатор организационно-правовой формы фирмы",
"format": "int32"
},
"address": {
"type": "string",
"description": "Адрес фирмы",
"nullable": true
},
"inn": {
"type": "string",
"description": "ИНН фирмы",
"nullable": true
},
"ogrn": {
"type": "string",
"description": "ОГРН фирмы",
"nullable": true
},
"time_zone_minutes": {
"type": "integer",
"description": "Отступ в минутах от UTC для часового пояса, выставленного в кабинете данного аккаунта",
"format": "int32"
},
"claims_sum": {
"type": "number",
"description": "Сумма претензий к данной фирме в рублях",
"format": "double",
"nullable": true
},
"claims_count": {
"type": "integer",
"description": "Количество претензий от фирм",
"format": "int32"
},
"city_id": {
"type": "integer",
"description": "Идентификатор города",
"format": "int32"
},
"bad_partner_mentions_count": {
"type": "integer",
"description": "Количество упоминаний на форуме Недобросовестных партнеров",
"format": "int32"
},
"bad_partner_firms_count": {
"type": "integer",
"description": "Количество упоминаний о данной фирме на форуме \"Недобросовестные партнеры\"",
"format": "int32"
},
"recommendations_count": {
"type": "integer",
"description": "Количество фирм, которые написали сообщение о данной фирме на форуме \"Недобросовестные партнеры\"",
"format": "int32"
},
"ri_users_attributes": {
"allOf": [
{
"$ref": "#/components/schemas/RiAttributes"
}
],
"description": "Аттрибуты фирмы"
},
"ri_users_attributes2": {
"type": "integer",
"description": "Аттрибуты фирмы",
"format": "int32"
},
"firm_attributes": {
"type": "integer",
"description": "Аттрибуты фирмы",
"format": "int32"
},
"is_rrd": {
"type": "boolean",
"description": "Включен ли у фирмы режим РРД"
},
"loads_access": {
"type": "integer",
"description": "Уровень доступа пользователя к грузам",
"format": "int32"
},
"loads_access_reason": {
"type": "integer",
"description": "Причина понижения доступа пользователя к грузам",
"format": "int32"
},
"load_responses_access": {
"type": "integer",
"description": "Уровень доступа пользователя к отзывам на грузы",
"format": "int32"
},
"load_responses_access_reason": {
"type": "integer",
"description": "Причина понижения доступа пользователя к отзывам на грузы",
"format": "int32"
},
"unlimited_stealth_access": {
"type": "integer",
"description": "Уровень доступа пользователя к стеллс, id сервиса 400",
"format": "int32"
},
"unlimited_stealth_access_reason": {
"type": "integer",
"description": "Причина понижения доступа пользователя к стеллс",
"format": "int32"
},
"trucks_access": {
"type": "integer",
"description": "Уровень доступа пользователя к транспорту",
"format": "int32"
},
"trucks_access_reason": {
"type": "integer",
"description": "Причина понижения доступа пользователя к транспорту",
"format": "int32"
},
"truck_responses_access": {
"type": "integer",
"description": "Уровень доступа пользователя к отзывам на транспорт",
"format": "int32"
},
"truck_responses_access_reason": {
"type": "integer",
"description": "Причина понижения доступа пользователя к отзывам на транспорт",
"format": "int32"
},
"position_in_city": {
"type": "integer",
"description": "Место в рэйтинге по городу",
"format": "int32",
"nullable": true
},
"position_in_country": {
"type": "integer",
"description": "Место в рэйтинге по стране",
"format": "int32",
"nullable": true
},
"is_responses_for_black_list_enabled": {
"type": "boolean",
"description": "Включено принятие встречных предложений от фирм из черного списка"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/City"
}
],
"description": "Структура \"Город\"",
"nullable": true
},
"passport": {
"allOf": [
{
"$ref": "#/components/schemas/PassportPublic"
}
],
"description": "Структура \"Паспорт\"",
"nullable": true
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AccountContactPublic"
},
"description": "Список структур \"Контакт\"",
"nullable": true
},
"currency_id": {
"type": "integer",
"description": "Идентификатор валюты",
"format": "int32",
"nullable": true
},
"note": {
"type": "string",
"description": "Примечание",
"nullable": true
},
"http": {
"type": "string",
"description": "Сайт фирмы",
"nullable": true
},
"taxation_type": {
"allOf": [
{
"$ref": "#/components/schemas/TaxationTypes"
}
],
"description": "Тип налогооблажения",
"nullable": true
},
"with_vat": {
"type": "boolean",
"description": "Ндс"
}
},
"additionalProperties": false
},
"AffilatedFirmPublic": {
"type": "object",
"properties": {
"firm_name": {
"type": "string",
"description": "Название",
"nullable": true
},
"inn": {
"type": "string",
"description": "ИНН",
"nullable": true
},
"tf_firm_color": {
"type": "string",
"description": "Цвет фирмы по системе \"Светофор\"",
"nullable": true
},
"tf_has_signals": {
"type": "boolean",
"description": "Есть факты в системе \"Светофор\""
}
},
"additionalProperties": false
},
"FirmDocument": {
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "Ссылка на документ.",
"nullable": true
},
"description": {
"type": "string",
"description": "Автогенерируемое описание документа.",
"nullable": true
},
"creation_date": {
"type": "string",
"description": "Дата создания документа.",
"format": "date-time"
},
"name": {
"type": "string",
"description": "Имя документа.",
"nullable": true
},
"type_id": {
"type": "integer",
"description": "Идентификатор типа документа из коллекции !:LocalizedDictionaries.DocumentTemplates.",
"format": "int32"
}
},
"additionalProperties": false
},
"AccountSummaryPublic": {
"type": "object",
"properties": {
"ati_id": {
"type": "string",
"description": "Идентификатор фирмы",
"nullable": true
},
"brand": {
"type": "string",
"description": "Брэнд фирмы",
"nullable": true
},
"ownership": {
"type": "string",
"description": "Организационно-правовая форма фирмы",
"nullable": true
},
"full_name": {
"type": "string",
"description": "Полное имя фирмы: Брэнд (Название фирмы, ОПФ)",
"nullable": true
},
"firm_name": {
"type": "string",
"description": "Название фирмы",
"nullable": true
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/City"
}
],
"description": "Структура \"Город\"",
"nullable": true
},
"address": {
"type": "string",
"description": "Адрес фирмы",
"nullable": true
},
"web_site": {
"type": "string",
"description": "Сайт фирмы",
"nullable": true
},
"position_in_city": {
"type": "integer",
"description": "Место в рэйтинге по городу",
"format": "int32",
"nullable": true
},
"position_in_country": {
"type": "integer",
"description": "Место в рэйтинге по стране",
"format": "int32",
"nullable": true
},
"name_eng": {
"type": "string",
"description": "Интернациональное название фирмы",
"nullable": true
},
"firm_type": {
"type": "string",
"description": "Профиль деятельности фирмы",
"nullable": true
},
"firm_type_id_int": {
"type": "integer",
"description": "Идентификатор профиля деятельности",
"format": "int32"
},
"firm_type_id": {
"type": "string",
"description": "(Устаревшее)\r\nИдентификатор профиля деятельности строкой",
"nullable": true
},
"predicted_firm_type_id": {
"type": "integer",
"description": "Идентификатор предполагаемого профиля деятельности фирмы, основанный на её анализе",
"format": "int32",
"nullable": true
},
"info_reference": {
"type": "string",
"description": "Ссылка на карточку фирмы",
"nullable": true
},
"passport_reference": {
"type": "string",
"description": "Ссылка на паспорт фирмы",
"nullable": true
},
"city": {
"type": "string",
"description": "Город, в котором расположена фирма",
"nullable": true
},
"score": {
"type": "number",
"description": "Количество звезд фирмы. Если число отрицательно, то это красные звезды",
"format": "double"
},
"bad_partner_mentions_count": {
"type": "integer",
"description": "Количество упоминаний на форуме недобросовестных партнеров",
"format": "int32"
},
"claims_count": {
"type": "integer",
"description": "Количество претензий от фирм",
"format": "int32"
},
"language": {
"type": "string",
"description": "Язык фирмы",
"nullable": true
},
"recommendations_count": {
"type": "integer",
"description": "Количество рекомендаций от фирм",
"format": "int32"
},
"inn": {
"type": "string",
"description": "Инн",
"nullable": true
},
"ogrn": {
"type": "string",
"description": "ОГРН",
"nullable": true
},
"kpp": {
"type": "string",
"description": "Код причины постановки на учет фирмы",
"nullable": true
},
"okpo": {
"type": "string",
"description": "Общероссийский классификатор предприятий и организаций",
"nullable": true
},
"affiliated_firms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AffilatedFirmPublic"
},
"description": "Связанные фирмы",
"nullable": true
},
"negative_points_sum": {
"type": "number",
"description": "Сумма отрицательных баллов",
"format": "double"
},
"tf_firm_color": {
"type": "string",
"description": "Цвет фирмы в светофоре",
"nullable": true
},
"tf_account_color": {
"type": "string",
"description": "Цвет аккаунта в светофоре",
"nullable": true
},
"tf_has_signals": {
"type": "boolean",
"description": "Флаг о существовании любой информации о фирме в светофоре"
},
"registration_date": {
"type": "string",
"description": "Дата регистрации на сайте, которая AddDate из firms.",
"format": "date-time"
},
"contact_info_changed": {
"type": "string",
"description": "Дата последних изменений в истории фирмы.",
"format": "date-time"
},
"deletion_date": {
"type": "string",
"description": "Дата удаления фирмы.",
"format": "date-time",
"nullable": true
},
"last_month_active_days": {
"type": "integer",
"description": "Число дней со входами на сайт за последние 30 дней.",
"format": "int32"
},
"firm_documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FirmDocument"
},
"description": "Список структуры \"Документ фирмы\"",
"nullable": true
},
"verified_trucks": {
"type": "integer",
"description": "Количеством зарегистрированных ТС",
"format": "int32"
}
},
"additionalProperties": false
},
"EmailInfo": {
"type": "object",
"properties": {
"email": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ContactPublic": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Идентификатор контакта",
"format": "int32"
},
"firm_name": {
"type": "string",
"description": "Название фирмы",
"nullable": true
},
"ownership": {
"type": "string",
"description": "Организационно-правовая форма",
"nullable": true
},
"ownership_id": {
"type": "integer",
"description": "Форма собственности",
"format": "int32"
},
"ati_id": {
"type": "string",
"description": "Код фирмы в ATI.SU",
"nullable": true
},
"firm_deletion_date": {
"type": "string",
"description": "Дата удаления аккаунта",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Имя контакта",
"nullable": true
},
"phone": {
"type": "string",
"description": "Номер телефона (основной)",
"nullable": true
},
"e_mail": {
"type": "string",
"description": "Электронная почта контакта",
"nullable": true
},
"email_for_link": {
"type": "string",
"description": "Адрес для отправки письма на задание логина/пароля",
"nullable": true
},
"icq": {
"type": "string",
"description": "ICQ контакта",
"nullable": true
},
"mobile": {
"type": "string",
"description": "Номер телефона контакта (мобильный)",
"nullable": true
},
"fax": {
"type": "string",
"description": "Номер телефона контакта (факс)",
"nullable": true
},
"note": {
"type": "string",
"description": "Примечание",
"nullable": true
},
"is_visible": {
"type": "boolean",
"description": "Контакта виден / скрыт"
},
"is_email_visible": {
"type": "boolean",
"description": "E-mail виден / скрыт"
},
"mobile_id": {
"type": "integer",
"description": "Номер телефона (мобильный) без кода города",
"format": "int32",
"nullable": true
},
"phone_id": {
"type": "integer",
"description": "Номер телефона (основной) без кода города",
"format": "int32",
"nullable": true
},
"fax_id": {
"type": "integer",
"description": "Номер телефона контакта (факс) без кода города",
"format": "int32",
"nullable": true
},
"skype_name": {
"type": "string",
"description": "Логин в Skype",
"nullable": true
},
"city_id": {
"type": "integer",
"description": "Идентификатори города",
"format": "int32",
"nullable": true
},
"attributes": {
"type": "integer",
"description": "Атрибуты контакта",
"format": "int32",
"nullable": true
},
"access_rights": {
"type": "integer",
"description": "Права контакта (для ррд)",
"format": "int32"
},
"gsm_operator_id": {
"type": "integer",
"description": "Идентификатор сотового оператора",
"format": "int32",
"nullable": true
},
"is_deleted": {
"type": "boolean",
"description": "Удален ли контакт",
"readOnly": true
},
"deletion_date": {
"type": "string",
"description": "Дата удаления контакта",
"format": "date-time",
"nullable": true
},
"is_photo_exists": {
"type": "boolean",
"description": "Загружено ли фото"
},
"login": {
"type": "string",
"description": "Логин контакта",
"nullable": true
},
"has_personal_password": {
"type": "boolean",
"description": "Есть ли персональный пароль"
},
"language": {
"type": "string",
"description": "Язык сайта выбранный, контактом",
"nullable": true
},
"department_id": {
"type": "integer",
"description": "Идентификатор основного подразделения контакта",
"format": "int32"
},
"position": {
"type": "string",
"description": "Должность",
"nullable": true
},
"user_rights": {
"allOf": [
{
"$ref": "#/components/schemas/UserRights"
}
],
"description": "Права контакта в новой схеме"
},
"contact_right_nesting_type_id": {
"allOf": [
{
"$ref": "#/components/schemas/ContactRightNestingType"
}
],
"description": "Уровень доступа к другим подразделениям"
}
},
"additionalProperties": false
},
"FirmContact": {
"type": "object",
"properties": {
"firm_id": {
"type": "integer",
"description": "Идентификатор фирмы",
"format": "int32",
"nullable": true
},
"firm_name": {
"type": "string",
"description": "Название фирмы",
"nullable": true
},
"ownership": {
"type": "string",
"description": "Организационно-правовая форма",
"nullable": true
},
"ownership_id": {
"type": "integer",
"description": "Форма собственности",
"format": "int32"
},
"password": {
"type": "string",
"description": "Пароль",
"nullable": true
},
"id": {
"type": "integer",
"description": "Идентификатор контакта",
"format": "int32"
},
"ati_id": {
"type": "string",
"description": "Код фирмы в ATI.SU",
"nullable": true
},
"firm_deletion_date": {
"type": "string",
"description": "Дата удаления аккаунта",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Имя контакта",
"nullable": true
},
"phone": {
"type": "string",
"description": "Номер телефона (основной)",
"nullable": true
},
"e_mail": {
"type": "string",
"description": "Электронная почта контакта",
"nullable": true
},
"email_for_link": {
"type": "string",
"description": "Адрес для отправки письма на задание логина/пароля",
"nullable": true
},
"icq": {
"type": "string",
"description": "ICQ контакта",
"nullable": true
},
"mobile": {
"type": "string",
"description": "Номер телефона контакта (мобильный)",
"nullable": true
},
"fax": {
"type": "string",
"description": "Номер телефона контакта (факс)",
"nullable": true
},
"note": {
"type": "string",
"description": "Примечание",
"nullable": true
},
"is_visible": {
"type": "boolean",
"description": "Контакта виден / скрыт"
},
"is_email_visible": {
"type": "boolean",
"description": "E-mail виден / скрыт"
},
"mobile_id": {
"type": "integer",
"description": "Номер телефона (мобильный) без кода города",
"format": "int32",
"nullable": true
},
"phone_id": {
"type": "integer",
"description": "Номер телефона (основной) без кода города",
"format": "int32",
"nullable": true
},
"fax_id": {
"type": "integer",
"description": "Номер телефона контакта (факс) без кода города",
"format": "int32",
"nullable": true
},
"skype_name": {
"type": "string",
"description": "Логин в Skype",
"nullable": true
},
"city_id": {
"type": "integer",
"description": "Идентификатори города",
"format": "int32",
"nullable": true
},
"attributes": {
"type": "integer",
"description": "Атрибуты контакта",
"format": "int32",
"nullable": true
},
"access_rights": {
"type": "integer",
"description": "Права контакта (для ррд)",
"format": "int32"
},
"gsm_operator_id": {
"type": "integer",
"description": "Идентификатор сотового оператора",
"format": "int32",
"nullable": true
},
"is_deleted": {
"type": "boolean",
"description": "Удален ли контакт",
"readOnly": true
},
"deletion_date": {
"type": "string",
"description": "Дата удаления контакта",
"format": "date-time",
"nullable": true
},
"is_photo_exists": {
"type": "boolean",
"description": "Загружено ли фото"
},
"login": {
"type": "string",
"description": "Логин контакта",
"nullable": true
},
"has_personal_password": {
"type": "boolean",
"description": "Есть ли персональный пароль"
},
"language": {
"type": "string",
"description": "Язык сайта выбранный, контактом",
"nullable": true
},
"department_id": {
"type": "integer",
"description": "Идентификатор основного подразделения контакта",
"format": "int32"
},
"position": {
"type": "string",
"description": "Должность",
"nullable": true
},
"user_rights": {
"allOf": [
{
"$ref": "#/components/schemas/UserRights"
}
],
"description": "Права контакта в новой схеме"
},
"contact_right_nesting_type_id": {
"allOf": [
{
"$ref": "#/components/schemas/ContactRightNestingType"
}
],
"description": "Уровень доступа к другим подразделениям"
}
},
"additionalProperties": false
},
"ContactSummaryPublic": {
"type": "object",
"properties": {
"ati_id": {
"type": "string",
"description": "Код в ATI.SU.",
"nullable": true
},
"contact_id": {
"type": "integer",
"description": "Идентификатор контакта.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Имя контакта.",
"nullable": true
},
"phone": {
"type": "string",
"description": "Рабочий телефон.",
"nullable": true
},
"mobile_phone": {
"type": "string",
"description": "Мобильный телефон.",
"nullable": true
},
"claims_count": {
"type": "integer",
"description": "Количество претензий.",
"format": "int32"
},
"recommendations_count": {
"type": "integer",
"description": "Количество рекомендаций.",
"format": "int32"
},
"bad_partner_mentions_count": {
"type": "integer",
"description": "Количество упоминаний на форуме \"Недобросовестные партнеры\".",
"format": "int32"
},
"firm_type": {
"type": "string",
"description": "Профиль деятельности фирмы.",
"nullable": true
},
"firm_name": {
"type": "string",
"description": "Название фирмы.",
"nullable": true
},
"ownership": {
"type": "string",
"description": "Организационно-правовая форма.",
"nullable": true
},
"city": {
"type": "string",
"description": "Город",
"nullable": true
},
"score": {
"type": "number",
"description": "Количество звезд фирмы.",
"format": "double"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/FirmStatus"
}
],
"description": "Статус, определяющий цвет подложки звезд.",
"nullable": true
},
"icq": {
"type": "string",
"description": "Icq контакта",
"nullable": true
},
"fax": {
"type": "string",
"description": "Факс контакта",
"nullable": true
},
"skype_name": {
"type": "string",
"description": "Skype контакта",
"nullable": true
},
"email": {
"type": "string",
"description": "Email контакта",
"nullable": true
},
"language": {
"type": "string",
"description": "Язык контакта",
"nullable": true
}
},
"additionalProperties": false,
"description": "Краткая информация о контакте."
},
"LocationPascalCase": {
"type": "object",
"properties": {
"Id2": {
"type": "string",
"description": "Уникальный идентификатор местоположения",
"format": "uuid",
"nullable": true
},
"CityId": {
"type": "integer",
"description": "Идентификатор города",
"format": "int32"
},
"RegionId": {
"type": "integer",
"description": "Идентификатор региона",
"format": "int32"
},
"CountryId": {
"type": "integer",
"description": "Идентификатор страны",
"format": "int32"
},
"FullName": {
"type": "string",
"description": "Полное название местоположения",
"nullable": true
},
"ShortName": {
"type": "string",
"description": "Краткое название местоположения",
"nullable": true
},
"FullNameEng": {
"type": "string",
"description": "Полное название на английском языке",
"nullable": true
},
"ShortNameEng": {
"type": "string",
"description": "Краткое название на английском языке",
"nullable": true
},
"IsRegionalCenter": {
"type": "boolean",
"description": "Является ли региональным центром"
},
"CitySize": {
"type": "integer",
"description": "Размер города",
"format": "int32"
},
"FiasId": {
"type": "string",
"description": "Идентификатор ФИАС",
"format": "uuid",
"nullable": true
},
"Longitude": {
"type": "number",
"description": "Долгота",
"format": "double",
"nullable": true
},
"Latitude": {
"type": "number",
"description": "Широта",
"format": "double",
"nullable": true
},
"CityName": {
"type": "string",
"description": "Название города",
"nullable": true
},
"RegionName": {
"type": "string",
"description": "Название региона",
"nullable": true
},
"CountryName": {
"type": "string",
"description": "Название страны",
"nullable": true
},
"CityNameEng": {
"type": "string",
"description": "Название города на английском языке",
"nullable": true
},
"RegionNameEng": {
"type": "string",
"description": "Название региона на английском языке",
"nullable": true
},
"CountryNameEng": {
"type": "string",
"description": "Название страны на английском языке",
"nullable": true
},
"CountryCodeName": {
"type": "string",
"description": "Код страны",
"nullable": true
}
},
"additionalProperties": false
},
"PassportPascalCase": {
"type": "object",
"properties": {
"TotalScore": {
"type": "number",
"description": "Общий балл паспорта",
"format": "double"
},
"ATIDataMatchPoint": {
"type": "number",
"description": "Балл за соответствие данных АТИ",
"format": "double"
},
"AccountLifetimePoint": {
"type": "number",
"description": "Балл за время существования аккаунта",
"format": "double"
},
"BusinessActivityPoint": {
"type": "number",
"description": "Балл за деловую активность",
"format": "double"
},
"RoundTablePoint": {
"type": "number",
"description": "Балл за участие в круглом столе",
"format": "double"
},
"ClaimPoint": {
"type": "number",
"description": "Балл за претензии",
"format": "double"
},
"ProfActivityPoint": {
"type": "number",
"description": "Балл за профессиональную активность",
"format": "double"
},
"ATIAdministrationPoint": {
"type": "number",
"description": "Балл от администрации АТИ",
"format": "double"
},
"ClonesPoint": {
"type": "number",
"description": "Балл за клоны",
"format": "double"
},
"EGRPoint": {
"type": "number",
"description": "Балл за ЕГР",
"format": "double"
},
"MassRegistrationPoint": {
"type": "number",
"description": "Балл за массовую регистрацию",
"format": "double"
},
"MassFounderPoint": {
"type": "number",
"description": "Балл за массового учредителя",
"format": "double"
},
"FirmLifetimePoint": {
"type": "number",
"description": "Балл за время существования фирмы",
"format": "double"
},
"Status": {
"type": "integer",
"description": "Статус паспорта",
"format": "int32"
},
"StatusDescription": {
"type": "string",
"description": "Описание статуса паспорта",
"nullable": true
}
},
"additionalProperties": false
},
"ContactPascalCase": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"description": "Идентификатор контакта",
"format": "int32"
},
"Name": {
"type": "string",
"description": "Имя контакта",
"nullable": true
},
"Telephone": {
"type": "string",
"description": "Телефон",
"nullable": true
},
"TelephoneBrand": {
"type": "string",
"description": "Оператор телефона",
"nullable": true
},
"TelephoneRegion": {
"type": "string",
"description": "Регион телефона",
"nullable": true
},
"Email": {
"type": "string",
"description": "Email адрес",
"nullable": true
},
"Icq": {
"type": "string",
"description": "ICQ номер",
"nullable": true
},
"Mobile": {
"type": "string",
"description": "Мобильный телефон",
"nullable": true
},
"MobileBrand": {
"type": "string",
"description": "Оператор мобильного телефона",
"nullable": true
},
"MobileRegion": {
"type": "string",
"description": "Регион мобильного телефона",
"nullable": true
},
"SkypeName": {
"type": "string",
"description": "Skype имя",
"nullable": true
},
"Fax": {
"type": "string",
"description": "Факс",
"nullable": true
},
"MobileOperator": {
"type": "string",
"description": "Оператор мобильной связи",
"nullable": true
},
"RegionId": {
"type": "integer",
"description": "Идентификатор региона",
"format": "int32",
"nullable": true
},
"Location": {
"$ref": "#/components/schemas/LocationPascalCase",
"description": "Местоположение контакта"
},
"IsVisibled": {
"type": "boolean",
"description": "Видимость контакта"
},
"IsEmailVisibled": {
"type": "boolean",
"description": "Видимость email"
},
"Note": {
"type": "string",
"description": "Примечание",
"nullable": true
},
"Language": {
"type": "string",
"description": "Язык",
"nullable": true
},
"DepartmentId": {
"type": "integer",
"description": "Идентификатор отдела",
"format": "int32"
},
"Position": {
"type": "string",
"description": "Должность",
"nullable": true
},
"UserRights": {
"type": "integer",
"description": "Права пользователя",
"format": "int32"
},
"ContactRightNestingType": {
"type": "integer",
"description": "Тип вложенности прав контакта",
"format": "int32"
},
"AvailableDepartments": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Доступные отделы"
},
"CanWorkWithSubdivisions": {
"type": "boolean",
"description": "Может работать с подразделениями"
},
"CanTakeLoad": {
"type": "boolean",
"description": "Может принимать грузы"
},
"CanWorkWithCommonBoard": {
"type": "boolean",
"description": "Может работать с общей доской"
},
"CanWorkWithPersonalBoard": {
"type": "boolean",
"description": "Может работать с личной доской"
},
"CanUseVirtualPayments": {
"type": "boolean",
"description": "Может использовать виртуальные платежи"
}
},
"additionalProperties": false
},
"AccountPascalCase": {
"type": "object",
"properties": {
"AccountId": {
"type": "integer",
"description": "Идентификатор аккаунта",
"format": "int32"
},
"ContactId": {
"type": "integer",
"description": "Идентификатор контакта",
"format": "int32"
},
"FullFirmName": {
"type": "string",
"description": "Полное название фирмы",
"nullable": true
},
"FirmName": {
"type": "string",
"description": "Название фирмы",
"nullable": true
},
"Brand": {
"type": "string",
"description": "Бренд фирмы",
"nullable": true
},
"Ownership": {
"type": "string",
"description": "Форма собственности",
"nullable": true
},
"OwnershipId": {
"type": "integer",
"description": "Идентификатор формы собственности",
"format": "int32"
},
"Location": {
"$ref": "#/components/schemas/LocationPascalCase",
"description": "Местоположение фирмы"
},
"Inn": {
"type": "string",
"description": "ИНН фирмы",
"nullable": true
},
"TimeZoneMinutes": {
"type": "integer",
"description": "Часовой пояс в минутах от UTC",
"format": "int32"
},
"IsRrd": {
"type": "boolean",
"description": "Включен ли режим РРД"
},
"LoadsAccess": {
"type": "integer",
"description": "Уровень доступа к грузам",
"format": "int32"
},
"ClaimsCount": {
"type": "integer",
"description": "Количество претензий",
"format": "int32"
},
"BadPartnerMentionsCount": {
"type": "integer",
"description": "Количество упоминаний недобросовестных партнеров",
"format": "int32"
},
"BadPartnerFirmsCount": {
"type": "integer",
"description": "Количество недобросовестных партнеров",
"format": "int32"
},
"FirmTypeId": {
"type": "integer",
"description": "Идентификатор типа фирмы",
"format": "int32"
},
"FirmType": {
"type": "string",
"description": "Тип фирмы",
"nullable": true
},
"RecommendationCount": {
"type": "integer",
"description": "Количество рекомендаций",
"format": "int32"
},
"MaxContactsCount": {
"type": "integer",
"description": "Максимальное количество контактов",
"format": "int32"
},
"Passport": {
"$ref": "#/components/schemas/PassportPascalCase",
"description": "Паспорт фирмы"
},
"Contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactPascalCase"
},
"description": "Список контактов"
},
"RiUsersAttributes": {
"type": "integer",
"description": "Атрибуты пользователя",
"format": "int32"
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Authorization: Bearer {authorizationToken}"
}
}
}
}