{ "openapi": "3.0.0", "info": { "title": "Методы API для просмотра данных имуществ", "version": "0.4.0" }, "externalDocs": { "description": "Документация и схемы API v.1", "url": "/" }, "servers": [ { "url": "https://online.smartlombard.ru/api/exchange/v1" } ], "tags": [ { "name": "Методы для просмотра залоговых билетов" }, { "name": "Методы для просмотра операций" }, { "name": "Методы для просмотра элементарных операций" }, { "name": "Методы для просмотра залоговых имуществ" }, { "name": "Методы для просмотра клиентов физ. лиц" }, { "name": "Методы для просмотра клиентов юр. лиц" }, { "name": "Методы для просмотра юр. лиц филиалов (не клиентов)" }, { "name": "Методы для просмотра филиалов" }, { "name": "Методы для просмотра документов клиента физ. лица" }, { "name": "Методы для просмотра банковских карт клиента физ. лица" }, { "name": "Методы для просмотра истории бонусов" }, { "name": "Методы для просмотра тарифов" }, { "name": "Методы для просмотра сотрудников" }, { "name": "Методы для просмотра категорий/подкатегорий" }, { "name": "Методы для просмотра мест хранения" }, { "name": "Методы для просмотра драгоценных металлов и проб" }, { "name": "Методы для просмотра драгоценных камней" }, { "name": "Методы для просмотра рекламных каналов" }, { "name": "Методы для просмотра типов документов" } ], "paths": { "/pawn_tickets": { "get": { "tags": [ "Методы для просмотра залоговых билетов" ], "summary": "Просмотр списка залоговых билетов", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" }, { "name": "open_date_begin", "description": "Период дат открытия залоговых билетов начало", "in": "query", "schema": { "type": "string", "example": "01.03.2023" } }, { "name": "open_date_end", "description": "Период дат открытия залоговых билетов конец", "in": "query", "schema": { "type": "string", "example": "01.04.2023" } }, { "name": "close_date_begin", "description": "Период дат закрытия залоговых билетов начало", "in": "query", "schema": { "type": "string", "example": "01.03.2023" } }, { "name": "close_date_end", "description": "Период дат закрытия залоговых билетов конец", "in": "query", "schema": { "type": "string", "example": "01.04.2023" } }, { "name": "end_date_begin", "description": "Период дат предполагаемого закрытия залоговых билетов начало", "in": "query", "schema": { "type": "string", "example": "01.03.2023" } }, { "name": "end_date_end", "description": "Период дат предполагаемого закрытия залоговых билетов конец", "in": "query", "schema": { "type": "string", "example": "01.04.2023" } }, { "name": "status", "explode": false, "in": "query", "description": "Множественный выбор из массива состояний залогового билета (через запятую):\n* 1 - На реализации\n* 2 - Открыт\n* 3 - Просрочен\n* 4 - Просрочен (готов к продаже)\n* 5 - Закрыт\n", "schema": { "type": "string", "example": "1, 2, 3, 4, 5" } }, { "name": "workplace_id", "description": "ID филиала", "in": "query", "schema": { "$ref": "#/components/schemas/Workplace/properties/id" } }, { "name": "clients", "description": "Множественный выбор из массива ID клиентов (через запятую)", "in": "query", "schema": { "type": "string", "example": "89, 90" } }, { "name": "pawn_chain_id", "description": "ID цепочки залоговых билетов", "in": "query", "schema": { "type": "integer", "example": 79 } }, { "name": "document_number", "description": "Номер документа залогового билета", "in": "query", "schema": { "type": "string", "example": "ВО005" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "pawn_tickets": { "type": "array", "description": "Массиив объектов залоговых билетов", "items": { "$ref": "#/components/schemas/PawnTicket" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } }, "headers": { "Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "Pagination-CountRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "Pagination-CountPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/pawn_tickets/{pawn_ticket_id}": { "get": { "tags": [ "Методы для просмотра залоговых билетов" ], "summary": "Просмотр данных залогового билета по ID", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pawn_ticket_id", "in": "path", "required": true, "description": "ID - залогового билета (сквозной ID)", "schema": { "$ref": "#/components/schemas/PawnTicket/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "pawn_ticket": { "$ref": "#/components/schemas/PawnTicket" } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/pawn_tickets/{pawn_ticket_id}/pawn_goods": { "get": { "tags": [ "Методы для просмотра залоговых билетов" ], "summary": "Просмотр списка залоговых имуществ по ID залогового билета.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pawn_ticket_id", "in": "path", "required": true, "description": "ID - залогового билета (сквозной ID)", "schema": { "$ref": "#/components/schemas/PawnTicket/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "pawn_goods": { "type": "array", "description": "Массиив объектов имуществ", "items": { "$ref": "#/components/schemas/PawnGood" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/operations": { "get": { "tags": [ "Методы для просмотра операций" ], "summary": "Просмотр списка операций", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" }, { "name": "pawn_ticket_id", "in": "query", "description": "ID залогового билета", "schema": { "$ref": "#/components/schemas/PawnTicket/properties/id" } }, { "name": "pawn_chain_id", "in": "query", "description": "ID цепочки залогового билета", "schema": { "$ref": "#/components/schemas/PawnTicket/properties/pawn_chain_id" } }, { "name": "entity_id", "in": "query", "description": "ID, юр. лица (открывающего ЗБ если операция составная, сквозной ID)", "schema": { "$ref": "#/components/schemas/Entity/properties/id" } }, { "name": "type_operation", "in": "query", "description": "Тип операций. Варианты:\n * pledge - залог\n * prolongation - продление\n * prolongation_online - онлайн-продление\n * repledge - перезалог\n * dobor - добор\n * part_buyout - частичный выкуп\n * part_buyout_pawn_good - частичный выкуп имущества\n * sale_pledge - вывод из залога\n * buyout - выкуп\n * withdraw - изъятие имущества\n * send_realization - Отправка на реализацию\n * sell_realization - Реализация\n * withdraw - Изъятие\n", "schema": { "$ref": "#/components/schemas/Operation/properties/elementary_operations/properties/opening_operation/properties/type_operation" } }, { "name": "account_id", "in": "query", "description": "ID сотрудника", "schema": { "$ref": "#/components/schemas/Account/properties/id" } }, { "name": "workplace_id", "in": "query", "description": "ID филиала", "schema": { "$ref": "#/components/schemas/Workplace/properties/id" } }, { "name": "date_begin", "description": "Начало периода дат проведения операции", "in": "query", "schema": { "type": "string", "example": "01.03.2023" } }, { "name": "date_end", "description": "Конец периода дат проведения операции", "in": "query", "schema": { "type": "string", "example": "01.04.2023" } }, { "$ref": "#/components/parameters/TestOperation" } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "operations": { "type": "array", "description": "Массиив объекта операций", "items": { "$ref": "#/components/schemas/Operation" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/operations/{operation_id}": { "get": { "tags": [ "Методы для просмотра операций" ], "summary": "Просмотр данных операции по ID.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "operation_id", "in": "path", "description": "ID - операции (сквозной ID)", "required": true, "schema": { "type": "integer", "example": 123 } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "$ref": "#/components/schemas/Operation" } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/elementary_operations": { "get": { "tags": [ "Методы для просмотра элементарных операций" ], "summary": "Просмотр списка элементарных операций", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" }, { "name": "pawn_ticket_id", "in": "query", "description": "ID залогового билета", "schema": { "$ref": "#/components/schemas/PawnTicket/properties/id" } }, { "name": "type_operation", "in": "query", "description": "Тип операций. Варианты:\n * pledge - залог\n * prolongation - продление\n * prolongation_online - онлайн-продление\n * sale_pledge - вывод из залога\n * buyout - выкуп\n * withdraw - изъятие имущества\n", "schema": { "$ref": "#/components/schemas/ElementaryOperation/properties/type_operation" } }, { "name": "account_id", "in": "query", "description": "ID сотрудника", "schema": { "$ref": "#/components/schemas/Account/properties/id" } }, { "name": "entity_id", "in": "query", "description": "ID юр. лица", "schema": { "$ref": "#/components/schemas/Entity/properties/id" } }, { "name": "workplace_id", "in": "query", "description": "ID филиала", "schema": { "$ref": "#/components/schemas/Workplace/properties/id" } }, { "name": "date_begin", "description": "Начало периода дат проведения операции", "in": "query", "schema": { "type": "string", "example": "01.03.2023" } }, { "name": "date_end", "description": "Конец периода дат проведения операции", "in": "query", "schema": { "type": "string", "example": "01.04.2023" } }, { "$ref": "#/components/parameters/TestOperation" } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "operations": { "type": "array", "description": "Массиив объектов элементарных операций", "items": { "$ref": "#/components/schemas/ElementaryOperation" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/elementary_operations/{operation_id}": { "get": { "tags": [ "Методы для просмотра элементарных операций" ], "summary": "Просмотр данных элементарной операции по ID", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "operation_id", "in": "path", "description": "ID - операции (сквозной ID)", "required": true, "schema": { "type": "integer", "example": 200, "description": "Код ответа" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "$ref": "#/components/schemas/ElementaryOperation" } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/pawn_goods": { "get": { "tags": [ "Методы для просмотра залоговых имуществ" ], "summary": "Просмотр списка залоговых имуществ", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" }, { "name": "category_id", "in": "query", "description": "Категория/подкатегория", "schema": { "$ref": "#/components/schemas/Category/properties/id" } }, { "name": "workplace_id", "in": "query", "description": "ID филиала, где находится имущество", "schema": { "$ref": "#/components/schemas/Workplace/properties/id" } }, { "name": "status", "in": "query", "description": "Состояние залогового имущества:\n * 1 - На реализации\n * 2 - Реализован\n * 3 - Заложен\n * 4 - Заложен (просрочен)\n * 5 - Выкуплен\n * 6 - Готов к продаже\n * 7 - Выведен из залога\n * 8 - Изъят\n", "schema": { "type": "array", "items": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "example": 1 } } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "pawn_goods": { "type": "array", "description": "Массив объектов имуществ", "items": { "$ref": "#/components/schemas/PawnGood" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } }, "headers": { "Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "Pagination-CountRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "Pagination-CountPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/pawn_goods/{pawn_good_id}": { "get": { "tags": [ "Методы для просмотра залоговых имуществ" ], "summary": "Просмотр данных залогового имущества по ID", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "pawn_good_id", "in": "path", "description": "ID имущества", "required": true, "schema": { "$ref": "#/components/schemas/PawnGood/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "pawn_good": { "$ref": "#/components/schemas/PawnGood" } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/clients/natural_persons": { "get": { "tags": [ "Методы для просмотра клиентов физ. лиц" ], "summary": "Просмотр списка клиентов физ. лиц", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" }, { "name": "full_name", "in": "query", "description": "Фильтрация по ФИО (поиск по полям фамилия, имя, отчество)", "schema": { "type": "string", "example": "Иванов" } }, { "name": "phone", "in": "query", "description": "Фильтрация по номеру телефона", "schema": { "type": "string", "example": "+79033080944" } }, { "name": "inn", "in": "query", "description": "Фильтрация по ИНН/ИИН", "schema": { "type": "string", "example": "213123213" } }, { "name": "loyalty_card_number", "in": "query", "description": "Фильтрация по номеру карты постоянного клиента", "schema": { "type": "string", "example": "9586" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "clients_natural_persons": { "type": "array", "description": "Массиив объектов клиентов физ. лиц", "items": { "$ref": "#/components/schemas/NaturalPerson" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } }, "headers": { "Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "Pagination-CountRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "Pagination-CountPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/clients/natural_persons/{client_natural_person_id}": { "get": { "tags": [ "Методы для просмотра клиентов физ. лиц" ], "summary": "Просмотр данных клиента физ. лица по ID", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "client_natural_person_id", "in": "path", "description": "ID клиента", "required": true, "schema": { "$ref": "#/components/schemas/NaturalPerson/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "client_natural_person": { "$ref": "#/components/schemas/NaturalPerson" } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/clients/legal_persons": { "get": { "tags": [ "Методы для просмотра клиентов юр. лиц" ], "summary": "Просмотр списка клиентов юр. лиц", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" }, { "name": "name", "in": "query", "description": "Фильтрация по наименованию клиента", "schema": { "type": "string", "example": "Ломбард" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "client_legal_persons": { "type": "array", "description": "Массиив объектов юр. лиц", "items": { "$ref": "#/components/schemas/LegalPerson" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } }, "headers": { "Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "Pagination-CountRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "Pagination-CountPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/clients/legal_persons/{client_legal_person_id}": { "get": { "tags": [ "Методы для просмотра клиентов юр. лиц" ], "summary": "Просмотр данных клиента юр.лица по ID", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "client_legal_person_id", "in": "path", "description": "ID юр. лица", "required": true, "schema": { "$ref": "#/components/schemas/LegalPerson/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "client_legal_person": { "$ref": "#/components/schemas/LegalPerson" } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/entities": { "get": { "tags": [ "Методы для просмотра юр. лиц филиалов (не клиентов)" ], "summary": "Просмотр списка юр. лиц филиалов (не клиентов)", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "result": { "type": "object", "description": "Результат запроса", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "entities": { "type": "array", "description": "Массиив объектов юр. лиц реквизитов", "items": { "$ref": "#/components/schemas/Entity" } } } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } }, "headers": { "Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "Pagination-CountRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "Pagination-CountPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/entities/{entity_id}": { "get": { "tags": [ "Методы для просмотра юр. лиц филиалов (не клиентов)" ], "summary": "Просмотр данных юр. лица филиала (не клиента) по ID", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "entity_id", "in": "path", "description": "ID юр. лица", "required": true, "schema": { "$ref": "#/components/schemas/Entity/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "entity": { "$ref": "#/components/schemas/Entity" } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/workplaces": { "get": { "tags": [ "Методы для просмотра филиалов" ], "summary": "Просмотр списка филиалов", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" }, { "name": "state", "in": "query", "description": "Видимость филиалов\n * 1 - Только активные филиалы\n * 2 - Только скрытые филиалы\n", "schema": { "type": "integer", "enum": [ 1, 2 ], "example": 2 } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "workplaces": { "type": "array", "description": "Массиив объекта филиала", "items": { "$ref": "#/components/schemas/Workplace" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } }, "headers": { "Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "Pagination-CountRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "Pagination-CountPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/workplaces/{workplace_id}": { "get": { "tags": [ "Методы для просмотра филиалов" ], "summary": "Просмотр данных филиала по ID", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "workplace_id", "in": "path", "description": "ID филиала", "required": true, "schema": { "$ref": "#/components/schemas/Workplace/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "workplace": { "$ref": "#/components/schemas/Workplace" } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/clients/natural_persons/{client_id}/documents": { "get": { "tags": [ "Методы для просмотра документов клиента физ. лица" ], "summary": "Просмотр списка документов по ID клиента", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "ID клиента", "schema": { "$ref": "#/components/schemas/NaturalPerson/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "documents": { "type": "array", "description": "Массив объектов документов", "items": { "$ref": "#/components/schemas/Document" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/clients/natural_persons/{client_id}/documents/{document_id}": { "get": { "tags": [ "Методы для просмотра документов клиента физ. лица" ], "summary": "Просмотр данных документа по ID документа и ID клиента", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "ID клиента", "schema": { "$ref": "#/components/schemas/NaturalPerson/properties/id" } }, { "name": "document_id", "in": "path", "required": true, "description": "ID документа", "schema": { "$ref": "#/components/schemas/Document/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "document": { "$ref": "#/components/schemas/Document" } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/clients/natural_persons/{client_id}/bank_cards": { "get": { "tags": [ "Методы для просмотра банковских карт клиента физ. лица" ], "summary": "Просмотр списка банковских карт по ID клиента", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "ID клиента", "schema": { "$ref": "#/components/schemas/NaturalPerson/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "bank_cards": { "type": "array", "description": "Массив объектов банковских карт", "items": { "$ref": "#/components/schemas/BankCard" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/clients/natural_persons/{client_id}/bank_cards/{bank_card_id}": { "get": { "tags": [ "Методы для просмотра банковских карт клиента физ. лица" ], "summary": "Просмотр данных банковских карт по ID кары и ID клиента", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "ID клиента", "schema": { "$ref": "#/components/schemas/NaturalPerson/properties/id" } }, { "name": "bank_card_id", "in": "path", "required": true, "description": "ID банковской карты", "schema": { "$ref": "#/components/schemas/BankCard/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "bank_card": { "$ref": "#/components/schemas/BankCard" } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/clients/natural_persons/{client_id}/bonuses_history": { "get": { "tags": [ "Методы для просмотра истории бонусов" ], "summary": "Просмотр списка истории начисления/списания бонусов", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "client_id", "in": "path", "required": true, "description": "ID клиента", "schema": { "$ref": "#/components/schemas/NaturalPerson/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "bonuses_history": { "type": "array", "description": "Массив истории начисления/списания бонусов", "items": { "$ref": "#/components/schemas/BonusesHistory" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/tariffs": { "get": { "tags": [ "Методы для просмотра тарифов" ], "summary": "Просмотр списка тарифов", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "tariffs": { "type": "array", "description": "Массиив объектов Тарифов", "items": { "$ref": "#/components/schemas/Tariff" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } }, "headers": { "Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "Pagination-CountRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "Pagination-CountPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/accounts": { "get": { "tags": [ "Методы для просмотра сотрудников" ], "summary": "Просмотр списка сотрудников", "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" }, { "in": "query", "name": "status", "description": "Статус:\n * 1 - Действующий\n * 2 - Уволен\n * 3 - Забанен\n", "example": 1, "schema": { "$ref": "#/components/schemas/Account/properties/status" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "accounts": { "type": "array", "description": "Массиив объектов сотрудников", "items": { "$ref": "#/components/schemas/Account" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } }, "headers": { "Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "Pagination-CountRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "Pagination-CountPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/accounts/{account_id}": { "get": { "tags": [ "Методы для просмотра сотрудников" ], "summary": "Просмотр данных сотрудника по ID.", "parameters": [ { "in": "path", "name": "account_id", "required": true, "description": "ID - Сотрудника", "schema": { "$ref": "#/components/schemas/Account/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "account": { "$ref": "#/components/schemas/Account" } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/categories": { "get": { "tags": [ "Методы для просмотра категорий/подкатегорий" ], "summary": "Просмотр списка категорий верхнего уровня.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/limitParam" } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "categories": { "type": "array", "description": "Массиив объектов категорий", "items": { "$ref": "#/components/schemas/Category" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } }, "headers": { "Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "Pagination-CountRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "Pagination-CountPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/subcategory/{category_id}": { "get": { "tags": [ "Методы для просмотра категорий/подкатегорий" ], "summary": "Просмотр списка подкатегорий по ID родительской категори верхнего уровня.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "category_id", "in": "path", "description": "ID категории", "required": true, "schema": { "$ref": "#/components/schemas/Category/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "subcategories": { "type": "array", "description": "Массиив объектов подкатегории", "items": { "$ref": "#/components/schemas/Subcategory" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/junior_subcategories/{category_id}/{subcategory_id}": { "get": { "tags": [ "Методы для просмотра категорий/подкатегорий" ], "summary": "Просмотр списка младших подкатегорий по ID родительских категорий верхнего уровня.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "category_id", "in": "path", "description": "ID категории", "required": true, "schema": { "$ref": "#/components/schemas/Category/properties/id" } }, { "name": "subcategory_id", "in": "path", "description": "ID подкатегории", "required": true, "schema": { "$ref": "#/components/schemas/Subcategory/properties/id" } } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "description": "Объект данных ответа", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "junior_subcategories": { "type": "array", "description": "Массиив объектов младших подкатегорий", "items": { "$ref": "#/components/schemas/JuniorSubcategory" } } } }, "metadata": { "$ref": "#/components/schemas/Metadata" } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/storage_places/{workplace_id}": { "get": { "tags": [ "Методы для просмотра мест хранения" ], "summary": "Метод позволяет получить все места хранения по ID филиаила", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/WorkplaceId" } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "storages": { "description": "Массив объектов данных о местах хранения", "type": "array", "items": { "$ref": "#/components/schemas/StoragePlaces" } } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/metals": { "get": { "tags": [ "Методы для просмотра драгоценных металлов и проб" ], "summary": "Метод позволяет получить список ID и наименования драгоценных металлов.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/PageParam" }, { "$ref": "#/components/parameters/LimitParam" } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "precious_metals": { "type": "array", "description": "Массив объектов данных драгоценных металлов", "items": { "$ref": "#/components/schemas/Metal" } } } } } } } }, "headers": { "X-Pagination-Page": { "$ref": "#/components/headers/PaginationPage" }, "X-Pagination-PageSize": { "$ref": "#/components/headers/PaginationPageSize" }, "X-Pagination-TotalRecords": { "$ref": "#/components/headers/PaginationTotalRecords" }, "X-Pagination-TotalPages": { "$ref": "#/components/headers/PaginationTotalPages" }, "X-Pagination-PreviousPage": { "$ref": "#/components/headers/PaginationPreviousPage" }, "X-Pagination-NextPage": { "$ref": "#/components/headers/PaginationNextPage" } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorListResponse" } } } }, "/metals/{metal_id}/metals_standarts": { "get": { "tags": [ "Методы для просмотра драгоценных металлов и проб" ], "summary": "Метод позволяет получить список ID и наименований проб по ID металла", "security": [ { "bearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/MetalId" } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "metals_standarts": { "type": "array", "description": "Массив объектов данных проб", "items": { "$ref": "#/components/schemas/MetalStandart" } } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/pawn_goods/jewelry_gems": { "get": { "tags": [ "Методы для просмотра драгоценных камней" ], "summary": "Метод позволяет получить справочники для добавления драгоценных камней.", "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "measures_units": { "type": "array", "description": "Единицы измерения", "items": { "properties": { "measure_unit_id": { "type": "integer", "example": 56, "description": "ID единицы измерения" }, "measure_unit_title": { "type": "string", "example": "Карат", "description": "Наименования единицы измерения" } } } }, "gems_types": { "type": "array", "description": "Типы камней", "items": { "properties": { "type_id": { "type": "integer", "example": 156, "description": "ID типа камня" }, "type_title": { "type": "string", "example": "Бриллиант", "description": "Наименование типа камня" }, "cut_type": { "type": "array", "description": "Массив видов огранки", "items": { "properties": { "cut_type_id": { "type": "integer", "example": 56, "description": "ID видов огранки" }, "cut_type_title": { "type": "string", "example": "Бп-25", "description": "Наименование видов огранки" } } } }, "color_group": { "type": "array", "description": "Массив групп цвета", "items": { "properties": { "color_group_id": { "type": "integer", "example": 56, "description": "ID группа цвета" }, "color_group_title": { "type": "string", "example": "Сине-зеленый", "description": "Наименование группы цвета" } } } }, "purity_group": { "type": "array", "description": "Массив групп чистоты", "items": { "properties": { "purity_group_id": { "type": "integer", "example": 56, "description": "ID группы чистоты" }, "purity_group_title": { "type": "string", "example": "К1", "description": "Наименование группы чистоты" } } } } } } } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/pawn_goods/{pawn_good_id}/jewelry_gems": { "get": { "tags": [ "Методы для просмотра драгоценных камней" ], "summary": "Метод позволяет получить данные драгоценных камней по ID имущества (Ювелирного изделия).", "parameters": [ { "$ref": "#/components/parameters/PawnGoodId" } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "jewelry_gems": { "type": "array", "description": "Массив объектов данных о драгоценных камнях", "items": { "$ref": "#/components/schemas/AnswerGem" } } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/ad_channels": { "get": { "tags": [ "Методы для просмотра рекламных каналов" ], "summary": "Метод позволяет получить список ID и наименований рекламных каналов", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "ad_channels": { "description": "Массив объектов данных рекламных каналов", "type": "array", "items": { "$ref": "#/components/schemas/AdChannels" } } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } }, "/document_types": { "get": { "tags": [ "Методы для просмотра типов документов" ], "summary": "Метод позволяет получить список ID, наименований типов документов", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Положительный ответ", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 200, "description": "Код ответа" }, "result": { "type": "object", "description": "Результат запроса", "properties": { "document_types": { "description": "Массив объектов данных рекламных каналов", "type": "array", "items": { "$ref": "#/components/schemas/DocumentTypes" } } } } } } } } }, "412": { "$ref": "#/components/responses/ErrorValidationFailed" }, "default": { "$ref": "#/components/responses/ErrorGetResponse" } } } } }, "components": { "parameters": { "offsetParam": { "in": "query", "name": "offset", "description": "Смещение запроса", "schema": { "type": "integer", "example": 1, "default": 0, "minimum": 0 } }, "pageParam": { "in": "query", "name": "page", "description": "Текущая страница", "schema": { "type": "integer", "example": 1 } }, "limitParam": { "in": "query", "name": "limit", "description": "Лимит записей", "schema": { "type": "integer", "example": 20, "default": 20, "minimum": 1, "maximum": 100 } }, "WorkplaceId": { "name": "workplace_id", "in": "path", "description": "ID филиала", "required": true, "schema": { "$ref": "#/components/schemas/Workplace/properties/id" } }, "MetalId": { "name": "metal_id", "in": "path", "required": true, "description": "ID металла", "schema": { "$ref": "#/components/schemas/Metal/properties/metal_id" } }, "ObjectId": { "name": "object_id", "in": "query", "required": true, "description": "ID объекта", "schema": { "type": "integer", "example": 47 } }, "PawnGoodId": { "name": "pawn_good_id", "in": "path", "required": true, "description": "ID залогового имущества", "schema": { "$ref": "#/components/schemas/PawnGood/properties/id" } }, "OperationId": { "name": "operation_id", "in": "path", "required": true, "description": "ID операции (для поиска операции)", "schema": { "$ref": "#/components/schemas/Operation/properties/id" } }, "PawnTicketId": { "name": "pawn_ticket_id", "in": "path", "required": true, "description": "ID залогового билета (для поиска залогового билета)", "schema": { "$ref": "#/components/schemas/PawnTicket/properties/id" } }, "PageParam": { "name": "page", "in": "query", "description": "Начинать с записи", "schema": { "type": "integer", "example": 17 } }, "LimitParam": { "name": "limit", "in": "query", "description": "Лимит записей", "schema": { "type": "integer", "example": 80 } }, "TestOperation": { "name": "test_operation", "description": "Тестовая операция\n* 0 - Не тестовая операция\n* 1 - Тестовая операция\n", "in": "query", "schema": { "description": "Тестовая операция\n* 0 - Не тестовая операция\n* 1 - Тестовая операция\n", "type": "integer", "example": 1, "enum": [ 0, 1 ] } } }, "securitySchemes": { "bearerAuth": { "type": "http", "description": "Заголовок авторизации JWT с использованием Bearer.", "scheme": "bearer", "bearerFormat": "JWT" } }, "headers": { "PaginationPage": { "schema": { "type": "integer", "example": 2 }, "description": "Текущая страница пагинации" }, "PaginationOffset": { "schema": { "type": "integer", "example": 30 }, "description": "Текущая страница пагинации" }, "PaginationPageSize": { "schema": { "type": "integer", "example": 20 }, "description": "Количество записей на странице" }, "PaginationTotalRecords": { "schema": { "type": "integer", "example": 1700 }, "description": "Всего найдено записей" }, "PaginationTotalPages": { "schema": { "type": "integer", "example": 85 }, "description": "Всего страниц для пагинации" }, "PaginationPreviousPage": { "schema": { "type": "integer", "example": 1 }, "description": "Предыдущая страница для пагинации" }, "PaginationNextPage": { "schema": { "type": "integer", "example": 3 }, "description": "Следующая страница для пагинации" } }, "responses": { "ErrorListResponse": { "description": "Отрицательные ответы на запрос списка сущностей", "content": { "application/json": { "schema": { "type": "object", "description": "Объект отрицательного ответа на запрос массива сущностей", "properties": { "status": { "type": "boolean", "example": false, "description": "Статус ошибка ответа" }, "http_code": { "type": "integer", "example": 500, "description": "Код ошибки" }, "error": { "type": "object", "description": "Примеры отрицательныех ответов на запрос списка сущностей:\n* 204 - Данных по запросу не найдено\n* 401 - Недопустимый токен или время работы истекло\n* 403 - Пользователь уволен или забанен\n* 404 - Данный метод не найден или не поддерживается\n* 405 - Нет прав для просмотра данных\n* 406 - Превышен лимит запрашиваемых данных\n* 413 - Размер входных данных превышает максимально допустимый\n* 429 - Слишком много запросов за заданный промежуток времени (не более 15 за 10 секунд)\n* 500 - Неизвестная ошибка запроса\n* 503 - Сервер не может обработать запрос из-за временной перегрузки или технических работ\n* 504 - Сервер, не дождался ответа в рамках установленного таймаута\n", "properties": { "message": { "type": "string", "description": "Сообщение", "example": "Неизвестная ошибка запроса" } } } } } } } }, "ErrorGetResponse": { "description": "Отрицательный ответ на запрос списка сущностей", "content": { "application/json": { "schema": { "type": "object", "description": "Объект отрицательного ответа на запрос сущности", "properties": { "status": { "type": "boolean", "example": false, "description": "Статус отрицательного ответа" }, "http_code": { "type": "integer", "example": 500, "description": "Код ответа" }, "error": { "type": "object", "description": "Примеры отрицательных ответов на запрос списка сущностей:\n * 400 - Недопустимое значение ID\n * 401 - Недопустимый токен или время работы истекло\n * 403 - Пользователь уволен или забанен\n * 404 - Данный метод не найден или не поддерживается\n * 405 - Нет прав для просмотра данных\n * 429 - Слишком много запросов за заданный промежуток времени (не более 15 за 10 секунд)\n * 500 - Сервер не может обработать запрос из-за временной перегрузки или технических работ\n * 504 - Сервер, не дождался ответа в рамках установленного таймаута.'\n", "properties": { "message": { "type": "string", "description": "Сообщение", "example": "Неизвестная ошибка запроса" } } } } } } } }, "ErrorValidationFailed": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "description": "Указатель ответа" }, "http_code": { "type": "integer", "example": 412, "description": "Код ошибки валидации" }, "errors": { "type": "array", "description": "Массив объектов данных по ошибке", "items": { "type": "object", "description": "Объект данных по ошибке", "properties": { "field": { "type": "string", "example": "workplace_id", "description": "Поле выдавшее ошибку валидации" }, "message": { "type": "string", "example": "Некорректный ID филиала", "description": "Поле сообщение ошибки валидации" } } }, "example": [ { "field": "workplace_id", "message": "Некорректный ID филиала" }, { "field": "number", "message": "Неверный формат числа" }, { "field": "date", "message": "Некорректная дата" } ] } } } } } } }, "schemas": { "PawnTicket": { "type": "object", "description": "Объект с данными по залоговому билету", "properties": { "id": { "type": "integer", "example": 7832, "description": "ID залогового билета (сквозной ID)" }, "pawn_chain_id": { "type": "integer", "example": 7831, "description": "ID цепочки залогового билета (сквозной ID)" }, "document_number": { "type": "string", "example": "AA000064", "description": "Полный номер залогового билета" }, "tariff_id": { "type": "integer", "example": 589, "description": "ID тарифа (сквозной ID)" }, "loan_amount": { "type": "number", "example": 1600.4, "description": "Сумма займа" }, "currency_code": { "$ref": "#/components/schemas/CurrencyCode" }, "duration": { "type": "integer", "example": 7, "description": "Срок займа, дней" }, "paid_percents": { "type": "number", "example": 800.77, "description": "Сумма уплаченных процентов (как у нас в каталоге)" }, "accrued_percent": { "type": "number", "example": 810.77, "description": "Сумма начисленных процентов (как у нас в каталоге)" }, "open_date": { "type": "string", "example": "15.08.2022", "description": "Дата открытия залогового билета" }, "close_date": { "type": "string", "example": "15.08.2022", "description": "Фактическая дата закрытия. Возвращается только если ЗБ закрыт." }, "end_date": { "type": "string", "example": "15.08.2022", "description": "Срок окончания по ЗБ без учета продлений" }, "comment": { "type": "string", "example": "Коментарий", "description": "Комментарий" }, "status": { "type": "integer", "description": "Cостояния залогового билета:\n * 1 - На реализации\n * 2 - Открыт\n * 3 - Просрочен\n * 4 - Просрочен (готов к продаже)\n * 5 - Закрыт\n", "enum": [ 1, 2, 3, 4, 5 ], "example": 2 }, "workplace_id": { "$ref": "#/components/schemas/Workplace/properties/id" }, "client_natural_person_id": { "$ref": "#/components/schemas/NaturalPerson/properties/id" }, "client_legal_person_id": { "type": "integer", "example": null, "description": "ID клинета юр. лица" }, "entity_id": { "$ref": "#/components/schemas/Entity/properties/id" }, "test_operation": { "$ref": "#/components/parameters/TestOperation/schema" }, "pawn_ticket_debt": { "type": "object", "description": "Массив с данными по задолженности в залоговом билете", "properties": { "percents_to_pay": { "type": "number", "example": "7500.52", "description": "Задолженность по процентам" }, "commission_sum": { "type": "number", "example": "500.17", "description": "Комиссия банка" }, "sum_debt": { "type": "number", "example": "4500.95", "description": "Общая задолженность по залоговому билету" } } }, "online_prolongation_url": { "type": "string", "example": "https://online.smartlombard.ru/public/online_prolongation/?org_id=1&workplace_id=1&token=70d6acbb9844376f7c9e1299e2fb4ca1&number=АА000001", "description": "Cсылка на форму для онлайн-оплаты процентов" } } }, "PawnGood": { "type": "object", "description": "Объект с данными по имуществу", "properties": { "id": { "type": "integer", "example": 1895, "description": "ID имущества (сквозной ID)" }, "pawn_id": { "type": "integer", "example": 15, "description": "ID залогового билета" }, "article": { "type": "integer", "example": 895, "description": "Артикул имущества" }, "name": { "type": "string", "example": "Кольцо", "description": "Наименование имущества" }, "serial_number": { "type": "string", "example": "9063", "description": "Серийный номер (не для всех типов категорий)" }, "estimate_price": { "type": "number", "example": 1600.4, "description": "Сумма оценки" }, "currency_code": { "$ref": "#/components/schemas/CurrencyCode" }, "category_id": { "$ref": "#/components/schemas/Category/properties/id" }, "workplace_id": { "type": "integer", "example": 8, "description": "ID филиала, где находится имущество" }, "type": { "type": "string", "description": "Тип имущества. Варианты:\n * other - Обычное\n * jewelry - Ювелирное изделие\n * vehicle - Транспортное средство\n * mobile - Мобильный\n * tablet - Планшеты\n * tv_video - Телевизоры или игровые приставки\n * photo_equip - Фототехника\n * watch - Часы\n * tool - Инструменты\n * pc_component - Товары для компьютера\n * clothes - Одежда\n * kids_clothes - Для детей\n * home_appliance - Техника для дома\n * laptop_netbook - Ноутбуки и нетбуки\n", "enum": [ "other", "jewelry", "vehicle", "mobile", "tablet", "tv_video", "photo_equip", "watch", "tool", "clothes", "kids_clothes", "pc_component", "home_appliance", "laptop_netbook" ] }, "storage": { "type": "string", "example": "Склад", "description": "" }, "status": { "type": "integer", "description": "Состояние залогового имущества:\n * 1 - На реализации\n * 2 - Реализован\n * 3 - Заложен\n * 4 - Заложен (просрочен)\n * 5 - Выкуплен\n * 6 - Готов к продаже\n * 7 - Выведен из залога\n * 8 - Изъят\n", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "example": 2 }, "test_operation": { "$ref": "#/components/parameters/TestOperation/schema" }, "description": { "type": "string", "example": "Описание", "description": "Описание" }, "comment": { "type": "string", "example": "Коментарий", "description": "Коментарий" }, "images_links": { "$ref": "#/components/schemas/ImagesLinks" }, "jewelry_extra": { "type": "object", "description": "Объект с дополнительными полями для ювелирных изделий", "properties": { "manufacturer": { "type": "string", "example": "ООО \"Карат\"", "description": "Производитель" }, "uin": { "type": "string", "example": "6432012345678901", "description": "УИН (только для Ювелирных изделий)" }, "size": { "type": "number", "example": 2.7, "description": "Размер/длина (только для Ювелирных изделий)" }, "metal_name": { "type": "string", "example": "Золото", "description": "Наименование металла (только для Ювелирных изделий) " }, "metal_standart_name": { "type": "string", "example": "999", "description": "Наименование пробы (только для Ювелирных изделий)" }, "weight": { "type": "number", "example": 1.678, "description": "Вес, г (только для Ювелирных изделий)" }, "weight_inserts": { "type": "number", "example": 0.635, "description": "Вес вставок, г (только для Ювелирных изделий)" }, "product_type": { "type": "string", "example": "Изделие", "description": "Лом/Изделие (только для Ювелирных изделий)" }, "estimate_inserts": { "type": "number", "example": 635, "description": "Сумма оценки вставок (только для Ювелирных изделий)" }, "brand": { "type": "string", "example": "Casio", "description": "Модель часов" }, "color": { "type": "string", "example": "Красный", "description": "Цвет часов" }, "gender": { "type": "string", "example": "Мужские", "description": "Для кого" }, "strap_type": { "type": "string", "example": "Титан", "description": "Тип ремешка" }, "mechanism": { "type": "string", "example": "Кварцевые", "description": "Тип механизма" } } }, "vehicle_extra": { "type": "object", "description": "Объект дополнительных полей для Автотранспорта", "properties": { "model": { "type": "string", "example": "Volga", "description": "Марка, модель (только для Автотранспорта)" }, "product_year": { "type": "integer", "example": 1998, "description": "Год выпуска (только для Автотранспорта)" }, "body_color": { "type": "string", "example": "Белый", "description": "Цвет кузова (только для Автотранспорта)" }, "reg_number": { "type": "string", "example": "A163BT", "description": "Гос. номер (только для Автотранспорта)" }, "vin": { "type": "string", "example": "ATM09988734634Z5767", "description": "VIN (только для Автотранспорта)" }, "engine_description": { "type": "string", "example": "45996F23", "description": "Модель, № Двигателя (только для Автотранспорта)" }, "engine_volume": { "type": "string", "example": "67", "description": "Рабочий объем двигателя, куб. см. (только для Автотранспорта)" }, "chassis_number": { "type": "string", "example": "90853", "description": "Шасси (рама) № (только для Автотранспорта)" }, "trailer_number": { "type": "string", "example": "3457", "description": "Кузов (прицеп) № (только для Автотранспорта)" }, "pts_number": { "type": "string", "example": "ATM0569709W345", "description": "" }, "pts_issued_by": { "type": "string", "example": "ГИБДД Ставропольского района", "description": "Серия, номер ПТС (только для Автотранспорта)" }, "pts_issued_date": { "type": "string", "example": "10.08.2019", "description": "ПТС выдан (только для Автотранспорта)" }, "sts_number": { "type": "string", "example": "ATM0569709W345", "description": "Серия, номер СТС (только для Автотранспорта)" }, "sts_issued_by": { "type": "string", "example": "ГИБДД Ставропольского района", "description": "СТС Выдан (только для Автотранспорта)" }, "sts_issued_date": { "type": "string", "example": "10.08.2019", "description": "Дата выдачи СТС (только для Автотранспорта)" } } }, "phone_extra": { "type": "object", "description": "Объект дополнительных полей для мобильных телефонов", "properties": { "brand": { "type": "string", "example": "Apple", "description": "Модель телефона" }, "model": { "type": "string", "example": "Iphone 15", "description": "Модель телефона" }, "memory_size": { "type": "string", "example": "128 Gb", "description": "Встроенная память (размер встроенного хранилища)" }, "color": { "type": "string", "example": "Красный", "description": "Цвет телефона" }, "ram_size": { "type": "string", "example": "128 Gb", "description": "Оперативная память" } } }, "tablet_extra": { "type": "object", "description": "Объект дополнительных полей для планшетов", "properties": { "brand": { "type": "string", "example": "Haier", "description": "Бренд планшета" }, "model": { "type": "string", "example": "G800", "description": "Модель планшета" }, "sim_slot": { "type": "string", "example": "Есть", "description": "Слот для сим карты" }, "memory_size": { "type": "string", "example": "128 Gb", "description": "Встроенная память (размер встроенного хранилища)" }, "color": { "type": "string", "example": "Красный", "description": "Цвет планшета" }, "ram_size": { "type": "string", "example": "128 Gb", "description": "Оперативная память" } } }, "tv_extra": { "type": "object", "description": "Объект дополнительных полей для ТВ и видеотехники", "properties": { "brand": { "type": "string", "example": "Haier", "description": "Бренд телевизора" }, "model": { "type": "string", "example": "HT3728", "description": "Модель телевизора" }, "device_work": { "type": "integer", "example": 1, "description": "Включается ли устройство\n * 1 - Включается\n * 2 - Не включается\n" }, "screen_flaws_id": { "type": "array", "description": "Только для телевизоров. Состояния экрана\n * 1 - Без дефектов\n * 2 - Мелкие царапины\n * 3 - Крупные царапины\n * 4 - Засветы\n * 5 - Белые пятна\n * 6 - Выгоревшие области\n * 7 - Битые пиксели\n * 8 - Вертикальные полосы\n * 9 - Трещины, сколы\n * 10 - Искажение цвета\n * 11 - Не работает\n * 12 - Разбит\n", "items": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] } }, "case_flaws_id": { "type": "array", "description": "Только для телевизоров. Состояния корпуса\n * 1 - Без дефектов\n * 2 - Царапины\n * 3 - Загрязнения\n * 4 - Трещины\n * 5 - Нет частей корпуса\n * 6 - Вмятины или сколы\n", "items": { "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6 ] } } } }, "photo_equip_extra": { "type": "object", "description": "Объект дополнительных полей для Фототехники", "properties": { "device_work": { "type": "integer", "example": 1, "description": "Включается ли устройство :\n* 1 - Включается\n* 2 - Не включается\n" }, "screen_flaws_id": { "type": "array", "example": [ 1, 2, 3 ], "items": { "type": "integer" }, "description": "Состояние экрана :\n* 1 - Без дефектов\n* 2 - Мелкие царапины\n* 3 - Крупные царапины\n* 4 - Трещины, сколы\n* 5 - Дефекты изображения\n* 6 - Разбит\n* 7 - Не работает\n" }, "case_flaws_id": { "type": "array", "example": [ 3, 2, 1 ], "items": { "type": "integer" }, "description": "Состояние корпуса :\n* 1 - Без дефектов\n* 2 - Царапины\n* 3 - Трещины\n* 4 - Вмятины, сколы\n* 5 - Нет частей корпуса\n* 6 - Загрязнения\n" } } }, "pc_extra": { "type": "object", "description": "Объект дополнительных полей для Товары для компьютера", "properties": { "brand": { "type": "string", "example": "Haier", "description": "Бренд монитора" }, "model": { "type": "string", "example": "HT3728", "description": "Модель монитора" } } }, "watch_extra": { "type": "object", "description": "Объект дополнительных полей для Часы", "properties": { "brand": { "type": "string", "example": "Casio", "description": "Бренд часов" }, "gender": { "type": "string", "example": "Мужские", "description": "Для кого" }, "color": { "type": "string", "example": "Чёрный", "description": "Цвет часов" }, "strap_type": { "type": "string", "example": "Титан", "description": "Тип ремешка" }, "mechanism": { "type": "string", "example": "Кварцевые", "description": "Тип механизма" }, "device_work": { "type": "integer", "example": 1, "description": "Включается ли устройство :\n* 1 - Включается\n* 2 - Не включается\n" }, "akb": { "type": "integer", "example": 100, "description": "Cостояние аккумулятора, %" }, "screen_flaws_id": { "type": "array", "example": [ 1, 2, 3 ], "items": { "type": "integer" }, "description": "Включается ли устройство :\n* 1 - Без дефектов\n* 2 - 1-2 мелкие царапины\n* 3 - Много мелких царапин\n* 4 - Глубокие царапины\n* 5 - Сколы, трещины\n* 6 - Полосы и битые пиксели\n* 7 - Пятна, блики или выгорание\n* 8 - Не работает\n" }, "case_flaws_id": { "type": "array", "example": [ 3, 2, 1 ], "items": { "type": "integer" }, "description": "Включается ли устройство :\n* 1 - Без дефектов\n* 2 - Царапины\n* 3 - Трещины\n* 4 - Вмятины, сколы\n* 5 - Нет частей корпуса\n* 6 - Загрязнения\n" } } }, "clothes_extra": { "type": "object", "description": "Объект дополнительных полей для Одежды", "properties": { "brand": { "type": "string", "example": "Lacoste", "description": "Бренд одежды" }, "clothes_size": { "type": "string", "example": "XXL", "description": "Размер одежды" }, "shoes_type_id": { "type": "integer", "example": "1", "description": "Тип обуви" } } }, "kids_clothes_extra": { "type": "object", "description": "Объект дополнительных полей для Для детей", "properties": { "brand": { "type": "string", "example": "Lacoste", "description": "Бренд одежды" }, "clothes_size": { "type": "string", "example": "XXL", "description": "Размер одежды" } } }, "home_appliance_extra": { "type": "object", "description": "Объект дополнительных полей для Техника для дома", "properties": { "brand": { "type": "string", "example": "Bosch", "description": "Бренд техники" }, "model": { "type": "string", "example": "WAWH8640", "description": "Модель бренда техники" }, "device_work": { "type": "integer", "example": 1, "description": "Включается ли устройство :\n* 1 - Включается\n* 2 - Не включается\n" }, "useful_life": { "type": "integer", "example": 2, "description": "Срок использования :\n* 1 - До 3 лет\n* 2 - 3-5 лет\n* 3 - Больше 5 лет\n" }, "warranty": { "type": "integer", "example": 2, "description": "Гарантия :\n* 1 - Действует\n* 2 - Истекла\n* 3 - Не знаю\n" }, "case_flaws_id": { "type": "array", "example": [ 3, 2, 1 ], "items": { "type": "integer" }, "description": "Состояние корпуса :\n* 1 - Без дефектов\n* 2 - Царапины\n* 3 - Трещины\n* 4 - Вмятины, сколы\n* 5 - Нет частей корпуса\n* 6 - Загрязнения\n" } } }, "tool_extra": { "type": "object", "description": "Объект дополнительных полей для Инструментов", "properties": { "device_type": { "type": "string", "example": "Шуруповерт", "description": "Тип инструмента" }, "brand": { "type": "string", "example": "Makita", "description": "Бренд инструмента" }, "device_model": { "type": "string", "example": "Не указана", "description": "Модель инструмента" }, "tool_type_id": { "type": "integer", "example": 1, "description": "ID типа инструмента" }, "disc_diameter": { "type": "string", "example": "125", "description": "Диаметр диска" }, "cartridge_type_id": { "type": "integer", "example": 2, "description": "ID типа патрона" }, "modes": { "type": "integer", "example": 2, "description": "Количество режимов" }, "power_type_id": { "type": "integer", "example": 2, "description": "ID типа питания" }, "power_type": { "type": "string", "example": "Аккумуляторный", "description": "Тип питания" }, "battery_voltage": { "type": "string", "example": "18.0", "description": "Напряжение" }, "grinding_tool_type_id": { "type": "integer", "example": 3, "description": "ID типа шлифмашинки" } } }, "laptop_netbook_extra": { "type": "object", "description": "Тип имущества - Ноутбуки и нетбуки", "properties": { "device_work": { "type": "integer", "example": "1", "description": "Включается ли устройство" }, "akb_hours": { "type": "integer", "example": "1", "description": "Время работы от аккумулятора" }, "keyboard_layout": { "type": "integer", "example": "1", "description": "Раскладка клавиатуры" }, "screen_condition_id": { "type": "integer", "example": "1", "description": "ID состояния экрана" }, "case_condition_id": { "type": "integer", "example": "1", "description": "ID состояния корпуса" }, "keyboad_condition_id": { "type": "integer", "example": "1", "description": "ID состояния клавиатуры" } } } } }, "Operation": { "type": "object", "description": "Объект с данными по операции", "properties": { "id": { "type": "integer", "example": 595, "description": "ID операции, если составная то ID открывающей ЗБ (сквозной ID)" }, "elementary_operations": { "description": "Объекты элементарных операций", "type": "object", "properties": { "opening_operation": { "type": "object", "description": "Объект элементарной операции открытия", "properties": { "id": { "type": "integer", "example": 595, "description": "ID операции, открывающей ЗБ (сквозной ID)" }, "pawn_tiket_id": { "type": "integer", "example": 789, "description": "ID залогового билета, открываемого, если операция составная (сквозной ID)" }, "entity_id": { "type": "integer", "example": 10, "description": " ID юр. лица, открывающего залоговый билет, если операция составная (сквозной ID)" }, "type_operation": { "type": "string", "example": "part_buyout,dobor", "description": "Варианты:\n * pledge (Залог)\n * prolongation (Продление)\n * prolongation_online (Онлайн-продление)\n * repledge (Перезалог)\n * dobor (Добор)\n * part_buyout (Частичный выкуп)\n * part_buyout_pawn_good (Частичный выкуп имущества)\n * sale_pledge (Вывод из залога)\n * buyout (Выкуп залогового билета)\n * withdraw (Изъятие имущества)\n * send_realization (Отправка на реализацию)\n * sell_realization (Реализация)\n * withdraw (Изъятие)\n" }, "payment_method": { "type": "string", "example": "cash", "description": "Способ расчета, если операция составная, то открывающей операции). Варианты:\n * cash (Касса)\n * bank_transfer (Безналичный расчет)\n" }, "bank_account": { "$ref": "#/components/schemas/BankDetail/properties/bank_account" } } }, "closing_operation": { "type": "object", "description": "Элементарная операция закрытия", "properties": { "id": { "type": "integer", "example": 594, "description": "ID операции, если составная то ID закрывающей ЗБ (сквозной ID)" }, "pawn_tiket_id": { "type": "integer", "example": 788, "description": "ID залогового билета, закрываемого, если операция составная (сквозной ID)" }, "entity_id": { "type": "integer", "example": 9, "description": "ID юр. лица, закрывающего залоговый билет, если операция составная (сквозной ID)" }, "type_operation": { "type": "string", "example": "buyout", "description": "Тип операции" }, "payment_method": { "type": "string", "example": "cash", "description": "Способ расчета" }, "bank_account": { "$ref": "#/components/schemas/BankDetail/properties/bank_account" }, "percent": { "type": "integer", "example": 50, "description": "Процеты" }, "paid_dept_sum": { "type": "string", "example": "1050", "description": "Сумма долга" } } } } }, "pawn_chain_id": { "type": "integer", "example": 8832, "description": "ID цепочки операций ЗБ (сквозной ID первого ЗБ, в цепочке операций)" }, "UTC": { "type": "string", "example": "+04:00", "description": "Часовой пояс" }, "date": { "type": "string", "example": "18.09.2022", "description": "Дата операции" }, "sum": { "type": "number", "example": 1706.36, "description": "Сумма" }, "workplace_id": { "$ref": "#/components/schemas/Workplace/properties/id" }, "account_id": { "$ref": "#/components/schemas/Account/properties/id" }, "client_natural_person_id": { "$ref": "#/components/schemas/NaturalPerson/properties/id" }, "client_legal_person_id": { "$ref": "#/components/schemas/LegalPerson/properties/id" }, "ad_channel_id": { "description": "Рекламный канал", "type": "integer", "example": 10 }, "test_operation": { "$ref": "#/components/schemas/ElementaryOperation/properties/test_operation" } } }, "ElementaryOperation": { "type": "object", "description": "Объект с данными по элементарной операции", "properties": { "id": { "type": "integer", "example": 596, "description": "ID элементарной операции (сквозной ID)" }, "pawn_ticket_id": { "type": "integer", "example": 7832, "description": "ID залогового билета к которой привязана Элементарная операция. (сквозной ID)" }, "pawn_chain_id": { "type": "integer", "example": 7832, "description": "ID цепочки операций ЗБ (ID первого ЗБ, в цепочке операций) (сквозной ID)" }, "type_operation": { "type": "string", "description": "Тип операций. Варианты:\n * pledge (залог)\n * prolongation (продление)\n * prolongation_online (онлайн-продление)\n * sale_pledge (вывод из залога)\n * buyout (выкуп)\n * send_realization (отправка на реализацию)\n * sell_realization (реализация)\n * withdraw (изъятие)\n", "enum": [ "pledge", "prolongation", "prolongation_online", "sale_pledge", "buyout", "send_realization", "sell_realization", "withdraw" ], "example": "pledge,prolongation" }, "type_sub_operation": { "type": "string", "description": "Тип операций. Варианты:\n * repledge - перезалог\n * dobor - добор\n * sale_pledge - Вывод из залога\n * part_buyout - частичный выкуп\n * part_buyout_pawn_good - частичный выкуп имущества\n", "enum": [ "repledge", "dobor", "sale_pledge", "part_buyout", "part_buyout_pawn_good" ], "example": "repledge" }, "payment_method": { "type": "string", "description": "Тип операций. Варианты:\n * cash - Касса\n * bank_transfer - Безналичный расчет\n", "enum": [ "cash", "bank_transfer" ], "example": "cash" }, "bank_account": { "$ref": "#/components/schemas/BankDetail/properties/bank_account" }, "date": { "type": "string", "example": "18.09.2022", "description": "Дата операции" }, "UTC": { "type": "string", "example": "+04:00", "description": "Часовой пояс" }, "sum": { "type": "number", "example": 1706.36, "description": "Сумма" }, "workplace_id": { "$ref": "#/components/schemas/Workplace/properties/id" }, "account_id": { "$ref": "#/components/schemas/Account/properties/id" }, "entity_id": { "$ref": "#/components/schemas/Entity/properties/id" }, "client_natural_person_id": { "$ref": "#/components/schemas/NaturalPerson/properties/id" }, "client_legal_person_id": { "type": "number", "example": null, "description": "ID клинета юр. лица" }, "percent": { "type": "number", "example": 450.56, "description": "Процеты" }, "paid_debt_sum": { "type": "number", "example": 150.9, "description": "Основной долг" }, "loss": { "type": "number", "example": 150.9, "description": "Убыток" }, "overprofit": { "type": "number", "example": 120.08, "description": "Получено сверх обязательств" }, "ad_channel_id": { "description": "Рекламный канал", "type": "integer", "example": 10 }, "test_operation": { "description": "Тестовая операция\n* 0 - Не тестовая операция\n* 1 - Тестовая операция\n", "type": "integer", "example": 1, "enum": [ 1, 2 ] } } }, "NaturalPerson": { "type": "object", "description": "Объект клиент физ. лицo", "properties": { "id": { "type": "integer", "example": 90, "description": "ID клиента физ. лица" }, "last_name": { "type": "string", "example": "Иванов", "description": "Фамилия клиента" }, "name": { "type": "string", "example": "Иван", "description": "Имя клиента" }, "patronymic": { "type": "string", "example": "Иванович", "description": "Отчество клиента" }, "birth_date": { "type": "string", "example": "01.12.1980", "description": "Дата рождения клиента" }, "address": { "type": "string", "example": "г. Москва, ул. Победы, д. 10, кв. 25", "description": "Адрес регистрации" }, "actual_address": { "type": "string", "example": "г. Москва, ул. Победы, д. 10, кв. 25", "description": "Фактический адрес проживания" }, "place_of_birth": { "type": "string", "example": "Москва", "description": "Место рождения" }, "phone": { "type": "string", "example": "+79033080944", "description": "Номер телефона в международном формате" }, "email": { "type": "string", "example": "email@email.ru", "description": "Электронная почта" }, "photo_link": { "$ref": "#/components/schemas/ImagesLinks" }, "nationality": { "type": "integer", "example": 643, "description": "Гражданство. Числовой код страны в справочнике ОКСМ" }, "resident": { "type": "integer", "example": 1, "description": "Является резидентом РФ:\n* 1 - Да\n* 2 - Нет\n", "enum": [ 1, 2 ] }, "inn": { "type": "string", "example": "7743013902", "description": "ИНН или ИИН (для РК)" }, "snils": { "type": "string", "example": "222-233-445 85", "description": "СНИЛС" }, "additional_info": { "type": "string", "example": "Текст информации", "description": "Дополнительная информация" }, "warning_message": { "type": "string", "example": "Носит краденное", "description": "Предупреждение" }, "loyalty_card_number": { "type": "string", "example": "8563", "description": "Номер карты постоянного клиента" }, "loyalty_card_discount": { "type": "object", "description": "Скидки по картам лояльности", "properties": { "discount_lombard": { "type": "integer", "example": "11", "description": "Процент скидки на проценты ломбарда" }, "discount_sell": { "type": "integer", "example": "10", "description": "Процент скидки при покупке товаров" }, "discount_sell_realization": { "type": "integer", "example": "12", "description": "Процент скидки при покупке товаров, принятых на реализацию" } } }, "bonuses": { "type": "integer", "example": 122, "description": "Количество бонусов" }, "ad_channel_id": { "description": "Рекламный канал", "type": "integer", "example": 10 }, "date_added": { "description": "Дата добавления", "type": "string", "example": "20.09.2024" } } }, "LegalPerson": { "type": "object", "description": "Объект с данными юридического лица", "properties": { "id": { "type": "integer", "example": 78, "description": "ID клинета юр. лица" }, "name": { "type": "string", "example": "Ломбард", "description": "Название юр. лица" }, "legal_address": { "type": "string", "example": "г. Москва, ул. Спортивная 5", "description": "Юридический адрес юр. лица" }, "phone": { "type": "string", "example": "+79033080944", "description": "Общий телефон организации" }, "director_fio": { "type": "string", "example": "Иванов Иван Иванович", "description": "ФИО директора" }, "chief_accountant_fio": { "type": "string", "example": "Петров Перт Петрович", "description": "ФИО главного бухгалтера" }, "inn": { "type": "string", "example": "7743013902", "description": "ИНН" }, "kpp": { "type": "string", "example": "123456789", "description": "КПП" }, "ogrn": { "type": "string", "example": "1234567890123", "description": "ОГРН" }, "okpo": { "type": "string", "example": "12345678", "description": "ОКПО" }, "oktmo": { "type": "string", "example": "12345678", "description": "ОКТМО" }, "ad_channel_id": { "description": "Рекламный канал", "type": "integer", "example": 10 }, "date_added": { "description": "Дата добавления", "type": "string", "example": "20.09.2024" } } }, "Entity": { "type": "object", "description": "Объект реквизитов юр. лица", "properties": { "id": { "type": "integer", "example": 5, "description": "ID юр. лица" }, "legal_form": { "type": "string", "example": "ООО", "description": "правовая форма" }, "name": { "type": "string", "example": "Карат", "description": "Название юр. лица" }, "inn": { "type": "string", "example": "123456789", "description": "ИНН" }, "legal_address": { "type": "string", "example": "Пример: г. Москва, ул. Центральная, д. 7", "description": "Юридический адрес юр. лица" }, "phone": { "type": "string", "example": "+79033080944", "description": "Общий телефон организации" }, "director_fio": { "type": "string", "example": "Иванов Иван Иванович", "description": "ФИО директора" }, "chief_accountant_fio": { "type": "string", "example": "Иванов Иван Иванович", "description": "ФИО главного бухгалтера" }, "taxation_system": { "type": "integer", "description": "Система налогообложения:\n * 1 - ОСНО\n * 2 - УСН (Доходы)\n * 3 - УСН (Доходы минус расходы)\n * 4 - ПСН\n", "enum": [ 1, 2, 3, 4 ], "example": 2 }, "kpp": { "type": "string", "example": "775001001", "description": "КПП" }, "ogrn": { "type": "string", "example": "306501133200012", "description": "ОГРН" }, "okpo": { "type": "string", "example": "50886585", "description": "ОКПО" }, "oktmo": { "type": "string", "example": "4537000", "description": "ОКТМО" }, "number_in_lombard_register": { "type": "string", "example": "1234", "description": "Номер в реестре ломбардов" }, "property_insurance_sum": { "type": "string", "example": "12000000", "description": "Сумма страховки имущества" }, "bank_details": { "type": "array", "description": "Банковские реквизиты", "items": { "$ref": "#/components/schemas/BankDetail" } } } }, "Workplace": { "type": "object", "description": "Объект данных филиала", "properties": { "id": { "type": "integer", "example": 890, "description": "ID филиала" }, "title": { "type": "string", "example": "Ломбард", "description": "Название филиала" }, "city": { "type": "string", "example": "Москва", "description": "Город" }, "address": { "type": "string", "example": "г. Москва, ул. Горького, д 25", "description": "Адрес филиала" }, "okato": { "type": "string", "example": "232343234", "description": "ОКАТО филиала" }, "phone": { "type": "string", "example": "+79033080944", "description": "Телефон филиала" }, "state": { "type": "integer", "description": "Видимость филиала. Варианты:\n * 1 - Только активные филиалы\n * 2 - Только скрытые филиалы\n", "enum": [ 1, 2 ], "example": 1 }, "image_links": { "$ref": "#/components/schemas/ImagesLinks" } } }, "Document": { "type": "object", "description": "Объект данных документа клиента", "properties": { "id": { "type": "integer", "example": 569, "description": "ID документа" }, "type": { "type": "string", "example": "Паспорт", "description": "Тип документа" }, "series_number": { "type": "string", "example": "0598 898652", "description": "Серия номер" }, "issued_by": { "type": "string", "example": "УФМС г. Москва", "description": "Место выдачи" }, "issued_date": { "type": "string", "example": "02.02.2022", "description": "Дата выдачи" }, "code_department": { "type": "string", "example": "670-110", "description": "Код документа" }, "note": { "type": "string", "example": "Описание примечания", "description": "Примечание" } } }, "Tariff": { "type": "object", "description": "Объект данных тарифа", "properties": { "id": { "type": "integer", "example": 589, "description": "ID тарифа" }, "name": { "type": "string", "example": "Основной", "description": "Название тарифа" }, "comment": { "type": "string", "example": "Описание", "description": "Коментарий" }, "payment_min_sum": { "type": "number", "example": 800.2, "description": "Минимальная сумма оплаты" }, "free_days": { "type": "integer", "example": 3, "description": "Количество первых бесплатных дней" }, "loyalty_card_allowed": { "type": "boolean", "example": true, "description": "Действует ли карта постоянного клиента" }, "workplaces_id": { "type": "array", "description": "Массиив из ID филиалов", "items": { "$ref": "#/components/schemas/Workplace/properties/id" } }, "status": { "type": "integer", "description": "Статус тарифа. Варианты:\n * 1 - Активен\n * 2 - Скрыт\n * 3 - Удалён\n", "enum": [ 1, 2, 3 ], "example": 1 }, "option_round_sum_pay": { "type": "string", "description": "'Округление итоговой суммы оплаты. Варианты:\n * Без округления\n * Округлять до 1 знака после запятой\n * Округлять до целого значения\n * Округлять до значения кратного 10 (в большую сторону)'\n", "example": "Округлять до 1 знака после запятой" }, "alert_exceeding_psk": { "type": "boolean", "description": "Предупреждать о превышении ПСК", "example": true }, "duration_mode": { "type": "string", "description": "Тип срока займа. Варианты:\n * Произвольное\n * Выбор из списка\n", "example": "Выбор из списка" }, "pawn_period": { "type": "array", "description": "Cрок займа (дней)", "items": { "type": "object", "properties": { "list": { "type": "integer", "description": "Список периодов срока займа", "example": 4, "enum": [ 2, 4, 8 ] }, "max": { "type": "integer", "description": "Максимальный срок займа, дней", "example": 4 } } } }, "max_pawn_sum": { "type": "string", "description": "Максимальная сумма займа", "example": "9999.99" }, "round_duration": { "type": "array", "description": "Округление срока залога", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "Вариант округления:\n * Без округления\n * До срока займа\n * Своё значение\n", "example": "Своё значение" }, "value": { "type": "integer", "description": "Своё значение округления", "example": "4" } } } }, "min_duration_days": { "type": "integer", "description": "Минимальное количество дней залога", "example": "5" }, "calculation_days": { "type": "integer", "description": "Расчет количества дней. Варианты:\n* Обычный расчет\n* Прибавлять дополнительный день\n", "example": "Прибавлять дополнительный день" }, "period_calculation": { "type": "array", "description": "Процентные ставки", "items": { "type": "object", "properties": { "duration_pledge": { "type": "string", "description": "Процент в зависимости от срока залога", "example": "от 3 до 4 дней" }, "sum_pledge": { "type": "string", "description": "Процент в зависимости от суммы залога", "example": "от 1000 до 6000 руб." }, "value": { "type": "string", "description": "Значение", "example": "26.12345" } } } }, "grace_period_type": { "type": "string", "description": "Единицы измерения льготного периода. Варианты:\n * Календарный месяц\n * По дням\n", "example": "По дням" }, "grace_period_value": { "type": "integer", "description": "Срок просрочки (льготного периода)", "example": "6" }, "grace_period_calculation": { "type": "integer", "description": "Тип расчета льготного периода\n * Фиксированный\n * Дифференцированный\n", "example": "Фиксированный" }, "grace_period_percents": { "type": "array", "description": "Процентные ставки льготного периода по займу", "items": { "type": "object", "properties": { "duration_pledge": { "type": "string", "description": "Процент в зависимости от срока залога", "example": "от 3 до 4 дней" }, "sum_pledge": { "type": "string", "description": "Процент в зависимости от суммы залога", "example": "от 1000 до 6000 руб." }, "value": { "type": "string", "description": "Значение", "example": "26.12345" } } } }, "storage_fee": { "type": "string", "description": "Сумма оплаты хранения", "example": "1100.00" }, "estimate_cost": { "type": "string", "description": "Сумма оплаты оценки", "example": "1200.00" }, "tariff_percents": { "type": "string", "description": "Процентная ставка по займу", "example": "5%" }, "specific_services": { "type": "string", "description": "На прочие услуги", "example": "0.4%" } } }, "BankDetail": { "type": "object", "description": "Объект данных банковских реквизитов", "properties": { "bank_account": { "type": "string", "example": "7895/985", "description": "Расчетный счет" }, "bank_name": { "type": "string", "example": "Сбербанк", "description": "Банк" }, "correspondent_account": { "type": "string", "example": "1234567", "description": "к/с" }, "bik": { "type": "string", "example": "123456789", "description": "БИК" } } }, "Category": { "type": "object", "description": "Объект данных родительской категории", "properties": { "id": { "type": "integer", "example": 15, "description": "ID категории" }, "name": { "type": "string", "example": "Ювелирные изделия", "description": "Наименование категории" }, "system_category": { "type": "integer", "description": "\"Системная ли категория. Варианты:\n* 0 - Пользовательская\n* 1 - Системная\"\n", "enum": [ 0, 1 ], "example": 1 } } }, "Subcategory": { "type": "object", "description": "Объект данных дочерней категории", "properties": { "id": { "type": "integer", "example": 45, "description": "ID подкатегории" }, "name": { "type": "string", "example": "Кольца", "description": "Наименование подкатегории" }, "system_category": { "type": "integer", "enum": [ 0, 1 ], "example": 0, "description": "Системная ли подкатегория. Варианты:\n* 0 - Пользовательская\n* 1 - Системная\n" } } }, "JuniorSubcategory": { "type": "object", "description": "Объект данных младшей категории", "properties": { "id": { "type": "integer", "example": 78, "description": "ID младшей подкатегории" }, "name": { "type": "string", "example": "Кольца", "description": "Наименование младшей подкатегории" }, "system_category": { "type": "integer", "enum": [ 0, 1 ], "example": 0, "description": "Системная ли подкатегория. Варианты:\n* 0 - Пользовательская\n* 1 - Системная\n" } } }, "Account": { "type": "object", "description": "Объект данных сотрудника", "properties": { "id": { "type": "integer", "example": 7963, "description": "ID аккаунта" }, "login": { "type": "string", "example": "example@gmail.com", "description": "Логин" }, "full_name": { "type": "string", "example": "Иванов Иван Иванович", "description": "ФИО" }, "phone": { "type": "string", "example": "+79033080944", "description": "Телефон" }, "inn": { "type": "string", "example": "165123546763", "description": "ИНН" }, "role": { "type": "string", "example": "Администратор", "description": "Роль" }, "comment": { "type": "string", "example": "Текст комментария", "description": "Комментарий" }, "status": { "type": "integer", "description": "Статус:\n * 1 - Действующий\n * 2 - Уволен\n * 3 - Забанен\n", "enum": [ 1, 2, 3 ], "example": 1 } } }, "ImagesLinks": { "type": "object", "description": "Ссылки на изображения", "properties": { "full_size": { "type": "string", "example": "https://online.smartlombard.ru/img/image1_full_size.jpg", "description": "Ссылка на полное изображения" }, "preview": { "type": "string", "example": "https://online.smartlombard.ru/img/image1_preview.jpg", "description": "Ссылка на превъю" } } }, "CurrencyCode": { "type": "string", "enum": [ "RUB", "UAH", "KZT", "GEL", "MDL", "LVL", "TMM", "KGS", "TJS", "LTL", "EUR", "USD", "AMD" ], "example": "RUB", "description": "Текстовый код валюты по ISO 4217" }, "Metadata": { "type": "object", "description": "Объект метаданных", "properties": { "links": { "type": "object", "description": "Объект данных ссылок по пагинации", "properties": { "self": { "type": "string", "example": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods?page=3&limit=20", "description": "Текущая страница" }, "first": { "type": "string", "example": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods?page=1&limit=20", "description": "Первая страница" }, "previous": { "type": "string", "example": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods?page=2&limit=20", "description": "Предыдущая страница" }, "next": { "type": "string", "example": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods?page=4&limit=20", "description": "Следующая страница" }, "last": { "type": "string", "example": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods?page=5&limit=20", "description": "Последняя страница" } } }, "pagination": { "type": "object", "description": "Объект данных по пагинации", "properties": { "page": { "type": "integer", "example": 3, "description": "Текущая страница" }, "count_records": { "type": "integer", "example": 100, "description": "Количество записей на странице" }, "count_pages": { "type": "integer", "example": 5, "description": "Количество страниц" }, "previous_page": { "type": "integer", "example": 2, "description": "Предыдущая страница" }, "next_page": { "type": "integer", "example": 4, "description": "Следующая страница" }, "page_size": { "type": "integer", "example": 20, "description": "Количество записей на странице" } } } } }, "AnswerGem": { "type": "object", "description": "Драгоценный камень", "properties": { "gem_type_id": { "type": "integer", "example": 1, "description": "Тип вставки. Варианты:\n* 1. Драгоценные камни;\n* 2. Полудрагоценные камни;\n* 3. Недрагоценные вставки.\n" }, "amount": { "type": "integer", "example": 1, "description": "Количество камней" }, "weight": { "type": "number", "example": 2.4, "description": "Вес" }, "type_title": { "type": "string", "example": "Бриллиант", "description": "Наименование типа" }, "cut_type_title": { "type": "string", "example": "Бп-25", "description": "Наименование вида огранки" }, "color_group_title": { "type": "string", "example": "Сине-зеленый", "description": "Наименование группы цвета" }, "purity_group_title": { "type": "string", "example": "К1", "description": "Наименование группы чистоты" }, "measure_unit_title": { "type": "string", "example": "Карат", "description": "Наименование единици измерения" }, "gem_estimate_price": { "type": "string", "example": "5000.00", "description": "Сумма оценки вставки" } } }, "StoragePlaces": { "description": "Место хранения", "type": "object", "properties": { "id": { "type": "integer", "example": 12, "description": "ID места хранения" }, "name": { "type": "string", "example": "Склад", "description": "Наименование места хранения" } } }, "BankCard": { "type": "object", "description": "Банковская карта клиента физ. лица", "properties": { "id": { "type": "integer", "example": 801, "description": "ID банковской карты клиента" }, "number": { "type": "string", "example": "1111 2222 3333 4444", "description": "Номер банковской карты клиента" }, "date_end": { "type": "string", "example": "10.2023", "description": "Дата банковской карты клиента" }, "bank_name": { "type": "string", "example": "ПАО Сбербанк", "description": "Наменование банка" } } }, "Metal": { "type": "object", "description": "Драгоценный металл", "properties": { "metal_id": { "description": "ID драгоценного металла", "type": "integer", "example": 85 }, "metal_name": { "description": "Наименование драгоценного металла", "type": "string", "example": "Золото" } } }, "MetalStandart": { "type": "object", "description": "Проба", "properties": { "metal_standart_id": { "description": "ID пробы", "type": "integer", "example": 74 }, "metal_standart_code": { "description": "Код пробы", "type": "string", "example": "999" }, "metal_standart_name": { "description": "Наименование пробы", "type": "string", "example": "999b (Советская)" } } }, "BonusesHistory": { "type": "object", "description": "Начисление", "properties": { "data_time_operation": { "description": "Дата и время операций", "type": "string", "example": "14.11.2024 12:06" }, "type_operation": { "description": "Тип операции. Варианты:\n * prolongation (Продление);\n * prolongation_online (Онлайн-продление);\n * sale_pledge (Вывод из залога);\n * buyout (Выкуп залогового билета);\n * withdraw (Изъятие имущества);\n * repledge (Типы операций залога);\n * dobor (Добор);\n * part_buyout (Частичный выкуп);\n * buying_up (Скупка);\n * sale (Продажа);\n * sale_realization (Продажа - реализация);\n * refund (Возврат);\n * refund_realization (Возврат - реализация);\n * payment_for_repair (Оплата ремонта клиентом);\n", "type": "string", "example": "repledge" }, "percent_add": { "description": "Процент начислений", "type": "string", "example": "15.90" }, "bonus_addition": { "description": "Начисления", "type": "integer", "example": 215 }, "bonus_remove": { "description": "Списания", "type": "integer", "example": 163 }, "accrued": { "description": "Начислены ли бонусы\n * 1 - Да\n * 0 - Нет\n", "type": "integer", "example": 1 } } }, "AdChannels": { "type": "object", "description": "Рекламные каналы", "properties": { "ad_channel_id": { "description": "ID рекламного канала", "type": "integer", "example": 6 }, "ad_channel_title": { "description": "Наименование рекламного канала", "type": "string", "example": "Реклама в лифте" } } }, "DocumentTypes": { "type": "object", "description": "Типы документов", "properties": { "id": { "description": "ID типа документов", "type": "integer", "example": 6 }, "name": { "description": "Наименование типа документов", "type": "string", "example": "Удостоверение" }, "state": { "description": "Видимость типа. Варианты:\n * 0 - активная\n * 1 - скрытая\n", "type": "integer", "example": 0 }, "system_document_type": { "description": "Системность типа документов. Варианты:\n * 0 - пользовательская\n * 1 - системная\n", "type": "integer", "example": 1 } } } } } }